Работа с сущностью "Заказ"

Изменено Thu, 10 Nov 2022 на 11:34 AM

Получить информацию о заказе по ID

Route: https://cdek.orderadmin.ru/api/products/order/{id}
Method: GET
Headers: Accept: application/json
Authorization: basic

Параметры:

Параметр	Описание
id	Уникальный идентификатор заказа

Пример запроса через curl для тестового кабинета:

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

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

{
    "id": 3071236,
    "extId": "ext_1212179",
    "paymentState": "not_paid",
    "date": {
        "date": "2022-07-20 03:00:00.000000",
        "timezone_type": 1,
        "timezone": "+03:00"
    },
    "recipientName": "Петров Петр Петрович",
    "orderPrice": 2400,
    "totalPrice": 2400,
    "comment": "Q1_30K",
    "reserves": null,
    "state": "cancel",
    "created": {
        "date": "2022-07-20 13:06:58.000000",
        "timezone_type": 1,
        "timezone": "+03:00"
    },
    "updated": {
        "date": "2022-08-03 14:08:38.000000",
        "timezone_type": 1,
        "timezone": "+03:00"
    },
    "eav": {
        "order-reserve-warehouse": 6092,
        "delivery-services-request": true
    },
    "orderProducts": [
        {
            "id": 3403716
        }
    ],
    "_embedded": {
        "shop": {
            "id": 101354,
            "type": "virtual",
            "name": "Тест ФФ Сдэк"
        },
        "profile": {
            "id": 5012831,
            "displayName": null,
            "surname": null,
            "name": "Петров Петр Петрович",
            "middleName": null,
            "email": "mail1@mail.ru",
            "description": null,
            "state": "active",
            "extId": "OA/8cc5d00ce1f7cb76047a05bc6c6abddb",
            "phones": [
                {
                    "id": "79051111111"
                }
            ]
        },
        "deliveryRequest": {
            "id": 3818426,
            "state": "cancelled",
            "paymentState": "payment_waiting",
            "extId": null,
            "estimatedCost": 2400,
            "payment": 2400,
            "senderName": "Тест ФФ Сдэк/МСК",
            "recipientName": "Петров Петр Петрович",
            "recipientComment": null,
            "trackingNumber": null,
            "eav": {
                "delivery-request-products-order": "3071236"
            }
        }
    },
    "_links": {
        "self": {
            "href": "https://cdek.orderadmin.ru/api/products/order/3071236"
        }
    }
}

Описание полей объекта:

Ключ	Описание
id	Уникальный идентификатор заказа
extId	Уникальный идентификатор, задаваемый программно
paymentState	Оплачен? paid, not_paid
comment	Комментарий для сотрудников склада
state	Состояние заказа. Описание состояний
orderPrice	Стоимость товаров в заказе
totalPrice	Общая стоимость заказа
eav.order-reserve-warehouse	Склад, на котором будет собираться заказ
eav.delivery-services-request	Нужно создать заказ на доставку в Сдэк
_embedded.shop	Информация о магазине пользователя
_embedded.profile	Информация о получателе
_embedded.deliveryRequest	Информация о заявке на доставку

Получить информацию о заказе по extId

Route: https://cdek.orderadmin.ru/api/products/order?filter[0][type]=eq&filter[0][field]=extId&filter[0][value]={extId}
Method: GET
Headers: Accept: application/json
Authorization: basic

Параметры:

Параметр	Описание
extId	Идентификатор заказа, заданный при его создании через API

Пример запроса через curl для тестового кабинета:

curl -X GET \
-u "<user>:<password>" \
-H "Accept: application/json" \
"https://cdek.orderadmin.ru/api/products/order?filter[0][type]=eq&filter[0][field]=extId&filter[0][value]=ext_1212179"

Получить информацию о товарах заказа

Route: https://cdek.orderadmin.ru/api/products/order/product?filter[0][type]=eq&filter[0][field]=order&filter[0][value]={id}
Method: GET
Headers: Accept: application/json
Authorization: basic

Параметры:

Параметр	Описание
id	ID заказа

Пример запроса через curl для тестового кабинета:

curl -X GET \
-u "<user>:<password>" \
-H "Accept: application/json" \
"https://cdek.orderadmin.ru/api/products/order/product?filter[0][type]=eq&filter[0][field]=order&filter[0][value]=3071236"

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

{
    "_links": {
        "self": {
            "href": "https://cdek.orderadmin.ru/api/products/order/product?filter%5B0%5D%5Btype%5D=eq&filter%5B0%5D%5Bfield%5D=order&filter%5B0%5D%5Bvalue%5D=3071236&page=1"
        },
        "first": {
            "href": "https://cdek.orderadmin.ru/api/products/order/product?filter%5B0%5D%5Btype%5D=eq&filter%5B0%5D%5Bfield%5D=order&filter%5B0%5D%5Bvalue%5D=3071236"
        },
        "last": {
            "href": "https://cdek.orderadmin.ru/api/products/order/product?filter%5B0%5D%5Btype%5D=eq&filter%5B0%5D%5Bfield%5D=order&filter%5B0%5D%5Bvalue%5D=3071236&page=1"
        }
    },
    "_embedded": {
        "order_product": [
            {
                "id": 3403716,
                "count": 2,
                "price": 1200,
                "total": 2400,
                "weight": null,
                "dimensions": {
                    "x": 100,
                    "y": 100,
                    "z": 100
                },
                "volume": null,
                "state": "active",
                "_embedded": {
                    "order": {
                        "id": 3071236,
                        "extId": "ext_1212179",
                        "paymentState": "not_paid",
                        "recipientName": "Петров Петр Петрович",
                        "orderPrice": 2400,
                        "totalPrice": 2400,
                        "comment": "Q1_30K",
                        "state": "cancel",
                        "eav": {
                            "order-reserve-warehouse": 6092,
                            "delivery-services-request": true
                        },
                        "orderProducts": [
                            {
                                "id": 3403716
                            }
                        ]
                    },
                    "shop": {
                        "id": 185486,
                        "type": "shop",
                        "name": "CDEK",
                        "state": "active"
                    },
                    "productOffer": {
                        "id": 5757436,
                        "article": "1",
                        "name": "Футболка",
                        "type": "simple",
                        "image": "https://ams3.digitaloceanspaces.com/orderadmin-cloud/modules/application/data/5757436/101354.jpg",
                        "barcodes": [],
                        "sku": null,
                        "dimensions": {
                            "x": 100,
                            "y": 100,
                            "z": 100
                        },
                        "weight": null,
                        "price": 1200,
                        "state": "normal",
                        "extId": "3339067261"
                    }
                },
                "_links": {
                    "self": {
                        "href": "https://cdek.orderadmin.ru/api/products/order/product/3403716"
                    }
                }
            }
        ]
    },
    "page_count": 1,
    "page_size": 25,
    "total_items": 1,
    "page": 1
}

Описание полей объекта:

Ключ	Описание
id	Уникальный идентификатор объекта
count	Кол-во данного товара в заказе
price	Цена за единицу
total	Общая стоимость
weight	Вес
dimensions	Габариты
_embedded.order	Информация о заказе
_embedded.shop	Информация о магазине
_embedded.productOffer	Информация о товаре