Заказы


Этот раздел базовую информацию о заказах в API Zenky.io. Для получения информации о том, как работать с заказами, обратитесь к соответствующему разделу.

Используемые структуры

Заказ

{
    "id": "8ffe2a55-1af7-47d4-9d2c-edd40b2b06b5",
    "city_id": "8ffdeafc-ce5b-4079-b73f-a2d39f8bde70",
    "order_status_id": "8ffdea87-775f-47e9-89f0-bbb974dae43f",
    "number": "0303-1",
    "token": "secret",
    "source": "",
    "api_client": {
        "id": "web",
        "name": "Сайт"
    },
    "status": {
        "id": "submitted",
        "name": "Новый"
    },
    "confirmation_status": {
        "id": "confirmed",
        "name": "Подтверждён"
    },
    "delivery_method": {
        "id": "delivery",
        "name": "Курьер"
    },
    "payment_method": {
        "id": "credit-card",
        "name": "Картой при получении"
    },
    "total_price": {
        "value": 10399000,
        "short": "103 990",
        "trimmed": "103990",
        "full": "103 990₽",
        "currency": {
            "code": "RUB",
            "name": "Российский рубль",
            "thousands_separator": " ",
            "decimals_separator": ".",
            "prefix": "",
            "suffix": "₽",
            "symbol": "₽"
        }
    },
    "original_total_price": {
        "value": 0,
        "short": "0",
        "trimmed": "0",
        "full": "0₽",
        "currency": {
            "code": "RUB",
            "name": "Российский рубль",
            "thousands_separator": " ",
            "decimals_separator": ".",
            "prefix": "",
            "suffix": "₽",
            "symbol": "₽"
        }
    },
    "discount_difference": null,
    "discount_percentage": null,
    "has_discount": false,
    "expected_payment_amount": {
        "value": 10399000,
        "short": "103 990",
        "trimmed": "103990",
        "full": "103 990₽",
        "currency": {
            "code": "RUB",
            "name": "Российский рубль",
            "thousands_separator": " ",
            "decimals_separator": ".",
            "prefix": "",
            "suffix": "₽",
            "symbol": "₽"
        }
    },
    "amount_paid": {
        "value": 0,
        "short": "0",
        "trimmed": "0",
        "full": "0₽",
        "currency": {
            "code": "RUB",
            "name": "Российский рубль",
            "thousands_separator": " ",
            "decimals_separator": ".",
            "prefix": "",
            "suffix": "₽",
            "symbol": "₽"
        }
    },
    "bonuses_amount_paid": {
        "value": 0,
        "short": "0",
        "trimmed": "0",
        "full": "0₽",
        "currency": {
            "code": "RUB",
            "name": "Российский рубль",
            "thousands_separator": " ",
            "decimals_separator": ".",
            "prefix": "",
            "suffix": "₽",
            "symbol": "₽"
        }
    },
    "bonuses_transaction_id": "",
    "bonuses_transaction_confirmed": false,
    "notes": "Персон: 1",
    "created_at": {
        "timezone": "Asia\/Irkutsk",
        "datetime_utc": "2020-03-03 06:45:47",
        "datetime": "2020-03-03 14:45:47",
        "datetime_at": "03.03.2020 в 14:45",
        "date": "03.03.2020",
        "diff": "1 год назад",
        "timestamp": 1583217947,
        "iso_utc": "2020-03-03T06:45:47+00:00",
        "iso": "2020-03-03T14:45:47+08:00"
    },
    "updated_at": {
        "timezone": "Asia\/Irkutsk",
        "datetime_utc": "2020-03-03 06:47:33",
        "datetime": "2020-03-03 14:47:33",
        "datetime_at": "03.03.2020 в 14:47",
        "date": "03.03.2020",
        "diff": "1 год назад",
        "timestamp": 1583218053,
        "iso_utc": "2020-03-03T06:47:33+00:00",
        "iso": "2020-03-03T14:47:33+08:00"
    },
    "submitted_at": {
        "timezone": "Asia\/Irkutsk",
        "datetime_utc": "2020-03-03 06:47:32",
        "datetime": "2020-03-03 14:47:32",
        "datetime_at": "03.03.2020 в 14:47",
        "date": "03.03.2020",
        "diff": "1 год назад",
        "timestamp": 1583218052,
        "iso_utc": "2020-03-03T06:47:32+00:00",
        "iso": "2020-03-03T14:47:32+08:00"
    },
    "deliver_at": null,
    "archived_at": null,
    "meta_data": null,
    "current_status": {
        "id": "8ffe2af7-0ca2-403d-a3ad-08c467065f15",
        "order_status_id": "8ffdea87-775f-47e9-89f0-bbb974dae43f",
        "is_system": false,
        "created_at": {
            "timezone": "Asia\/Irkutsk",
            "datetime_utc": "2020-03-03 06:47:32",
            "datetime": "2020-03-03 14:47:32",
            "datetime_at": "03.03.2020 в 14:47",
            "date": "03.03.2020",
            "diff": "1 год назад",
            "timestamp": 1583218052,
            "iso_utc": "2020-03-03T06:47:32+00:00",
            "iso": "2020-03-03T14:47:32+08:00"
        },
        "status": {
            "id": "8ffdea87-775f-47e9-89f0-bbb974dae43f",
            "name": "Новый",
            "kind": {
                "id": "submitted",
                "name": "Новый"
            },
            "background_color": "#d78ca4",
            "sorting": 1,
            "visible": true,
            "created_at": {
                "timezone": "Asia\/Irkutsk",
                "datetime_utc": "2020-03-03 03:47:22",
                "datetime": "2020-03-03 11:47:22",
                "datetime_at": "03.03.2020 в 11:47",
                "date": "03.03.2020",
                "diff": "1 год назад",
                "timestamp": 1583207242,
                "iso_utc": "2020-03-03T03:47:22+00:00",
                "iso": "2020-03-03T11:47:22+08:00"
            },
            "updated_at": {
                "timezone": "Asia\/Irkutsk",
                "datetime_utc": "2020-03-03 03:47:22",
                "datetime": "2020-03-03 11:47:22",
                "datetime_at": "03.03.2020 в 11:47",
                "date": "03.03.2020",
                "diff": "1 год назад",
                "timestamp": 1583207242,
                "iso_utc": "2020-03-03T03:47:22+00:00",
                "iso": "2020-03-03T11:47:22+08:00"
            }
        }
    }
}

