InventoryClient

Orkiv Inventory API client

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Build date: 2016-08-05T15:01:53.036-04:00
• Build package: class io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
"repositories": [
{
"type": "git",
"url": "https://github.com/Orkiv/InventoryClient-php.git"
}
],
"require": {
"Orkiv/InventoryClient-php": "*@dev"
}
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

require_once('/path/to/InventoryClient/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:

<?phprequire_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: APIKeyInventoryClient\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: AccountIDInventoryClient\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 = newInventoryClient\Api\DefaultApi();
try {
$result = $api_instance->allGet();
print_r($result);
} catch (Exception$e) {
echo'Exception when calling DefaultApi->allGet: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

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

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

Documentation For Models

• Category
• Error
• EventRequest
• InventoryGroup
• Item
• ItemRequest
• Order
• OrderRequest
• Response
• Service
• ServiceRequest
• Variation

Documentation For Authorization

APIKey

• Type: API key
• API key parameter name: APIKey
• Location: HTTP header

AccountID

• Type: API key
• API key parameter name: accountid
• Location: HTTP header

Author