Список сопоставленных статусов заказов

Возвращает список сопоставленных статусов заказа из CRM c типами статусов в Метрике.

Типы статусов нужны для привязки статусов заказов к визитам и отображения статистики по статусам.

В отчетах по визитам будут отображаться типы статусов, предопределенные Метрикой. Ваши названия статусов будут доступны в отчете Посетители и Клиенты — Клиенты.

Request

GET

https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/schema/order_statuses

Path parameters

Name

Description

counterId*

Type: integer<int32>

Идентификатор счетчика.
Example: 2215573

Responses

200 OK

Body

application/json

{
    "order_statuses": [
        {
            "id": "string",
            "humanized": "string",
            "type": "string",
            "goal_action_ids": [
                "string"
            ]
        }
    ]
}

Name

Description

order_statuses*

Type: OrderStatus[]

Список статусов заказов.
Описание объекта OrderStatus.

OrderStatus

Описание объекта OrderStatus.

Name	Description
id*	Type: string Идентификатор статуса заказа. Min length: `1` Max length: `255` Pattern: `^[\w-:]+$`
type*	Type: string Семантика статуса: `IN_PROGRESS` — в работе. `PAID` — оплачен. `CANCELLED` — отменен. `SPAM` — спам. `OTHER` — другое.
goal_action_ids	Type: string[] Идентификаторы целей Min items: `0` Max items: `10` Unique items
humanized	Type: string Название статуса заказа. Min length: `0` Max length: `4096`

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

Сопоставление статусов заказов

Формат данных о клиентах