Описание полей

Поле deliver_at

Поле deliver_at может хранить в себе дату доставки, которую вручную указал покупатель. Имейте в виду, что эта дата (как и все остальные в API) будет использовать часовой пояс UTC.

Подробнее о датах см. в отдельном документе.

Покупатель

{
    "id": "8b8bdf33-ce59-4ad3-b3e1-53033c3ba9c3",
    "store_profile_id": "8ffe2af5-d180-4a2e-8237-c66bbd57b2fe",
    "name": "Иван Иванов",
    "first_name": "Иван",
    "last_name": "Иванов",
    "full_name": "Иван Иванов",
    "phone": {
        "e164": "+79641234567",
        "international": "+7 964 123-45-67",
        "national": "+7 (964) 123-45-67",
        "country": "RU"
    },
    "gender": {
        "id": "other",
        "name": "Не указан"
    },
    "birth_date": [],
    "loyalty": null,
    "created_at": {
        "timezone": "Asia\/Irkutsk",
        "datetime_utc": "2020-03-03 06:47:32",
        "datetime": "2020-03-03 14:47:32",
        "datetime_at": "03.03.2020 в 14:47",
        "date": "03.03.2020",
        "diff": "1 год назад",
        "timestamp": 1583218052,
        "iso_utc": "2020-03-03T06:47:32+00:00",
        "iso": "2020-03-03T14:47:32+08:00"
    },
    "updated_at": {
        "timezone": "Asia\/Irkutsk",
        "datetime_utc": "2020-11-23 06:38:44",
        "datetime": "2020-11-23 14:38:44",
        "datetime_at": "23.11.2020 в 14:38",
        "date": "23.11.2020",
        "diff": "5 месяцев назад",
        "timestamp": 1606113524,
        "iso_utc": "2020-11-23T06:38:44+00:00",
        "iso": "2020-11-23T14:38:44+08:00"
    }
}

Описание полей

Позиция заказа

