Gets company zone reference book

HTTP Request

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

Path Parameters

company_id *

integer

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

* Required parameter

Query Parameters

apikey	string Company's apikey.
page	integer Page number where the entity is stored in the database. Each page contains per_page entities arranged in ascending route. Minimum value: `1`. Default value: `1`.
per_page	integer Number of company zone per page. Minimum value: `1`. Maximum value: `300`. Default value: `100`.

* Required parameter

Responses

Code 200

Company zones references 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`

* Required parameter

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.