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

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

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

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

Примечание

Для одного клиента можно передать не более 100 000 заказов.

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

--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
                }
            }
        ]
}'

Request

POST

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

Path parameters

Name

Description

counterId*

Type: integer<int32>

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

Query parameters

Name

Description

merge_mode*

Type: string

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

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

Body

application/json

{
    "orders": [
        {
            "attribute_values": [
                {}
            ],
            "revenue": 0,
            "cost": 0,
            "currency": "string",
            "goals": [
                {
                    "goal_action_id": "string",
                    "price": 0
                }
            ],
            "create_date_time": "2022-12-29T18:02:01Z",
            "id": "string",
            "client_uniq_id": "string",
            "client_type": "string",
            "update_date_time": "2022-12-29T18:02:01Z",
            "finish_date_time": "2022-12-29T18:02:01Z",
            "order_status": "string",
            "products": {},
            "user_comment": "string"
        }
    ]
}

Name

Description

orders*

Type: OrderRow[]

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

Min items: 1

OrderRow

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

Name	Description
client_type*	Type: string Тип клиента, к которому относится данный заказ. Возможные значения: `CONTACT` — контакт. `COMPANY` — компания.
client_uniq_id*	Type: string Идентификатор клиента (`uniq_id`), к которому относится данный заказ. Min length: `1`
create_date_time*	Type: string<date-time> Дата и время создания заказа в часовом поясе счетчика. Значение нельзя менять.
id*	Type: string Идентификатор заказа. Min length: `1`
order_status*	Type: string Идентификатор статуса заказа. Произвольная строка. Статус можно менять. Укажите значение, которое вы передавали при сопоставлении статусов в поле id. Min length: `1`
attribute_values	Type: object[] Пользовательские атрибуты.
cost	Type: number Расходы. Max value: `9223372036854`
currency	Type: string Валюта заказа в стандарте ISO 4217.
finish_date_time	Type: string<date-time> Дата и время завершения заказа в часовом поясе счетчика.
goals	Type: CdpGoalExternal[] Цели и их стоимости в заказе. Min items: `0` Max items: `100`
products	Type: object Товары в заказе.
revenue	Type: number Доход. Суммарная стоимость заказа. Max value: `9223372036854`
update_date_time	Type: string<date-time> Дата и время обновления заказа в часовом поясе счетчика. Если параметр не передан, значение подставляется автоматически.
user_comment	Type: string Комментарий к заказу. Min length: `0` Max length: `1000`

CdpGoalExternal

Цели и их стоимости в заказе.

Name

Description

goal_action_id*

Type: string

Идентификатор JS-цели.

price

Type: number

Стоимость цели в заказе.

Responses

200 OK

Body

application/json

{
    "uploading": {
        "uploading_id": "string",
        "datetime": "2022-12-29T18:02:01Z",
        "api_validation_status": "string",
        "elements_count": 0,
        "entity_type": "string",
        "uploading_format": "string",
        "uploading_source": "string"
    }
}

Name

Description

uploading

Type: UploadingMetaExternal

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

UploadingMetaExternal

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

Name	Description
api_validation_status	Type: string Статус валидации загрузки: `PASSED` — валидация прошла успешно. `FAILED` — валидация прошла не успешно.
datetime	Type: string<date-time> Время загрузки.
elements_count	Type: integer<int32> Количество элементов в загрузке.
entity_type	Type: string Тип сущности: `SYSTEM` — системная сущность, например, контакты или заказы. `CUSTOM_LIST` — пользовательский список. `SYSTEM_LIST` — системный список, например товары.
uploading_format	Type: string Формат загрузки. Возможные значения: `JSON`. `CSV`.
uploading_id	Type: string Идентификатор загрузки.
uploading_source	Type: string Источник загрузки. Возможные значения: `API`.

Была ли статья полезна?

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

Создание атрибутов