{
    "uuid": "92a5dbb6-f524-41db-b60a-4f94bb74217f",
    "product_id": "8ffdf871-fb9f-4465-b728-e54970ce5386",
    "product_variant_id": "8ffdfbd4-50fe-41ee-8506-d52198014580",
    "quantity": 1,
    "total_price": {
        "value": 10399000,
        "short": "103 990",
        "trimmed": "103990",
        "full": "103 990₽",
        "currency": {
            "code": "RUB",
            "name": "Российский рубль",
            "thousands_separator": " ",
            "decimals_separator": ".",
            "prefix": "",
            "suffix": "₽",
            "symbol": "₽"
        }
    },
    "original_total_price": {
        "value": 0,
        "short": "0",
        "trimmed": "0",
        "full": "0₽",
        "currency": {
            "code": "RUB",
            "name": "Российский рубль",
            "thousands_separator": " ",
            "decimals_separator": ".",
            "prefix": "",
            "suffix": "₽",
            "symbol": "₽"
        }
    },
    "unit_price": {
        "value": 0,
        "short": "0",
        "trimmed": "0",
        "full": "0₽",
        "currency": {
            "code": "RUB",
            "name": "Российский рубль",
            "thousands_separator": " ",
            "decimals_separator": ".",
            "prefix": "",
            "suffix": "₽",
            "symbol": "₽"
        }
    },
    "original_unit_price": {
        "value": 0,
        "short": "0",
        "trimmed": "0",
        "full": "0₽",
        "currency": {
            "code": "RUB",
            "name": "Российский рубль",
            "thousands_separator": " ",
            "decimals_separator": ".",
            "prefix": "",
            "suffix": "₽",
            "symbol": "₽"
        }
    },
    "discount_difference": null,
    "discount_percentage": null,
    "has_discount": false,
    "modifiers_hash": null,
    "created_at": {
        "timezone": "Asia\/Irkutsk",
        "datetime_utc": "2020-03-03 06:45:54",
        "datetime": "2020-03-03 14:45:54",
        "datetime_at": "03.03.2020 в 14:45",
        "date": "03.03.2020",
        "diff": "1 год назад",
        "timestamp": 1583217954,
        "iso_utc": "2020-03-03T06:45:54+00:00",
        "iso": "2020-03-03T14:45:54+08:00"
    },
    "updated_at": {
        "timezone": "Asia\/Irkutsk",
        "datetime_utc": "2021-02-04 03:48:54",
        "datetime": "2021-02-04 11:48:54",
        "datetime_at": "04.02.2021 в 11:48",
        "date": "04.02.2021",
        "diff": "2 месяца назад",
        "timestamp": 1612410534,
        "iso_utc": "2021-02-04T03:48:54+00:00",
        "iso": "2021-02-04T11:48:54+08:00"
    }
}

Описание полей

Статусы заказа

Каждый заказ имеет статус заказа с одним из следующих назначений:

Для получения текущего статуса вам необходимо использовать поле current_status. Для получения истории изменения статусов используйте включение statuses.

Подробную информацию о статусах заказов читайте в отдельном документе.

Прогресс статусов заказа

Мобильные приложения и сайты Zenky позволяют покупателем отслеживать статус заказов в виде шкалы прогресса (см. скриншот ниже). Для отображения такой шкалы необходимо использовать включение statuses_progress.

Отслеживание статуса заказа

Указанное включение добавит список статусов, а так же их время выполнения. Последним статусом всегда будет статус с назначением completed (если заказ был выполнен или ещё находится в процессе выполнения) или же с назначением cancelled (если заказ был отменён).

При построении списка учитывается флаг видимости статусов заказа.

Пример шкалы прогресса

