Gets company zone reference book

Gets company zone reference book.

Request

GET

https://courier.yandex.ru/api/v1/reference-book/companies/{company_id}/zones

Path parameters

Name

Description

company_id*

Type: integer

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

Query parameters

Name

Description

page

Type: integer

Page number where the entity is stored in the database. Each page contains per_page entities arranged in ascending route.

Default: 1

Min value: 1

per_page

Type: integer

Number of company zone per page.

Default: 100

Min value: 1

Max value: 300

Responses

200 OK

Company zones references was received.

Body

application/json
[
    {
        "id": "string",
        "number": "string",
        "color_fill": "string",
        "color_edge": "string",
        "polygon": {
            "coordinates": [
                [
                    [
                        0
                    ]
                ]
            ],
            "type": "string"
        }
    }
]

ZoneReferenceWithNoNumberLimit[]

ZoneReferenceWithNoNumberLimit

Name

Description

color_edge

Type: string

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

color_fill

Type: string

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

id

Type: string

Zone ID in reference book.

number

Type: string

The number of the zone.

polygon

Type: GeojsonPolygon

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]]]}.

GeojsonPolygon

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]]]}.

Name

Description

coordinates*

Type: number[][][]

Always consists of two elements: longitude and lattitude.

Max items: 2

Min items: 2

Max items: 1000

Min items: 1

Max items: 1000

Min items: 1

type*

Type: string

Always equals Polygon

401 Unauthorized

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

403 Forbidden

You do not have access to this object.

422 Unprocessable Entity

Incorrect input. The operation can't be performed.