Gets contractor number

Gets contractor number by its ID.

Request

GET

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

Path parameters

Name

Description

company_id*

Type: integer

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

contractor_company_id*

Type: integer

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

Responses

200 OK

Information about the contractor's number is received.

Body

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

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.