Order status mapping

Mapping of order statuses from a CRM to status types in Yandex Metrica.

Sample request body

--data '{
    "order_statuses": [
        {
            "id": "new",
            "humanized": "New",
            "type": "IN_PROGRESS"
        },
        {
            "id": "prepairing",
            "humanized": "Processing",
            "type": "IN_PROGRESS"
        },
        {
            "id": "delivery",
            "humanized": "Out of delivery",
            "type": "IN_PROGRESS"
            "goal_action_ids": "dostavka"
        },
        {
            "id": "cancelled_by_client",
            "humanized": "Canceled by customer",
            "type": "CANCELLED"
        },
        {
            "id": "cancelled_by_shop",
            "humanized": "Canceled by shop",
            "type": "CANCELLED",
            "goal_action_ids": "otmena"

        },
        {
            "id": "test_order",
            "humanized": "Test order",
            "type": "SPAM",
            "goal_action_ids": "proverka"
        },
        {
            "id": "success",
            "humanized": "Completed successfully",
            "type": "PAID"
        }
    ]
}'

Request

POST

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

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`

Responses

200 OK

Body

application/json

{
    "success": true
}

Name

Description

success

Type: boolean

Result of performing the action.

Default: true

Was the article helpful?

How to map order statuses

List of mapped order statuses