All URIs are relative to /v2
| Method | HTTP request | Description |
|---|---|---|
| createWarehouse | POST /warehouses | Create a new Warehouse |
| deleteWarehouse | DELETE /warehouses/{id_warehouse} | Delete a warehouse |
| getWarehouse | GET /warehouses/{id_warehouse} | Get a warehouse by its ID |
| getWarehouses | GET /warehouses | Get a list of your Warehouses |
| updateWarehouse | PUT /warehouses/{id_warehouse} | Update a Warehouse |
\Kaufland\Seller\Model\ApiResponseWarehouse_ createWarehouse($body)
Create a new Warehouse
Create a new warehouse.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Kaufland\Seller\Api\WarehousesApi(
// 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()
);
$body = new \Kaufland\Seller\Model\WarehouseBodyRequest(); // \Kaufland\Seller\Model\WarehouseBodyRequest | Information about the warehouse that will be generated
try {
$result = $apiInstance->createWarehouse($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling WarehousesApi->createWarehouse: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| body | \Kaufland\Seller\Model\WarehouseBodyRequest | Information about the warehouse that will be generated |
\Kaufland\Seller\Model\ApiResponseWarehouse_
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteWarehouse($id_warehouse)
Delete a warehouse
Delete a warehouse.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Kaufland\Seller\Api\WarehousesApi(
// 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()
);
$id_warehouse = 789; // int | Internal ID of Warehouse, unique across all Warehouses
try {
$apiInstance->deleteWarehouse($id_warehouse);
} catch (Exception $e) {
echo 'Exception when calling WarehousesApi->deleteWarehouse: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id_warehouse | int | Internal ID of Warehouse, unique across all Warehouses |
void (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Kaufland\Seller\Model\ApiResponseWarehouse_ getWarehouse($id_warehouse)
Get a warehouse by its ID
Gets a warehouse by id_warehouse.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Kaufland\Seller\Api\WarehousesApi(
// 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()
);
$id_warehouse = 789; // int | Internal ID of Warehouse, unique across all Warehouses
try {
$result = $apiInstance->getWarehouse($id_warehouse);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling WarehousesApi->getWarehouse: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id_warehouse | int | Internal ID of Warehouse, unique across all Warehouses |
\Kaufland\Seller\Model\ApiResponseWarehouse_
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Kaufland\Seller\Model\CollectionApiResponseWarehouse_ getWarehouses($limit, $offset)
Get a list of your Warehouses
Get a list of your warehouses.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Kaufland\Seller\Api\WarehousesApi(
// 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()
);
$limit = 30; // int | Desired size of result set
$offset = 0; // int | Offset applied to result set
try {
$result = $apiInstance->getWarehouses($limit, $offset);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling WarehousesApi->getWarehouses: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| limit | int | Desired size of result set | [optional] [default to 30] |
| offset | int | Offset applied to result set | [optional] [default to 0] |
\Kaufland\Seller\Model\CollectionApiResponseWarehouse_
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Kaufland\Seller\Model\ApiResponseWarehouse_ updateWarehouse($body, $id_warehouse)
Update a Warehouse
Update a warehouse.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Kaufland\Seller\Api\WarehousesApi(
// 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()
);
$body = new \Kaufland\Seller\Model\WarehouseBodyRequest(); // \Kaufland\Seller\Model\WarehouseBodyRequest | Update Object
$id_warehouse = 789; // int | Internal ID of Warehouse, unique across all Warehouses
try {
$result = $apiInstance->updateWarehouse($body, $id_warehouse);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling WarehousesApi->updateWarehouse: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| body | \Kaufland\Seller\Model\WarehouseBodyRequest | Update Object | |
| id_warehouse | int | Internal ID of Warehouse, unique across all Warehouses |
\Kaufland\Seller\Model\ApiResponseWarehouse_
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]