Gets contractor number

  1. HTTP Request
  2. Path Parameters
  3. Responses
    1. Code 200
      1. Representation
      2. Fields
    2. Code 401
    3. Code 403
    4. Code 422

Gets contractor number by its ID.

HTTP Request

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

Path Parameters

company_id *

integer

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

contractor_company_id *

integer

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

company_id *

integer

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

contractor_company_id *

integer

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

Responses

Code 200

Information about the contractor's number is received.

{
  "id": integer,
  "number": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

number *

string

Company number.

id

integer

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

number *

string

Company number.

id

integer

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

Code 401

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

Code 403

You do not have access to this object.

Code 422

Incorrect input.