[
    {
        "status_id": "8ffdea87-775f-47e9-89f0-bbb974dae43f",
        "completed_at": {
            "timezone": "Asia\/Irkutsk",
            "datetime_utc": "2020-03-03 06:47:32",
            "datetime": "2020-03-03 14:47:32",
            "datetime_at": "03.03.2020 в 14:47",
            "date": "03.03.2020",
            "diff": "1 год назад",
            "timestamp": 1583218052,
            "iso_utc": "2020-03-03T06:47:32+00:00",
            "iso": "2020-03-03T14:47:32+08:00"
        },
        "status": {
            "id": "8ffdea87-775f-47e9-89f0-bbb974dae43f",
            "name": "Новый",
            "kind": {
                "id": "submitted",
                "name": "Новый"
            },
            "background_color": "#d78ca4",
            "sorting": 1,
            "visible": true,
            "created_at": {
                "timezone": "Asia\/Irkutsk",
                "datetime_utc": "2020-03-03 03:47:22",
                "datetime": "2020-03-03 11:47:22",
                "datetime_at": "03.03.2020 в 11:47",
                "date": "03.03.2020",
                "diff": "1 год назад",
                "timestamp": 1583207242,
                "iso_utc": "2020-03-03T03:47:22+00:00",
                "iso": "2020-03-03T11:47:22+08:00"
            },
            "updated_at": {
                "timezone": "Asia\/Irkutsk",
                "datetime_utc": "2020-03-03 03:47:22",
                "datetime": "2020-03-03 11:47:22",
                "datetime_at": "03.03.2020 в 11:47",
                "date": "03.03.2020",
                "diff": "1 год назад",
                "timestamp": 1583207242,
                "iso_utc": "2020-03-03T03:47:22+00:00",
                "iso": "2020-03-03T11:47:22+08:00"
            }
        }
    },
    {
        "status_id": "8ffdea87-7786-455a-831c-97ce7c4e1df4",
        "completed_at": null,
        "status": {
            "id": "8ffdea87-7786-455a-831c-97ce7c4e1df4",
            "name": "В сборке",
            "kind": {
                "id": "packing",
                "name": "Готовится"
            },
            "background_color": "#8d3753",
            "sorting": 3,
            "visible": true,
            "created_at": {
                "timezone": "Asia\/Irkutsk",
                "datetime_utc": "2020-03-03 03:47:22",
                "datetime": "2020-03-03 11:47:22",
                "datetime_at": "03.03.2020 в 11:47",
                "date": "03.03.2020",
                "diff": "1 год назад",
                "timestamp": 1583207242,
                "iso_utc": "2020-03-03T03:47:22+00:00",
                "iso": "2020-03-03T11:47:22+08:00"
            },
            "updated_at": {
                "timezone": "Asia\/Irkutsk",
                "datetime_utc": "2020-03-03 03:47:22",
                "datetime": "2020-03-03 11:47:22",
                "datetime_at": "03.03.2020 в 11:47",
                "date": "03.03.2020",
                "diff": "1 год назад",
                "timestamp": 1583207242,
                "iso_utc": "2020-03-03T03:47:22+00:00",
                "iso": "2020-03-03T11:47:22+08:00"
            }
        }
    },
    {
        "status_id": "8ffdea87-7798-41b2-92b8-81b76bfea7ef",
        "completed_at": null,
        "status": {
            "id": "8ffdea87-7798-41b2-92b8-81b76bfea7ef",
            "name": "В доставке",
            "kind": {
                "id": "delivering",
                "name": "В доставке"
            },
            "background_color": "#705de0",
            "sorting": 4,
            "visible": true,
            "created_at": {
                "timezone": "Asia\/Irkutsk",
                "datetime_utc": "2020-03-03 03:47:22",
                "datetime": "2020-03-03 11:47:22",
                "datetime_at": "03.03.2020 в 11:47",
                "date": "03.03.2020",
                "diff": "1 год назад",
                "timestamp": 1583207242,
                "iso_utc": "2020-03-03T03:47:22+00:00",
                "iso": "2020-03-03T11:47:22+08:00"
            },
            "updated_at": {
                "timezone": "Asia\/Irkutsk",
                "datetime_utc": "2020-03-03 03:47:22",
                "datetime": "2020-03-03 11:47:22",
                "datetime_at": "03.03.2020 в 11:47",
                "date": "03.03.2020",
                "diff": "1 год назад",
                "timestamp": 1583207242,
                "iso_utc": "2020-03-03T03:47:22+00:00",
                "iso": "2020-03-03T11:47:22+08:00"
            }
        }
    },
    {
        "status_id": "8ffdea87-77d2-408b-a0e6-1acaf101deb1",
        "completed_at": null,
        "status": {
            "id": "8ffdea87-77d2-408b-a0e6-1acaf101deb1",
            "name": "Выполнен",
            "kind": {
                "id": "completed",
                "name": "Выполнен"
            },
            "background_color": "#3b0756",
            "sorting": 7,
            "visible": true,
            "created_at": {
                "timezone": "Asia\/Irkutsk",
                "datetime_utc": "2020-03-03 03:47:22",
                "datetime": "2020-03-03 11:47:22",
                "datetime_at": "03.03.2020 в 11:47",
                "date": "03.03.2020",
                "diff": "1 год назад",
                "timestamp": 1583207242,
                "iso_utc": "2020-03-03T03:47:22+00:00",
                "iso": "2020-03-03T11:47:22+08:00"
            },
            "updated_at": {
                "timezone": "Asia\/Irkutsk",
                "datetime_utc": "2020-03-03 03:47:22",
                "datetime": "2020-03-03 11:47:22",
                "datetime_at": "03.03.2020 в 11:47",
                "date": "03.03.2020",
                "diff": "1 год назад",
                "timestamp": 1583207242,
                "iso_utc": "2020-03-03T03:47:22+00:00",
                "iso": "2020-03-03T11:47:22+08:00"
            }
        }
    }
]

Структура прогресса статуса

Системы учёта

В случае, если вы используете шлюзы обмена данными, вам, вероятно, будут необходимы внешние идентификаторы каждого товара и варианта товара.

Для того, чтобы получить список заказов с товарами, вариантами и их внешними идентификаторами, вам необходимо скомбинировать необходимые включения, перечислив их через запятую.

Кроме того, при импорте новых заказов есть смысл фильтровать отдачу API по статусу заказа - передавая в параметре order_status_id любое значение из списка статусов заказа (можно указывать несколько - через запятую).

Пример

В качестве примера приведём адрес API, который позволит получить такую информацию:

