Gets company zone

Gets a company zone from reference book.

Request

GET

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

Path parameters

Name

Description

company_id*

Type: integer

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

instance_id*

Type: string

The ID of the company zone in reference book.

Responses

200 OK

Company zone was received.

Body

application/json

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

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.