Gets multiple contractor numbers

Gets a list of contractors in the company.

Request

GET

https://courier.yandex.ru/api/v1/companies/{company_id}/numbers

Path parameters

Name

Description

company_id*

Type: integer

The ID of the company that is used in requests to the Track & Trace API.

Responses

200 OK

Returns a list of contractors with corresponding numbers.

Body

application/json
[
    {
        "number": "string",
        "name": "string",
        "id": 0
    }
]

CompanyNumber[]

CompanyNumber

Name

Description

number*

Type: string

Company number.

id

Type: integer

Company ID used in requests to the Track & Trace API.

name

Type: string

Company name.

Max length: 80

401 Unauthorized

Authorization failed. Send the correct OAuth token in the authorization header.

403 Forbidden

You do not have access to this object.

422 Unprocessable Entity

Incorrect input.