Download the PHP package hitmeister/suppliers-api-sdk without Composer
On this page you can find all versions of the php package hitmeister/suppliers-api-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download hitmeister/suppliers-api-sdk
More information about hitmeister/suppliers-api-sdk
Files in hitmeister/suppliers-api-sdk
Package suppliers-api-sdk
Short Description Suppliers API SDK
License MIT
Homepage https://sms.kaufland.de/api/v1/specs/?url=/api/v2/specs/supplier_api.yaml
Informations about the package suppliers-api-sdk
suppliers-api-sdk
This documentation describes SMS Suppliers API. To be able use this API you should have an api-key and api-username
This PHP package is automatically generated by the Swagger Codegen project:
- 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.
Ex: SMS\Suppliers\Api\InventoryApi
for version 1 and SMS\Suppliers\Api\v2\InventoryApi
for version 2
Older implementations of this SDK don't need to be changed for version 1.
Requirements
PHP 5.5 and later
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json
:
Then run composer install
Manual Installation
Download the files and include autoload.php
:
Tests
To run the unit tests:
Getting Started
Please follow the installation procedure and then run the following:
Documentation for API Version 1
Endpoints
All URIs are relative to https://sms.kaufland.de/api/v1/supplier
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
- BadRequestResponse
- CancelOrderUnitRequest
- Carrier
- CarrierService
- CreateImportRequest
- CreateInventoryUnitRequest
- CreateInventoryUnitResponse
- CreateItemMeasurementRequest
- CreateSubscriptionRequest
- CreateSubscriptionResponse
- GetFulfilmentOrderResponse
- GetFulfilmentOrderUnitResponse
- GetFulfilmentOrdersResponse
- GetInventoryResponse
- GetInventoryUnitResponse
- Item
- ItemMeasurementResponse
- SendOrderUnitRequest
- ShipmentAddress
- ShipmentData
- UpdateInventoryUnitRequest
- UpdateOrderUnitShipmentDataRequest
- UpdateSubscriptionRequest
- UpdateSubscriptionResponse
- User
- ViewSubscriptionResponse
Documentation for API Version 2
Endpoints
All URIs are relative to https://sms.kaufland.de/api/v2/supplier
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
- BadRequestResponse
- CancelOrderUnitRequest
- Carrier
- CarrierService
- CreateImportRequest
- CreateInventoryCountryValuesRequest
- CreateInventoryUnitRequest
- CreateInventoryUnitResponse
- CreateItemMeasurementRequest
- CreateSubscriptionRequest
- CreateSubscriptionResponse
- GetFulfilmentOrderResponse
- GetFulfilmentOrderUnitResponse
- GetFulfilmentOrdersResponse
- GetInventoryResponse
- GetInventoryUnitCountryValueResponse
- GetInventoryUnitResponse
- Item
- ItemMeasurementResponse
- SendOrderUnitRequest
- ShipmentAddress
- ShipmentData
- UpdateInventoryCountryValuesRequest
- UpdateInventoryUnitRequest
- UpdateOrderUnitShipmentDataRequest
- UpdateSubscriptionRequest
- UpdateSubscriptionResponse
- User
- ViewSubscriptionResponse
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
All versions of suppliers-api-sdk with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^6.2