Gets company zone.

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

Gets a company zone from reference book.

HTTP Request

GET https://courier.yandex.ru/api/v1/reference-book/companies/{company_id}/zones/{instance_id}\
?apikey={string}

Path Parameters

company_id *

integer

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

instance_id *

string

The ID of the company zone in reference book.

company_id *

integer

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

instance_id *

string

The ID of the company zone in reference book.

Query Parameters

apikey

string

Company's apikey.

apikey

string

Company's apikey.

Responses

Code 200

Company zone was received.

{
  "color_edge": string,
  "color_fill": string,
  "id": string,
  "number": string,
  "polygon": {
    "coordinates": [
      "array"
    ],
    "type": string
  }
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

color_edge

string

Zone edge color. Possible formats: #000000, rgb(0,0,0), black.

color_fill

string

Zone fill color. Possible formats: #000000, rgb(0,0,0), black.

id

string

Zone ID in reference book.

number

string

The number of the zone.

polygon

object

Polygon of the zone. Formats: Geojson according to specification RFC7946. Example: {"type":"Polygon","coordinates":[[[0.0,0.0],[2.2,2.2],[-1.1,1.1],[0.0,0.0]]]}

polygon.coordinates[] *

array

polygon.type *

string

Always equals Polygon

color_edge

string

Zone edge color. Possible formats: #000000, rgb(0,0,0), black.

color_fill

string

Zone fill color. Possible formats: #000000, rgb(0,0,0), black.

id

string

Zone ID in reference book.

number

string

The number of the zone.

polygon

object

Polygon of the zone. Formats: Geojson according to specification RFC7946. Example: {"type":"Polygon","coordinates":[[[0.0,0.0],[2.2,2.2],[-1.1,1.1],[0.0,0.0]]]}

polygon.coordinates[] *

array

polygon.type *

string

Always equals Polygon

Code 401

Authorization error. Make sure that the request header contains the correct OAuth token.

Code 403

You do not have access to this object.

Code 422

Incorrect input. The operation can't be performed.