Adds company zones to reference book
Adds company zone to reference book. If company zone with specified number already exists updates its data. Maximal number of zones — 500.
Request
POST
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. |
Headers
|
Name |
Description |
|
Authorization* |
Type: string User's JWT. |
Body
application/json
[
{
"id": "string",
"number": "string",
"color_fill": "string",
"color_edge": "string",
"polygon": {
"coordinates": [
[
[
0
]
]
],
"type": "string"
}
}
]
ZoneReferenceList
|
Name |
Description |
|
number* |
Type: string The number of the zone. Max length: |
|
polygon* |
Type: GeojsonPolygon Polygon of the zone. Formats: Geojson according to specification RFC7946. Example: |
|
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. |
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: Min items: Max items: Min items: Max items: Min items: |
|
type* |
Type: string Always equals |
Responses
200 OK
Company zones was added.
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.
No longer supported, please use an alternative and newer version.