Работа с сущностью "Склад (warehouse)"

Изменено Fri, 24 Jun 2022 на 03:18 PM

Получить информацию о складе

Route: https://cdek.orderadmin.ru/api/storage/warehouse/<wrs_id>
Method: GET
Headers: Accept: application/json
Authorization: basic

Пример запроса (PHP):

<?php

$url = 'https://cdek.orderadmin.ru/api/storage/warehouse/4144';
$headers = [
    'Accept: application/json'
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, '<user>:<password>');
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($data);

Пример запроса (curl):

curl -X GET \
-u "<user>:<password>" \
-H "Accept: application/json" \
"https://cdek.orderadmin.ru/api/storage/warehouse/4144"

Пример запроса (Python):

import requests

api_url = 'https://cdek.orderadmin.ru/api/storage/warehouse/4144'
result = requests.get(api_url, auth=(
    '<user>', 
    '<password>'
))
print(result.json())

Пример ответа сервера:

{
    "id": 4144,
    "type": "virtual",
    "code": null,
    "name": "Тест ФФ Сдэк",
    "state": "active",
    "_embedded": {
        "parent": {
            "id": 88,
            "type": "fulfillment",
            "name": "Россия- Москва Белые столбы ФФ Сдэк",
            "state": "active"
        }
    },
    "_links": {
        "self": {
            "href": "https://cdek.orderadmin.ru/api/storage/warehouse/4144"
        }
    }
}

Описание полей ответа:

Поле	Описание
name	Название
type	склад клиента (виртуальный), склад Фулфилмент
state	работает, отключен
_embedded.parent	Информация о складе Фулфилмент с которым работает склад клиента

Получить список складов

Route: https://cdek.orderadmin.ru/api/storage/warehouse
Method: GET
Headers: Accept: application/json
Authorization: basic

Пример запроса (PHP):

<?php

$url = 'https://cdek.orderadmin.ru/api/storage/warehouse';
$headers = [
    'Accept: application/json'
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, '<user>:<password>');
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($data);

Пример запроса (curl):

curl -X GET \
-u "<user>:<password>" \
-H "Accept: application/json" \
"https://cdek.orderadmin.ru/api/storage/warehouse"

Пример запроса (Python):

import requests

api_url = 'https://cdek.orderadmin.ru/api/storage/warehouse'
result = requests.get(api_url, auth=(
    '<user>', 
    '<password>'
))
print(result.json())

Пример ответа сервера:

{
    "_links": {
        "self": {
            "href": "https://cdek.orderadmin.ru/api/storage/warehouse?page=1"
        },
        "first": {
            "href": "https://cdek.orderadmin.ru/api/storage/warehouse"
        },
        "last": {
            "href": "https://cdek.orderadmin.ru/api/storage/warehouse?page=8"
        },
        "next": {
            "href": "https://cdek.orderadmin.ru/api/storage/warehouse?page=2"
        }
    },
    "_embedded": {
        "warehouse": [
            /* Массив объектов warehouse */
        ]
    },
    "page_count": 8,
    "page_size": 25,
    "total_items": 182,
    "page": 1
}

Поиск

Поиск по части названия:

https://cdek.orderadmin.ru/api/storage/warehouse?filter[0][type]=ilike&filter[0][field]=name&filter[0][value]=Тест%

Поиск по id склада Фулфилмент:

https://cdek.orderadmin.ru/api/storage/warehouse?filter[0][type]=eq&filter[0][field]=parent&filter[0][value]=88