List of mapped order statuses

Returns a list of order statuses from the CRM mapped to status types in Yandex Metrica.

Status types are required for matching order statuses to sessions and displaying statistics by status.

The session reports display status types predefined in Yandex Metrica. Custom status names will be available in the Users and customersCustomers report.

Request

GET

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

Path parameters

Name

Description

counterId*

Type: integer<int32>

Counter ID.
Example: 2215573

Responses

200 OK

OK

Body

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

Name

Description

order_statuses*

Type: OrderStatus[]

List of order statuses.
Description of the OrderStatus object.

OrderStatus

Description of the OrderStatus object.

Name

Description

id*

Type: string

Order status ID.

Min length: 1

Max length: 255

Pattern: ^[\w-:]+$

type*

Type: string

Status semantics:

  • IN_PROGRESS: In progress.
  • PAID: Paid.
  • CANCELLED: Canceled.
  • SPAM: Spam.
  • OTHER: Other.

goal_action_ids

Type: string[]

Goal IDs

Min items: 0

Max items: 10

humanized

Type: string

Order status name.

Min length: 0

Max length: 4096