List of mapped order statuses

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

You need status types to connect order statuses to sessions and to see statistics broken down by status.

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

Request

GET

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

Path parameters

Name

Description

counterId

Type: integer

Counter ID.

Responses

200 OK

Body

application/json

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

Name

Description

order_statuses

Type: OrderStatus[]

List of order statuses.

Example

[
  {
    "id": "example",
    "humanized": "example",
    "type": "example",
    "goal_action_ids": [
      "example"
    ],
    "order_status_source": "example"
  }
]

OrderStatus

Description of the OrderStatus object.

Name	Description
id	Type: string Order status ID. Min length: `1` Max length: `255` Pattern: `^[\w-:]+$` Example: `example`
type	Type: string Status semantics: `IN_PROGRESS`: In progress. `PAID`: Paid. `CANCELLED`: Canceled. `SPAM`: Spam. `OTHER`: Other. Example: `example`
goal_action_ids	Type: string[] Min items: `0` Max items: `10` Unique items: `true` Example `[ "example" ]`
humanized	Type: string Order status name. Min length: `0` Max length: `4096` Example: `example`

Example

{
  "id": "example",
  "humanized": "example",
  "type": "example",
  "goal_action_ids": [
    "example"
  ]
}

Was the article helpful?

Order status mapping

Customer data format