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

Выполняет загрузку заказов. Данные передаются как multipart/form-data в формате CSV. В первой строке запроса необходимо передать названия колонок. Подробно о формате передаваемых данных.

Пример загружаемого файла.

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

Примечание

  1. Для одного клиента можно передать не более 100 000 заказов.
  2. Ограничение на размер файла — 1 Гб.
Пример запроса
  • Передача целей: в колонке goals цели должны быть в формате goal_action1[:price1],goal_action2[:price2].
  • Передача товаров: в колонке products товары должны быть в формате Ноутбук TGDD12:1,Ноутбук TGD123:2. Сначала укажите товар, после — его количество.

Если передаете несколько целей/товаров, в качестве разделителя используйте точку с запятой (delimiter_type=SEMICOLON).

POST https://api-metrika.yandex.net/cdp/api/v1/counter/2215573/data/orders/csv?
    merge_mode=SAVE&
    columns_mapping=
        "id":"ИД",
        "client_uniq_id":"ИД клиента",
        "client_type":"Тип клиента",
        "order_status":"Статус",
        "create_date_time":"Дата создания",
        "revenue":"Сумма",
        "goals":"Цели"&
    delimiter_type=COMMA
    Content-Type: multipart/form-data; boundary=------------------------7zDUQOAIAE9hEWoV
    Context-Length: TBD

    --------------------------7zDUQOAIAE9hEWoV
    Content-Disposition: form-data; name="file"; filename="data.csv"
    Content-Type: text/csv

    ИД,ИД клиента,Тип клиента,Статус,Дата создания,Сумма,Цели
    100,11,CONTACT,paid,2020-06-11 12:30:00,43089.54,goal_action_id_1:1000
    101,42,CONTACT,paid,2019-10-11 09:10:00,109999,goal_action_id_2
    102,42,CONTACT,created,2020-12-24 12:30:00,1004.17,goal_action_id_3:500
    --------------------------7zDUQOAIAE9hEWoV--

Request

POST

https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/data/orders/csv

Path parameters

Name

Description

counterId

Type: integer

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

Query parameters

Name

Description

columns_mapping

Type: string

Соответствие названий столбцов названиям атрибутов.

Pattern: "([^"]+)":"([^"]+)"

Example: "uniq_id":"ИД","name":"Имя","birth_date":"Дата рождения"

merge_mode

Type: string

Режим сохранения данных. При любом из значений передавайте все обязательные поля — даже те, которые не меняются.

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

Example: SAVE

delimiter_type

Type: string

Вид разделителя столбцов в файле:

  • COMMA — разделитель "запятая".
  • SEMICOLON — разделитель "точка с запятой".

Default: COMMA

Example: ``

Body

multipart/form-data
{
  "file": "example"
}

Name

Description

file

Type: string<binary>

Ограничение на размер файла — 1 Гб.

Example: example

Responses

200 OK

OK

Body

application/json
{
  "uploading": {
    "uploading_id": "example",
    "datetime": "2025-01-01T00:00:00Z",
    "api_validation_status": "example",
    "elements_count": 0,
    "entity_type": "example",
    "entity_subtype": "example",
    "uploading_format": "example",
    "uploading_source": "example",
    "api_validation_errors": [
      "example"
    ],
    "uploading_title": "example"
  }
}

Name

Description

uploading

Type: UploadingMetaExternal

Информация о загрузке

Example
{
  "uploading_id": "example",
  "datetime": "2025-01-01T00:00:00Z",
  "api_validation_status": "example",
  "elements_count": 0,
  "entity_type": "example",
  "entity_subtype": "example",
  "uploading_format": "example",
  "uploading_source": "example",
  "api_validation_errors": [
    "example"
  ],
  "uploading_title": "example"
}

UploadingMetaExternal

Информация о загрузке

Name

Description

api_validation_status

Type: string

Статус валидации загрузки:

  • PASSED — валидация прошла успешно.
  • FAILED — валидация прошла не успешно.

Example: example

datetime

Type: string<date-time>

Время загрузки.

Example: 2025-01-01T00:00:00Z

elements_count

Type: integer

Количество элементов в загрузке.

entity_type

Type: string

Тип сущности:

  • SYSTEM — системная сущность, например, контакты или заказы.
  • CUSTOM_LIST — пользовательский список.
  • SYSTEM_LIST — системный список, например товары.

Example: example

uploading_format

Type: string

Формат загрузки. Возможные значения:

  • JSON.
  • CSV.

Example: example

uploading_id

Type: string

Идентификатор загрузки.

Example: example

uploading_source

Type: string

Источник загрузки. Возможные значения: API.

Example: example
Example
{
  "uploading_id": "example",
  "datetime": "2025-01-01T00:00:00Z",
  "api_validation_status": "example",
  "elements_count": 0,
  "entity_type": "example",
  "uploading_format": "example",
  "uploading_source": "example"
}

No longer supported, please use an alternative and newer version.

Предыдущая
Формат данных о заказах
Следующая
Загрузка заказов (JSON)