GET https://api.zenky.io/v2/orders?order_status_id=8e45eb4f-7bbb-446e-9066-8049007cc1cd&with=customer,city,variants.variant.external_identifier,variants.product.external_identifier

Результирующий объект заказа будет выглядеть следующим образом:

{
    "id": "8ffe2a55-1af7-47d4-9d2c-edd40b2b06b5",
    "city_id": "8ffdeafc-ce5b-4079-b73f-a2d39f8bde70",
    "order_status_id": "8ffdea87-775f-47e9-89f0-bbb974dae43f",
    "number": "0303-1",
    "token": "secret",
    "source": "",
    "api_client": {
        "id": "web",
        "name": "Сайт"
    },
    "status": {
        "id": "submitted",
        "name": "Новый"
    },
    "confirmation_status": {
        "id": "confirmed",
        "name": "Подтверждён"
    },
    "delivery_method": {
        "id": "delivery",
        "name": "Курьер"
    },
    "payment_method": {
        "id": "credit-card",
        "name": "Картой при получении"
    },
    "total_price": {
        "value": 10399000,
        "short": "103 990",
        "trimmed": "103990",
        "full": "103 990₽",
        "currency": {
            "code": "RUB",
            "name": "Российский рубль",
            "thousands_separator": " ",
            "decimals_separator": ".",
            "prefix": "",
            "suffix": "₽",
            "symbol": "₽"
        }
    },
    "original_total_price": {
        "value": 0,
        "short": "0",
        "trimmed": "0",
        "full": "0₽",
        "currency": {
            "code": "RUB",
            "name": "Российский рубль",
            "thousands_separator": " ",
            "decimals_separator": ".",
            "prefix": "",
            "suffix": "₽",
            "symbol": "₽"
        }
    },
    "discount_difference": null,
    "discount_percentage": null,
    "has_discount": false,
    "expected_payment_amount": {
        "value": 10399000,
        "short": "103 990",
        "trimmed": "103990",
        "full": "103 990₽",
        "currency": {
            "code": "RUB",
            "name": "Российский рубль",
            "thousands_separator": " ",
            "decimals_separator": ".",
            "prefix": "",
            "suffix": "₽",
            "symbol": "₽"
        }
    },
    "amount_paid": {
        "value": 0,
        "short": "0",
        "trimmed": "0",
        "full": "0₽",
        "currency": {
            "code": "RUB",
            "name": "Российский рубль",
            "thousands_separator": " ",
            "decimals_separator": ".",
            "prefix": "",
            "suffix": "₽",
            "symbol": "₽"
        }
    },
    "bonuses_amount_paid": {
        "value": 0,
        "short": "0",
        "trimmed": "0",
        "full": "0₽",
        "currency": {
            "code": "RUB",
            "name": "Российский рубль",
            "thousands_separator": " ",
            "decimals_separator": ".",
            "prefix": "",
            "suffix": "₽",
            "symbol": "₽"
        }
    },
    "bonuses_transaction_id": "",
    "bonuses_transaction_confirmed": false,
    "notes": "Персон: 1",
    "created_at": {
        "timezone": "Asia\/Irkutsk",
        "datetime_utc": "2020-03-03 06:45:47",
        "datetime": "2020-03-03 14:45:47",
        "datetime_at": "03.03.2020 в 14:45",
        "date": "03.03.2020",
        "diff": "1 год назад",
        "timestamp": 1583217947,
        "iso_utc": "2020-03-03T06:45:47+00:00",
        "iso": "2020-03-03T14:45:47+08:00"
    },
    "updated_at": {
        "timezone": "Asia\/Irkutsk",
        "datetime_utc": "2020-03-03 06:47:33",
        "datetime": "2020-03-03 14:47:33",
        "datetime_at": "03.03.2020 в 14:47",
        "date": "03.03.2020",
        "diff": "1 год назад",
        "timestamp": 1583218053,
        "iso_utc": "2020-03-03T06:47:33+00:00",
        "iso": "2020-03-03T14:47:33+08:00"
    },
    "submitted_at": {
        "timezone": "Asia\/Irkutsk",
        "datetime_utc": "2020-03-03 06:47:32",
        "datetime": "2020-03-03 14:47:32",
        "datetime_at": "03.03.2020 в 14:47",
        "date": "03.03.2020",
        "diff": "1 год назад",
        "timestamp": 1583218052,
        "iso_utc": "2020-03-03T06:47:32+00:00",
        "iso": "2020-03-03T14:47:32+08:00"
    },
    "deliver_at": null,
    "archived_at": null,
    "meta_data": null,
    "current_status": {
        "id": "8ffe2af7-0ca2-403d-a3ad-08c467065f15",
        "order_status_id": "8ffdea87-775f-47e9-89f0-bbb974dae43f",
        "is_system": false,
        "created_at": {
            "timezone": "Asia\/Irkutsk",
            "datetime_utc": "2020-03-03 06:47:32",
            "datetime": "2020-03-03 14:47:32",
            "datetime_at": "03.03.2020 в 14:47",
            "date": "03.03.2020",
            "diff": "1 год назад",
            "timestamp": 1583218052,
            "iso_utc": "2020-03-03T06:47:32+00:00",
            "iso": "2020-03-03T14:47:32+08:00"
        },
        "status": {
            "id": "8ffdea87-775f-47e9-89f0-bbb974dae43f",
            "name": "Новый",
            "kind": {
                "id": "submitted",
                "name": "Новый"
            },
            "background_color": "#d78ca4",
            "sorting": 1,
            "visible": true,
            "created_at": {
                "timezone": "Asia\/Irkutsk",
                "datetime_utc": "2020-03-03 03:47:22",
                "datetime": "2020-03-03 11:47:22",
                "datetime_at": "03.03.2020 в 11:47",
                "date": "03.03.2020",
                "diff": "1 год назад",
                "timestamp": 1583207242,
                "iso_utc": "2020-03-03T03:47:22+00:00",
                "iso": "2020-03-03T11:47:22+08:00"
            },
            "updated_at": {
                "timezone": "Asia\/Irkutsk",
                "datetime_utc": "2020-03-03 03:47:22",
                "datetime": "2020-03-03 11:47:22",
                "datetime_at": "03.03.2020 в 11:47",
                "date": "03.03.2020",
                "diff": "1 год назад",
                "timestamp": 1583207242,
                "iso_utc": "2020-03-03T03:47:22+00:00",
                "iso": "2020-03-03T11:47:22+08:00"
            }
        }
    },
    "variants": [
        {
            "uuid": "92a5dbb6-f524-41db-b60a-4f94bb74217f",
            "product_id": "8ffdf871-fb9f-4465-b728-e54970ce5386",
            "product_variant_id": "8ffdfbd4-50fe-41ee-8506-d52198014580",
            "quantity": 1,
            "total_price": {
                "value": 10399000,
                "short": "103 990",
                "trimmed": "103990",
                "full": "103 990₽",
                "currency": {
                    "code": "RUB",
                    "name": "Российский рубль",
                    "thousands_separator": " ",
                    "decimals_separator": ".",
                    "prefix": "",
                    "suffix": "₽",
                    "symbol": "₽"
                }
            },
            "original_total_price": {
                "value": 0,
                "short": "0",
                "trimmed": "0",
                "full": "0₽",
                "currency": {
                    "code": "RUB",
                    "name": "Российский рубль",
                    "thousands_separator": " ",
                    "decimals_separator": ".",
                    "prefix": "",
                    "suffix": "₽",
                    "symbol": "₽"
                }
            },
            "unit_price": {
                "value": 0,
                "short": "0",
                "trimmed": "0",
                "full": "0₽",
                "currency": {
                    "code": "RUB",
                    "name": "Российский рубль",
                    "thousands_separator": " ",
                    "decimals_separator": ".",
                    "prefix": "",
                    "suffix": "₽",
                    "symbol": "₽"
                }
            },
            "original_unit_price": {
                "value": 0,
                "short": "0",
                "trimmed": "0",
                "full": "0₽",
                "currency": {
                    "code": "RUB",
                    "name": "Российский рубль",
                    "thousands_separator": " ",
                    "decimals_separator": ".",
                    "prefix": "",
                    "suffix": "₽",
                    "symbol": "₽"
                }
            },
            "discount_difference": null,
            "discount_percentage": null,
            "has_discount": false,
            "modifiers_hash": null,
            "created_at": {
                "timezone": "Asia\/Irkutsk",
                "datetime_utc": "2020-03-03 06:45:54",
                "datetime": "2020-03-03 14:45:54",
                "datetime_at": "03.03.2020 в 14:45",
                "date": "03.03.2020",
                "diff": "1 год назад",
                "timestamp": 1583217954,
                "iso_utc": "2020-03-03T06:45:54+00:00",
                "iso": "2020-03-03T14:45:54+08:00"
            },
            "updated_at": {
                "timezone": "Asia\/Irkutsk",
                "datetime_utc": "2021-02-04 03:48:54",
                "datetime": "2021-02-04 11:48:54",
                "datetime_at": "04.02.2021 в 11:48",
                "date": "04.02.2021",
                "diff": "2 месяца назад",
                "timestamp": 1612410534,
                "iso_utc": "2021-02-04T03:48:54+00:00",
                "iso": "2021-02-04T11:48:54+08:00"
            },
            "product": {
                "id": "8ffdf871-fb9f-4465-b728-e54970ce5386",
                "short_id": "8ffdf871fb9fe538",
                "slug": "iphone-11-pro",
                "hidden": false,
                "track_inventory": false,
                "name": "iPhone 11 Pro",
                "description": "Революционная система трёх камер — гораздо больше возможностей и неизменная простота в использовании. Беспрецедентное увеличение ресурса аккумулятора. И потряса­ющий процессор с расши­ренной поддержкой технологий машинного обучения, который открывает для iPhone большие новые перспек­тивы. Представляем iPhone 11 Pro. Он достоин своего имени.",
                "single_variant": false,
                "unit_type": {
                    "id": "piece",
                    "name": "Штука",
                    "short_name": "шт"
                },
                "weight": {
                    "grams": 0,
                    "full": "0 граммов",
                    "short": "0 гр."
                },
                "share": null,
                "created_at": {
                    "timezone": "Asia\/Irkutsk",
                    "datetime_utc": "2020-03-01 00:00:00",
                    "datetime": "2020-03-01 08:00:00",
                    "datetime_at": "01.03.2020 в 08:00",
                    "date": "01.03.2020",
                    "diff": "1 год назад",
                    "timestamp": 1583020800,
                    "iso_utc": "2020-03-01T00:00:00+00:00",
                    "iso": "2020-03-01T08:00:00+08:00"
                },
                "updated_at": {
                    "timezone": "Asia\/Irkutsk",
                    "datetime_utc": "2021-02-09 06:00:13",
                    "datetime": "2021-02-09 14:00:13",
                    "datetime_at": "09.02.2021 в 14:00",
                    "date": "09.02.2021",
                    "diff": "2 месяца назад",
                    "timestamp": 1612850413,
                    "iso_utc": "2021-02-09T06:00:13+00:00",
                    "iso": "2021-02-09T14:00:13+08:00"
                },
                "external_identifier": []
            },
            "variant": {
                "id": "8ffdfbd4-50fe-41ee-8506-d52198014580",
                "product_id": "8ffdf871-fb9f-4465-b728-e54970ce5386",
                "discount_id": null,
                "name": "iPhone 11 Pro 256 ГБ Тёмно-зеленый",
                "has_discount": false,
                "price": {
                    "value": 10399000,
                    "short": "103 990",
                    "trimmed": "103990",
                    "full": "103 990₽",
                    "currency": {
                        "code": "RUB",
                        "name": "Российский рубль",
                        "thousands_separator": " ",
                        "decimals_separator": ".",
                        "prefix": "",
                        "suffix": "₽",
                        "symbol": "₽"
                    }
                },
                "original_price": null,
                "discount_difference": null,
                "discount_percentage": null,
                "sku": "iphone-11-pro-07",
                "barcode": "iphone-11-pro-07",
                "created_at": {
                    "timezone": "Asia\/Irkutsk",
                    "datetime_utc": "2020-03-01 00:00:00",
                    "datetime": "2020-03-01 08:00:00",
                    "datetime_at": "01.03.2020 в 08:00",
                    "date": "01.03.2020",
                    "diff": "1 год назад",
                    "timestamp": 1583020800,
                    "iso_utc": "2020-03-01T00:00:00+00:00",
                    "iso": "2020-03-01T08:00:00+08:00"
                },
                "updated_at": {
                    "timezone": "Asia\/Irkutsk",
                    "datetime_utc": "2020-03-01 00:00:00",
                    "datetime": "2020-03-01 08:00:00",
                    "datetime_at": "01.03.2020 в 08:00",
                    "date": "01.03.2020",
                    "diff": "1 год назад",
                    "timestamp": 1583020800,
                    "iso_utc": "2020-03-01T00:00:00+00:00",
                    "iso": "2020-03-01T08:00:00+08:00"
                },
                "prices": [
                    {
                        "id": "8ffdfd5d-4dfe-4f0e-87d2-dd1cea72eaa9",
                        "price_type_id": "8ffdea87-0960-4669-8bc8-4b23d6045535",
                        "stock_id": null,
                        "discount_id": null,
                        "has_discount": false,
                        "price": {
                            "value": 10399000,
                            "short": "103 990",
                            "trimmed": "103990",
                            "full": "103 990₽",
                            "currency": {
                                "code": "RUB",
                                "name": "Российский рубль",
                                "thousands_separator": " ",
                                "decimals_separator": ".",
                                "prefix": "",
                                "suffix": "₽",
                                "symbol": "₽"
                            }
                        },
                        "original_price": null,
                        "discount_difference": null,
                        "discount_percentage": null,
                        "created_at": {
                            "timezone": "Asia\/Irkutsk",
                            "datetime_utc": "2020-03-01 00:00:00",
                            "datetime": "2020-03-01 08:00:00",
                            "datetime_at": "01.03.2020 в 08:00",
                            "date": "01.03.2020",
                            "diff": "1 год назад",
                            "timestamp": 1583020800,
                            "iso_utc": "2020-03-01T00:00:00+00:00",
                            "iso": "2020-03-01T08:00:00+08:00"
                        },
                        "updated_at": {
                            "timezone": "Asia\/Irkutsk",
                            "datetime_utc": "2020-03-01 00:00:00",
                            "datetime": "2020-03-01 08:00:00",
                            "datetime_at": "01.03.2020 в 08:00",
                            "date": "01.03.2020",
                            "diff": "1 год назад",
                            "timestamp": 1583020800,
                            "iso_utc": "2020-03-01T00:00:00+00:00",
                            "iso": "2020-03-01T08:00:00+08:00"
                        }
                    }
                ],
                "external_identifier": []
            }
        }
    ],
    "customer": {
        "id": "8b8bdf33-ce59-4ad3-b3e1-53033c3ba9c3",
        "store_profile_id": "8ffe2af5-d180-4a2e-8237-c66bbd57b2fe",
        "name": "Иван Иванов",
        "first_name": "Иван",
        "last_name": "Иванов",
        "full_name": "Иван Иванов",
        "phone": {
            "e164": "+79641234567",
            "international": "+7 964 123-45-67",
            "national": "+7 (964) 123-45-67",
            "country": "RU"
        },
        "gender": {
            "id": "other",
            "name": "Не указан"
        },
        "birth_date": [],
        "loyalty": null,
        "created_at": {
            "timezone": "Asia\/Irkutsk",
            "datetime_utc": "2020-03-03 06:47:32",
            "datetime": "2020-03-03 14:47:32",
            "datetime_at": "03.03.2020 в 14:47",
            "date": "03.03.2020",
            "diff": "1 год назад",
            "timestamp": 1583218052,
            "iso_utc": "2020-03-03T06:47:32+00:00",
            "iso": "2020-03-03T14:47:32+08:00"
        },
        "updated_at": {
            "timezone": "Asia\/Irkutsk",
            "datetime_utc": "2020-11-23 06:38:44",
            "datetime": "2020-11-23 14:38:44",
            "datetime_at": "23.11.2020 в 14:38",
            "date": "23.11.2020",
            "diff": "5 месяцев назад",
            "timestamp": 1606113524,
            "iso_utc": "2020-11-23T06:38:44+00:00",
            "iso": "2020-11-23T14:38:44+08:00"
        }
    },
    "city": {
        "id": "8ffdeafc-ce5b-4079-b73f-a2d39f8bde70",
        "name": "Улан-Удэ",
        "timezone": "Asia\/Irkutsk",
        "lat": 51.81977164755107,
        "lng": 107.60812989387635,
        "created_at": {
            "timezone": "Asia\/Irkutsk",
            "datetime_utc": "2020-03-01 00:00:00",
            "datetime": "2020-03-01 08:00:00",
            "datetime_at": "01.03.2020 в 08:00",
            "date": "01.03.2020",
            "diff": "1 год назад",
            "timestamp": 1583020800,
            "iso_utc": "2020-03-01T00:00:00+00:00",
            "iso": "2020-03-01T08:00:00+08:00"
        },
        "updated_at": {
            "timezone": "Asia\/Irkutsk",
            "datetime_utc": "2020-04-01 02:07:25",
            "datetime": "2020-04-01 10:07:25",
            "datetime_at": "01.04.2020 в 10:07",
            "date": "01.04.2020",
            "diff": "1 год назад",
            "timestamp": 1585706845,
            "iso_utc": "2020-04-01T02:07:25+00:00",
            "iso": "2020-04-01T10:07:25+08:00"
        }
    }
}

Ваши идентификаторы товаров будут доступны по пути variants.*.product.external_identifier.external_id, идентификаторы вариантов товаров - variants.*.variant.external_identifier.external_id.

Методы

Список поддерживаемых методов для работы с заказами.

Список заказов

Возвращает список заказов магазина.

Просмотр заказа

Возвращает информацию о конкретном заказе магазина.

Архивация заказа

Архивация заказа позволяет скрыть его из всех списков, в том числе из списка заказов покупателя.

Над архивированным заказом нельзя выполнять никакие действия кроме восстановления.

Массовая архивация заказов

Восстановление заказа

Восстановление заказа возвращает ранее архивированный заказ во все списки и позволяет вновь выполнять операции над этим заказом.

Массовое восстановление заказов