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 reports display status types predefined in Yandex Metrica.

  1. Request syntax
  2. Response format

Request syntax

counterId: Tag ID.

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

Response format


{
    "order_statuses" : [ {
        "id" :  < string > ,
        "humanized" :  < string > ,
        "type" :  < _order_status_type > ,
        "goal_action_ids" :  < string > ,
        "source" :  < _order_status_source > 
    }, ... ]
}
Parameters Description
order_statuses List of order statuses.
order_statuses
id Order status ID.
humanized Order status name.
type Status type.

Possible values:

  • IN_PROGRESS: In progress
  • PAID: Paid
  • CANCELED: Canceled
  • SPAM: Spam
  • OTHER: Other
goal_action_ids Goal IDs.
source Indicates how the status was created.

Possible values:

  • USER: Created by a user.
  • BITRIX: Created when importing data from Bitrix.
  • AUTO: Created automatically.
Parameters Description
order_statuses List of order statuses.
order_statuses
id Order status ID.
humanized Order status name.
type Status type.

Possible values:

  • IN_PROGRESS: In progress
  • PAID: Paid
  • CANCELED: Canceled
  • SPAM: Spam
  • OTHER: Other
goal_action_ids Goal IDs.
source Indicates how the status was created.

Possible values:

  • USER: Created by a user.
  • BITRIX: Created when importing data from Bitrix.
  • AUTO: Created automatically.