hitmeister/suppliers-api-sdk

Suppliers API SDK

Tuesday, July 24, 2018
by aazon
Repository
10 Watchers
0 Stars
5,156 Installations

PHP
0 Dependents
0 Suggesters
0 Forks
0 Open issues
19 Versions
22 % Grown

The README.md

suppliers-api-sdk

This documentation describes SMS Suppliers API. To be able use this API you should have an api-key and api-username, _(*1)

This PHP package is automatically generated by the Swagger Codegen project:, _(*2)

API versions: 1.11.1 & 2.0.0
Package version: 0.15.0
Build package: com.kaufland.swagger.codegen.CustomPhpClientCodegen

API versions

This SDK provides a way to communicate with both v1 AND v2 Suppliers APIs (see specific versions above). By default, version 1 is used. To change it, please use SMS\Suppliers\Configuration::getDefaultConfiguration()->setApiVersion($apiVersion) to set the API version (1 or 2) and make sure you then use the classes with the correct namespace to create your requests. Using a class of the wrong version could cause unexpected behaviour., _(*3)

Ex: SMS\Suppliers\Api\InventoryApi for version 1 and SMS\Suppliers\Api\v2\InventoryApi for version 2, _(*4)

Older implementations of this SDK don't need to be changed for version 1., _(*5)

Requirements

PHP 5.5 and later, _(*6)

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:, _(*7)

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/hitmeister/suppliers-api-sdk.git"
    }
  ],
  "require": {
    "hitmeister/suppliers-api-sdk": "*@dev"
  }
}

Then run composer install, _(*8)

Manual Installation

Download the files and include autoload.php:, _(*9)

    require_once('/path/to/suppliers-api-sdk/vendor/autoload.php');

Tests

To run the unit tests:, _(*10)

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:, _(*11)

setApiKey('api-key', 'YOUR_PARAMETER_VALUE');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SMS\Suppliers\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: apiUsername
$config = SMS\Suppliers\Configuration::getDefaultConfiguration()->setApiKey('api-username', 'YOUR_PARAMETER_VALUE');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SMS\Suppliers\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-username', 'Bearer');
// Set API version (1 or 2)
$config = SMS\Suppliers\Configuration::getDefaultConfiguration()->setApiVersion(1);

$apiInstance = new SMS\Suppliers\Api\InventoryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = "id_example"; // string | ID of inventory
$body = new \SMS\Suppliers\Model\CreateImportRequest(); // \SMS\Suppliers\Model\CreateImportRequest | Inventory import request which stores all the necessary info

try {
    $apiInstance->createImportRequest($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->createImportRequest: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Version 1

Endpoints

All URIs are relative to https://sms.kaufland.de/api/v1/supplier, _(*12)

Class	Method	HTTP request	Description
InventoryApi	createImportRequest	POST /inventories/{id}/import-requests	Create new inventory import
InventoryApi	getInventory	GET /inventories/{id}	Find inventory by ID
InventoryUnitApi	createInventoryUnit	POST /inventory-units	Create new inventory unit
InventoryUnitApi	deleteInventoryUnit	DELETE /inventory-units/{id}	Delete inventory unit by supplier_item_id
InventoryUnitApi	getInventoryUnit	GET /inventory-units/{id}	Find inventory unit by supplier_item_id
InventoryUnitApi	getInventoryUnits	GET /inventory-units	Find all inventory units
InventoryUnitApi	updateInventoryUnit	PATCH /inventory-units/{id}	Update inventory unit
ItemMeasurementApi	createItemMeasurement	POST /item-measurements	Create item-measurement by gtin (for crossdock & wholesaler)
ItemMeasurementApi	getItemMeasurement	GET /item-measurements/{gtin}	Find item-measurement by gtin
OrderApi	confirmOrder	POST /orders/{id}/confirm	Confirm order
OrderApi	getOrder	GET /orders/{id}	Find order by ID
OrderApi	getOrders	GET /orders	Find all orders by given parameters
OrderUnitApi	cancelOrderUnit	POST /order-units/{id}/cancel	Cancel an order unit
OrderUnitApi	getOrderUnit	GET /order-units/{id}	Find order unit by ID
OrderUnitApi	pickOrderUnit	POST /order-units/{id}/pick	Change order unit status to 'picking'
OrderUnitApi	sendOrderUnit	POST /order-units/{id}/send	Send an order unit
OrderUnitApi	updateOrderUnitShipment	POST /order-units/{id}/shipment	Update shipment data of the order unit
SubscriptionApi	createSubscription	POST /subscriptions	Create new subscription
SubscriptionApi	deleteSubscription	DELETE /subscriptions/{id}	Delete existing subscription
SubscriptionApi	updateSubscription	PATCH /subscriptions/{id}	Update existing subscription
SubscriptionApi	viewSubscription	GET /subscriptions/{id}	View existing subscription
SubscriptionApi	viewSubscriptions	GET /subscriptions	Get all existing subscriptions

Models

Documentation for API Version 2

Endpoints

All URIs are relative to https://sms.kaufland.de/api/v2/supplier, _(*13)

Class	Method	HTTP request	Description
InventoryApi	createImportRequest	POST /inventories/{id}/import-requests	Create new inventory import
InventoryApi	getInventory	GET /inventories/{id}	Find inventory by ID
InventoryUnitApi	createInventoryUnit	POST /inventory-units	Create new inventory unit
InventoryUnitApi	deleteInventoryUnit	DELETE /inventory-units/{id}	Delete inventory unit by supplier_item_id
InventoryUnitApi	getInventoryUnit	GET /inventory-units/{id}	Find inventory unit by supplier_item_id
InventoryUnitApi	getInventoryUnits	GET /inventory-units	Find all inventory units
InventoryUnitApi	updateInventoryUnit	PATCH /inventory-units/{id}	Update inventory unit
ItemMeasurementApi	createItemMeasurement	POST /item-measurements	Create item-measurement by gtin (for crossdock & wholesaler)
ItemMeasurementApi	getItemMeasurement	GET /item-measurements/{gtin}	Find item-measurement by gtin
OrderApi	confirmOrder	POST /orders/{id}/confirm	Confirm order
OrderApi	getOrder	GET /orders/{id}	Find order by ID
OrderApi	getOrders	GET /orders	Find all orders by given parameters
OrderUnitApi	cancelOrderUnit	POST /order-units/{id}/cancel	Cancel an order unit
OrderUnitApi	getOrderUnit	GET /order-units/{id}	Find order unit by ID
OrderUnitApi	pickOrderUnit	POST /order-units/{id}/pick	Change order unit status to 'picking'
OrderUnitApi	sendOrderUnit	POST /order-units/{id}/send	Send an order unit
OrderUnitApi	updateOrderUnitShipment	POST /order-units/{id}/shipment	Update shipment data of the order unit
SubscriptionApi	createSubscription	POST /subscriptions	Create new subscription
SubscriptionApi	deleteSubscription	DELETE /subscriptions/{id}	Delete existing subscription
SubscriptionApi	updateSubscription	PATCH /subscriptions/{id}	Update existing subscription
SubscriptionApi	viewSubscription	GET /subscriptions/{id}	View existing subscription
SubscriptionApi	viewSubscriptions	GET /subscriptions	Get all existing subscriptions

Models

Documentation For Authorization

apiKey

Type: API key
API key parameter name: api-key
Location: HTTP header

apiUsername

Type: API key
API key parameter name: api-username
Location: HTTP header

Author

sms.tech@kaufland-online.com, _(*14)

The Versions

24/07 2018

dev-master

9999999-dev https://sms.real.de/api/v1/docs

Suppliers API SDK

library suppliers-api-sdk