Загрузка заказов (JSON)

Выполняет загрузку заказов.

Данные передаются как JSON в теле POST-запроса. Подробно о формате передаваемых данных.

Чтобы Метрика обработала информацию о заказах, обязательно передайте данные о клиентах. Метрика привязывает информацию о клиентах к визитам, а данные о заказах — к визитам и клиентам. Это необходимо для расчета и отображения статистики.

Примечание. Для одного клиента можно передать не более 100 000 заказов.
  1. Синтаксис запроса
  2. В теле запроса
  3. Формат ответа

Синтаксис запроса

counterId — идентификатор счетчика, для которого вы хотите загрузить заказы.

https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/data/orders
 ? merge_mode=<update_type>
merge_mode *Режим сохранения данных. При любом из значений передавайте все обязательные поля — даже те, которые не меняются.

Допустимые значения:

  • SAVE — вся ранее переданная информация полностью заменяется новой. Подробно
  • UPDATE — обновляется только та информация, которую вы загружаете в данный момент. Подробно
  • APPEND — новая информация добавляется к ранее загруженной. Подробно
merge_mode *Режим сохранения данных. При любом из значений передавайте все обязательные поля — даже те, которые не меняются.

Допустимые значения:

  • SAVE — вся ранее переданная информация полностью заменяется новой. Подробно
  • UPDATE — обновляется только та информация, которую вы загружаете в данный момент. Подробно
  • APPEND — новая информация добавляется к ранее загруженной. Подробно

* Обязательный параметр

В теле запроса


--data '{
        "orders": [
            {
                "id": "704",
                "client_uniq_id": "J3QQ4-H7H2V-2HCH4-M3HK8-6M8VW",
                "client_type": "CONTACT",
                "order_status": "IN_PROGRESS",
                "create_date_time": "2022-09-21 09:48:23",
                "update_date_time": "2022-10-15 10:48:34",
                "cost": 4000,
                "revenue": 5000,
                "goals": [
                        {
                          "goal_action_id": "goal_id1",
                          "price": 123.5
                        }
                ],
                "products": {
                    "pear": 10,
                    "apple": 30
                }
            },
            {
                "id": "706",
                "client_uniq_id": "ZYX4-H7H2V-2HCH4-M3HK8-6M8VW",
                "client_type": "CONTACT",
                "order_status": "PAID",
                "create_date_time": "2022-09-30 10:48:23",
                "cost": 10000,
                "revenue": 13000,
                "goals": [
                        {
                          "goal_action_id": "goal_id2",
                          "price": 123.5
                        }
                ],
                "products": {
                    "apple": 30,
                    "cherry": 20
                }
            }
        ]
    }'
Параметры Описание
orders Список заказов.
orders
create_date_time Дата и время создания заказа в часовом поясе счетчика. Значение нельзя менять.
revenue Доход. Суммарная стоимость заказа.
cost Расходы.
currency Валюта заказа в стандарте ISO 4217.
goals Цели и их стоимости в заказе.
id Идентификатор заказа.
client_uniq_id Идентификатор клиента (uniq_id), к которому относится данный заказ.
client_type Тип клиента, к которому относится данный заказ.
update_date_time Дата и время обновления заказа в часовом поясе счетчика. Если параметр не передан, значение подставляется автоматически.
finish_date_time Дата и время завершения заказа в часовом поясе счетчика.
order_status Идентификатор статуса заказа. Произвольная строка. Статус можно менять. Укажите значение, которое вы передавали при сопоставлении статусов в поле id.
products Товары в заказе.
goals
goal_action_id Идентификатор JS-цели.
price Стоимость цели в заказе.
Параметры Описание
orders Список заказов.
orders
create_date_time Дата и время создания заказа в часовом поясе счетчика. Значение нельзя менять.
revenue Доход. Суммарная стоимость заказа.
cost Расходы.
currency Валюта заказа в стандарте ISO 4217.
goals Цели и их стоимости в заказе.
id Идентификатор заказа.
client_uniq_id Идентификатор клиента (uniq_id), к которому относится данный заказ.
client_type Тип клиента, к которому относится данный заказ.
update_date_time Дата и время обновления заказа в часовом поясе счетчика. Если параметр не передан, значение подставляется автоматически.
finish_date_time Дата и время завершения заказа в часовом поясе счетчика.
order_status Идентификатор статуса заказа. Произвольная строка. Статус можно менять. Укажите значение, которое вы передавали при сопоставлении статусов в поле id.
products Товары в заказе.
goals
goal_action_id Идентификатор JS-цели.
price Стоимость цели в заказе.

Пример запроса

POST https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/data/orders?merge_mode=SAVE

Формат ответа


{
    "uploading" : {
        "uploading_id" :  < string > ,
        "datetime" :  < local_date_time > ,
        "api_validation_status" :  < api_validation_status > ,
        "elements_count" :  < integer > ,
        "entity_type" :  < entity_type > ,
        "entity_subtype" :  < string > ,
        "uploading_format" :  < uploading_format > ,
        "uploading_source" :  < uploading_source > 
    }
}
Параметры Описание
uploading Информация о загрузке
uploading
uploading_id Идентификатор загрузки
datetime Время загрузки
api_validation_status Статус валидации загрузки

Возможные значения:

  • PASSED — Валидация прошла успешно
  • FAILED — Валидация прошла не успешно
elements_count Количество элементов в загрузке
entity_type Тип сущности

Возможные значения:

  • SYSTEM — Системная сущность, например контакты или заказы
  • CUSTOM_LIST — Пользовательский список
  • SYSTEM_LIST — Системный список, например товары
entity_subtype Подтип сущности
uploading_format Формат загрузки

Возможные значения:

  • JSON — JSON
  • CSV — CSV
uploading_source Источник загрузки

Возможные значения:

  • API — API
Параметры Описание
uploading Информация о загрузке
uploading
uploading_id Идентификатор загрузки
datetime Время загрузки
api_validation_status Статус валидации загрузки

Возможные значения:

  • PASSED — Валидация прошла успешно
  • FAILED — Валидация прошла не успешно
elements_count Количество элементов в загрузке
entity_type Тип сущности

Возможные значения:

  • SYSTEM — Системная сущность, например контакты или заказы
  • CUSTOM_LIST — Пользовательский список
  • SYSTEM_LIST — Системный список, например товары
entity_subtype Подтип сущности
uploading_format Формат загрузки

Возможные значения:

  • JSON — JSON
  • CSV — CSV
uploading_source Источник загрузки

Возможные значения:

  • API — API