---
metadata:
  - name: generator
    content: Diplodoc Platform v5.54.1
alternate:
  - https://yandex.com/dev/metrika/en/management/openapi/schema/getOrderStatuses.md
  - https://yandex.com/dev/metrika/ru/management/openapi/schema/getOrderStatuses.md
  - href: en/management/openapi/schema/getOrderStatuses.md
    type: text/markdown
    title: Markdown version
  - href: ../../../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/metrika/en/llms.txt

<!-- source: en/management-src/Managing-customer-and-order-data-from-the-CRM/getOrderStatuses.md -->
<div class="openapi">

# List of mapped order statuses

<!-- markdownlint-disable-file -->

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

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-get);margin-bottom: 12px">

<div class="openapi__request">

GET {.openapi__method}
```text translate=no
https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/schema/order_statuses
```

</div>

</div>

</div>

### Path parameters

#|
|| **Name** | **Description** ||
||

_counterId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Tag ID.
{.table-cell}
||
|#{.json-schema-properties}

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "order_statuses": [
    {
      "id": "example",
      "humanized": "example",
      "type": "example",
      "goal_action_ids": [
        "example"
      ]
    }
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_order_statuses_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrderStatus](#entity-OrderStatus)[]

List of order statuses.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "example",
    "humanized": "example",
    "type": "example",
    "goal_action_ids": [
      "example"
    ]
  }
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### OrderStatus {#entity-OrderStatus}

Description of the `OrderStatus` object.

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Order status ID.

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Max length:_{.json-schema-reset .json-schema-assertion} `255`

_Pattern:_{.json-schema-reset .json-schema-assertion} `^[\w-:]+$`

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Status semantics:
- `IN_PROGRESS`: In progress.
- `PAID`: Paid.
- `CANCELLED`: Canceled.
- `SPAM`: Spam.
- `OTHER`: Other.


_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_goal_action_ids_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[]

_Min items:_{.json-schema-reset .json-schema-assertion} `0`

_Max items:_{.json-schema-reset .json-schema-assertion} `10`

_Unique items:_{.json-schema-reset .json-schema-assertion} `true`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_humanized_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Order status name.

_Min length:_{.json-schema-reset .json-schema-assertion} `0`

_Max length:_{.json-schema-reset .json-schema-assertion} `4096`

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "humanized": "example",
  "type": "example",
  "goal_action_ids": [
    "example"
  ]
}
```

{% endcut %}

</div>

</div>

</div>
<!-- endsource: en/management-src/Managing-customer-and-order-data-from-the-CRM/getOrderStatuses.md -->

[*Deprecated]: No longer supported, please use an alternative and newer version.