InventoryClient\DefaultApi

All URIs are relative to https://www.orkiv.com/i/api

Method	HTTP request	Description
allGet	GET /all/
categoriesDelete	DELETE /categories/
categoriesPost	POST /categories/
categoriesPut	PUT /categories/
itemAddPost	POST /item/add/
itemAddbulkPost	POST /item/addbulk/
itemDelete	DELETE /item/
itemGet	GET /item/
itemMediaDelete	DELETE /item-media/
itemMediaPost	POST /item-media/
itemPut	PUT /item/
itemsCountPost	POST /items/count/
itemsPost	POST /items/
ordersPost	POST /orders/
ordersServicesPost	POST /orders/services/
queryPost	POST /query/
servicesDelete	DELETE /services/
servicesGet	GET /services/
servicesOpenGet	GET /services/open/
servicesPost	POST /services/
servicesPut	PUT /services/
variationDelete	DELETE /variation/
variationGet	GET /variation/
variationPost	POST /variation/
variationPut	PUT /variation/
writeDelete	DELETE /write/
writePost	POST /write/

allGet

\InventoryClient\Model\InventoryGroup[] allGet()

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();

try {
    $result = $api_instance->allGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->allGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\InventoryClient\Model\InventoryGroup[]

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

categoriesDelete

\InventoryClient\Model\Response categoriesDelete($id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$id = "id_example"; // string | Id of category to remove

try {
    $result = $api_instance->categoriesDelete($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->categoriesDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Id of category to remove

Return type

\InventoryClient\Model\Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

categoriesPost

\InventoryClient\Model\Category[] categoriesPost($query)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$query = new \InventoryClient\Model\Category(); // \InventoryClient\Model\Category | Category to query against system

try {
    $result = $api_instance->categoriesPost($query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->categoriesPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
query	\InventoryClient\Model\Category	Category to query against system	[optional]

Return type

\InventoryClient\Model\Category[]

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

categoriesPut

\InventoryClient\Model\Category categoriesPut($id, $category)

If no ID is specified a new category will be created!

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$id = "id_example"; // string | category id to update.
$category = new \InventoryClient\Model\Category(); // \InventoryClient\Model\Category | New category information.

try {
    $result = $api_instance->categoriesPut($id, $category);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->categoriesPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	category id to update.
category	\InventoryClient\Model\Category	New category information.

Return type

\InventoryClient\Model\Category

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

itemAddPost

\InventoryClient\Model\Item itemAddPost($item)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$item = new \InventoryClient\Model\ItemRequest(); // \InventoryClient\Model\ItemRequest | Item to create.

try {
    $result = $api_instance->itemAddPost($item);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->itemAddPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
item	\InventoryClient\Model\ItemRequest	Item to create.

Return type

\InventoryClient\Model\Item

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

itemAddbulkPost

\InventoryClient\Model\Response itemAddbulkPost($items)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$items = array(new ItemRequest()); // \InventoryClient\Model\ItemRequest[] | Items to create.

try {
    $result = $api_instance->itemAddbulkPost($items);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->itemAddbulkPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
items	\InventoryClient\Model\ItemRequest[]	Items to create.

Return type

\InventoryClient\Model\Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

itemDelete

\InventoryClient\Model\Response itemDelete($id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$id = "id_example"; // string | item id to remove

try {
    $result = $api_instance->itemDelete($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->itemDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	item id to remove

Return type

\InventoryClient\Model\Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

itemGet

\InventoryClient\Model\Item itemGet($id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$id = "id_example"; // string | Item ID to open.

try {
    $result = $api_instance->itemGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->itemGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Item ID to open.

Return type

\InventoryClient\Model\Item

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

itemMediaDelete

\InventoryClient\Model\Response itemMediaDelete($imageurl)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$imageurl = "imageurl_example"; // string | URL of image to remove

try {
    $result = $api_instance->itemMediaDelete($imageurl);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->itemMediaDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
imageurl	string	URL of image to remove

Return type

\InventoryClient\Model\Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

itemMediaPost

string itemMediaPost($id, $image)

This endpoint is currently in testing.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$id = "id_example"; // string | Valid item id to bind image to.
$image = "/path/to/file.txt"; // \SplFileObject | Image.

try {
    $result = $api_instance->itemMediaPost($id, $image);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->itemMediaPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Valid item id to bind image to.
image	\SplFileObject	Image.

Return type

string

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: multipart/form-data, application/x-www-form-urlencoded
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

itemPut

\InventoryClient\Model\Response itemPut($id, $item)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$id = "id_example"; // string | item id to update.
$item = new \InventoryClient\Model\ItemRequest(); // \InventoryClient\Model\ItemRequest | New item information.

try {
    $result = $api_instance->itemPut($id, $item);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->itemPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	item id to update.
item	\InventoryClient\Model\ItemRequest	New item information.

Return type

\InventoryClient\Model\Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

itemsCountPost

float itemsCountPost($minprice, $maxprice, $query)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$minprice = 3.4; // float | Min price of items to find
$maxprice = 3.4; // float | Max price of items to find
$query = new \InventoryClient\Model\ItemRequest(); // \InventoryClient\Model\ItemRequest | Item to query against system.

try {
    $result = $api_instance->itemsCountPost($minprice, $maxprice, $query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->itemsCountPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
minprice	float	Min price of items to find	[optional]
maxprice	float	Max price of items to find	[optional]
query	\InventoryClient\Model\ItemRequest	Item to query against system.	[optional]

Return type

float

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

itemsPost

\InventoryClient\Model\Item[] itemsPost($minprice, $maxprice, $query)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$minprice = 3.4; // float | Min price of items to find
$maxprice = 3.4; // float | Max price of items to find
$query = new \InventoryClient\Model\ItemRequest(); // \InventoryClient\Model\ItemRequest | Item to query against system.

try {
    $result = $api_instance->itemsPost($minprice, $maxprice, $query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->itemsPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
minprice	float	Min price of items to find	[optional]
maxprice	float	Max price of items to find	[optional]
query	\InventoryClient\Model\ItemRequest	Item to query against system.	[optional]

Return type

\InventoryClient\Model\Item[]

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ordersPost

\InventoryClient\Model\Order[] ordersPost($query)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$query = new \InventoryClient\Model\OrderRequest(); // \InventoryClient\Model\OrderRequest | Order to query against item invoices.

try {
    $result = $api_instance->ordersPost($query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->ordersPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
query	\InventoryClient\Model\OrderRequest	Order to query against item invoices.	[optional]

Return type

\InventoryClient\Model\Order[]

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ordersServicesPost

\InventoryClient\Model\Order[] ordersServicesPost($query)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$query = new \InventoryClient\Model\OrderRequest(); // \InventoryClient\Model\OrderRequest | Order to query against service invoices.

try {
    $result = $api_instance->ordersServicesPost($query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->ordersServicesPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
query	\InventoryClient\Model\OrderRequest	Order to query against service invoices.	[optional]

Return type

\InventoryClient\Model\Order[]

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

queryPost

\InventoryClient\Model\Item[] queryPost($page, $categoryid, $sort, $search, $minprice, $maxprice, $query)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$page = 3.4; // float | Current page index.
$categoryid = "categoryid_example"; // string | Get items under specified category id.
$sort = "sort_example"; // string | Comma delimited Sort string. ie ; +ordprice. Please use number based fields only
$search = "search_example"; // string | Performs a regex pattern match against the items within your account
$minprice = 3.4; // float | Min price in hundreds (cents).
$maxprice = 3.4; // float | Max price in hundreds (cents).
$query = new \InventoryClient\Model\ItemRequest(); // \InventoryClient\Model\ItemRequest | Custom parameters to query against system.

try {
    $result = $api_instance->queryPost($page, $categoryid, $sort, $search, $minprice, $maxprice, $query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->queryPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
page	float	Current page index.	[optional]
categoryid	string	Get items under specified category id.	[optional]
sort	string	Comma delimited Sort string. ie ; +ordprice. Please use number based fields only	[optional]
search	string	Performs a regex pattern match against the items within your account	[optional]
minprice	float	Min price in hundreds (cents).	[optional]
maxprice	float	Max price in hundreds (cents).	[optional]
query	\InventoryClient\Model\ItemRequest	Custom parameters to query against system.	[optional]

Return type

\InventoryClient\Model\Item[]

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

servicesDelete

\InventoryClient\Model\Response servicesDelete($id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$id = "id_example"; // string | ID of the service to update

try {
    $result = $api_instance->servicesDelete($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->servicesDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	ID of the service to update

Return type

\InventoryClient\Model\Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

servicesGet

\InventoryClient\Model\Service[] servicesGet()

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();

try {
    $result = $api_instance->servicesGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->servicesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\InventoryClient\Model\Service[]

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

servicesOpenGet

\InventoryClient\Model\Service servicesOpenGet($id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$id = "id_example"; // string | ID of service to open

try {
    $result = $api_instance->servicesOpenGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->servicesOpenGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	ID of service to open

Return type

\InventoryClient\Model\Service

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

servicesPost

\InventoryClient\Model\Service servicesPost($service)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$service = new \InventoryClient\Model\ServiceRequest(); // \InventoryClient\Model\ServiceRequest | Service to create.

try {
    $result = $api_instance->servicesPost($service);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->servicesPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
service	\InventoryClient\Model\ServiceRequest	Service to create.

Return type

\InventoryClient\Model\Service

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

servicesPut

\InventoryClient\Model\Response servicesPut($id, $service)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$id = "id_example"; // string | ID of the service to update
$service = new \InventoryClient\Model\ServiceRequest(); // \InventoryClient\Model\ServiceRequest | New service data to set.

try {
    $result = $api_instance->servicesPut($id, $service);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->servicesPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	ID of the service to update
service	\InventoryClient\Model\ServiceRequest	New service data to set.

Return type

\InventoryClient\Model\Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

variationDelete

\InventoryClient\Model\Response variationDelete($id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$id = "id_example"; // string | variation id to remove

try {
    $result = $api_instance->variationDelete($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->variationDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	variation id to remove

Return type

\InventoryClient\Model\Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

variationGet

\InventoryClient\Model\Variation variationGet($id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$id = "id_example"; // string | Variation ID to open.

try {
    $result = $api_instance->variationGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->variationGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Variation ID to open.

Return type

\InventoryClient\Model\Variation

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

variationPost

\InventoryClient\Model\Response variationPost($id, $item)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$id = "id_example"; // string | Valid item id to bind variation to.
$item = new \InventoryClient\Model\Variation(); // \InventoryClient\Model\Variation | Variation information.

try {
    $result = $api_instance->variationPost($id, $item);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->variationPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Valid item id to bind variation to.
item	\InventoryClient\Model\Variation	Variation information.

Return type

\InventoryClient\Model\Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

variationPut

\InventoryClient\Model\Response variationPut($id, $item)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$id = "id_example"; // string | variation id to update.
$item = new \InventoryClient\Model\Variation(); // \InventoryClient\Model\Variation | New variation information.

try {
    $result = $api_instance->variationPut($id, $item);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->variationPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	variation id to update.
item	\InventoryClient\Model\Variation	New variation information.

Return type

\InventoryClient\Model\Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

writeDelete

\InventoryClient\Model\Response writeDelete($id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$id = "id_example"; // string | Will delete event attached to this serviceid

try {
    $result = $api_instance->writeDelete($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->writeDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Will delete event attached to this serviceid	[optional]

Return type

\InventoryClient\Model\Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

writePost

\InventoryClient\Model\Response writePost($event_request)

Will ovveride the current event of the specified service.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIKey
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('APIKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIKey', 'Bearer');
// Configure API key authorization: AccountID
InventoryClient\Configuration::getDefaultConfiguration()->setApiKey('accountid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// InventoryClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('accountid', 'Bearer');

$api_instance = new InventoryClient\Api\DefaultApi();
$event_request = new \InventoryClient\Model\EventRequest(); // \InventoryClient\Model\EventRequest | Event to upload

try {
    $result = $api_instance->writePost($event_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->writePost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
event_request	\InventoryClient\Model\EventRequest	Event to upload

Return type

\InventoryClient\Model\Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

DefaultApi.md

Latest commit

History

DefaultApi.md

File metadata and controls

InventoryClient\DefaultApi

allGet

Example

Parameters

Return type

Authorization

HTTP request headers

categoriesDelete

Example

Parameters

Return type

Authorization

HTTP request headers

categoriesPost

Example

Parameters

Return type

Authorization

HTTP request headers

categoriesPut

Example

Parameters

Return type

Authorization

HTTP request headers

itemAddPost

Example

Parameters

Return type

Authorization

HTTP request headers

itemAddbulkPost

Example

Parameters

Return type

Authorization

HTTP request headers

itemDelete

Example

Parameters

Return type

Authorization

HTTP request headers

itemGet

Example

Parameters

Return type

Authorization

HTTP request headers

itemMediaDelete

Example

Parameters

Return type

Authorization

HTTP request headers

itemMediaPost

Example

Parameters

Return type

Authorization

HTTP request headers

itemPut

Example

Parameters

Return type

Authorization

HTTP request headers

itemsCountPost

Example

Parameters

Return type

Authorization

HTTP request headers

itemsPost