Information about delivery appointment
This technique is used for receiving information about delivery date and time appointed by the client (courier arrival), as well as about a possible new delivery address.
Request for receiving information about delivery appointment
To use it, send a GET-request to the URL:
Environment | URL |
---|---|
testing | https://api.edu.cdek.ru/v2/delivery/{uuid} |
production | https://api.cdek.ru/v2/delivery/{uuid} |
{uuid} – delivery date appointment identifier in CDEK information system.
Reply to receiving information about delivery appointment
The response body is returned in the JSON format:
No. | Tag/Attribute | Description | Field type | Mandatory |
---|---|---|---|---|
1 | entity | Data of the order over which request is sent | entity | no |
1.1 | uuid | Delivery date appointment identifier in Pintex | UUID | yes |
1.2 | cdek_number | CDEK order number | string | no |
1.3 | order_uuid | Order identifier in CDEK information system | UUID | yes |
1.4 | date | Delivery date agreed with the receiver | date | yes |
1.5 | time_from | Courier waiting start time (agreed with receiver) | time | no |
1.6 | time_to | Courier waiting end time (agreed with receiver) | time | no |
1.7 | comment | Note | string | no |
1.8 | delivery_point | New code of CDEK pickup point to where the parcel will be delivered (if needs to be changed) | string() | no |
1.9 | to_location | New delivery address (if needs to be changed) | location | no |
1.9.1 | code | CDEK location code ("List of Cities" method) | integer | no |
1.9.2 | fias_guid | Federal Information Address System unique code | UUID | no |
1.9.3 | postal_code | Postcode | string(255) | no |
1.9.4 | longitude | Longitude | float | no |
1.9.5 | latitude | Latitude | float | no |
1.9.6 | country_code | Country code in ISO_3166-1_alpha-2 format | string(2) | no |
1.9.7 | region | Region name | string(255) | no |
1.9.8 | region_code | Region code (CDEK register) | integer | no |
1.9.9 | sub_region | Subregion name | string(255) | no |
1.9.10 | city | City name | string(255) | no |
1.9.11 | kladr_code | All-Russian Classifier of Addresses code Deprecated field | string(255) | no |
1.9.12 | address | Address line | string(255) | no |
1.10 | statuses | Delivery appointment status | status[] | yes |
1.10.1 | code | Status code (see more in annex 1) | string() | yes |
1.10.2 | name | Status name | string() | yes |
1.10.3 | date_time | Date and time of status setting (format yyyy-MM-dd'T'HH:mm:ssZ) | datetime | yes |
2 | requests | Data on the request/requests over the order | request[] | yes |
2.1 | request_uuid | Request identifier in CDEK information system | UUID | no |
2.2 | type | Request type May take on values: CREATE, UPDATE, DELETE, AUTH, GET | string() | yes |
2.3 | state | Current status of the request ACCEPTED - pre-validation passed and request accepted | string() | yes |
2.4 | date_time | Date and time of setting current status of the request (format yyyy-MM-dd'T'HH:mm:ssZ) | datetime | yes |
2.5 | errors | Request processing errors | error[] | no |
2.5.1 | code | Error code | string() | yes |
2.5.2 | message | Error description | string() | yes |
2.6 | warnings | Request processing warnings | warning[] | no |
2.6.1 | code | Warning code | string() | yes |
2.6.2 | message | Warning description | string() | yes |
http://api.cdek.ru/v2/delivery/72753031-3d4b-42c4-8a87-53ecae1881e3 |
{ "entity": { "uuid": "72753031-3d4b-42c4-8a87-53ecae1881e3", "cdek_number": "1106207236", "order_uuid": "72753031-df04-44a4-bc60-11e8b5253b1d", "date": "2020-02-27", "time_from": "10:00", "time_to": "15:00", "comment": "Офис группы компаний Ланит ?", "delivery_point": "", "to_location": { "code": "137", "postal_code": "190000", "country_code": "RU", "fias_guid": "c2deb16a-0330-4f05-821f-1d09c93331e6", "kladr_code": "7800000000000", "country": "Россия", "region": "Санкт-Петербург", "region_code": "82", "sub_region": "Санкт-Петербург", "city": "Санкт-Петербург", "address": "г.Бердск ул.Ленина 16", "longitude": 30.3159, "latitude": 59.9391 }, "statuses": [ { "code": "ACCEPTED", "name": "Принята", "date_time": "2020-02-26T14:46:17.532+0700" }, { "code": "REGISTERED", "name": "Зарегистрирована", "date_time": "2020-02-26T14:46:19.281+0700" } ] }, "requests": [ { "request_uuid": "72753031-8ab1-4ed2-ab9c-363cce859817", "type": "CREATE", "state": "SUCCESSFUL", "date_time": "2020-02-26T14:46:19+0700", "errors": [], "warnings": [] } ] } |
Annex 1. Delivery appointment statuses
Status code | Status name | Note |
---|---|---|
ACCEPTED | Accepted | The appointment has been created in the CDEK information system, but additional check is required |
REGISTERED | Registered | The appointment has been successfully checked for the possibility of delivery at the specified time and to the specified place |
INVALID | Incorrect | The appointment contains incorrect information |
CANCEL | Cancelled | The appointment has been cancelled because of a new appointment |
This technique is used for receiving information about delivery date and time appointed by the client (courier arrival), as well as about a possible new delivery address.
Request for receiving information about delivery appointment
To use it, send a GET-request to the URL:
Environment | URL |
---|---|
testing | https://api.edu.cdek.ru/v2/delivery/{uuid} |
production | https://api.cdek.ru/v2/delivery/{uuid} |
{uuid} – delivery date appointment identifier in CDEK information system.
Reply to receiving information about delivery appointment
The response body is returned in the JSON format:
No. | Tag/Attribute | Description | Field type | Mandatory |
---|---|---|---|---|
1 | entity | Data of the order over which request is sent | entity | no |
1.1 | uuid | Delivery date appointment identifier in Pintex | UUID | yes |
1.2 | cdek_number | CDEK order number | string | no |
1.3 | order_uuid | Order identifier in CDEK information system | UUID | yes |
1.4 | date | Delivery date agreed with the receiver | time | yes |
1.5 | time_from | Courier waiting start time (agreed with receiver) | time | no |
1.6 | time_to | Courier waiting end time (agreed with receiver) | time | no |
1.7 | comment | Note | string | no |
1.8 | delivery_point | New code of CDEK pickup point to where the parcel will be delivered (if needs to be changed) | string() | no |
1.9 | to_location | New delivery address (if needs to be changed) | location | no |
1.9.1 | code | Location code (CDEK register) | string(255) | no |
1.9.2 | fias_guid | Federal Information Address System unique code | UUID | no |
1.9.3 | postal_code | Postcode | string(255) | no |
1.9.4 | longitude | Longitude | float | no |
1.9.5 | latitude | Latitude | float | no |
1.9.6 | country_code | Country code in ISO_3166-1_alpha-2 format | string(2) | no |
1.9.7 | region | Region name | string(255) | no |
1.9.8 | region_code | Region code (CDEK register) | integer | no |
1.9.9 | sub_region | Subregion name | string(255) | no |
1.9.10 | city | City name | string(255) | no |
1.9.11 | kladr_code | All-Russian Classifier of Addresses code | string(255) | no |
1.9.12 | address | Address line | string(255) | no |
1.10 | statuses | Delivery appointment status | status[] | yes |
1.10.1 | code | Status code (see more in annex 1) | string() | yes |
1.10.2 | name | Status name | string() | yes |
1.10.3 | date_time | Date and time of status setting (format yyyy-MM-dd'T'HH:mm:ssZ) | datetime | yes |
2 | requests | Data on the request/requests over the order | request[] | yes |
2.1 | request_uuid | Request identifier in CDEK information system | UUID | no |
2.2 | type | Request type May take on values: CREATE, UPDATE, DELETE, AUTH, GET | string() | yes |
2.3 | state | Current status of the request May take on values: ACCEPTED, WAITING, SUCCESSFUL, INVALID | string() | yes |
2.4 | date_time | Date and time of setting current status of the request (format yyyy-MM-dd'T'HH:mm:ssZ) | datetime | yes |
2.5 | errors | Request processing errors | error[] | no |
2.5.1 | code | Error code | string() | yes |
2.5.2 | message | Error description | string() | yes |
2.6 | warnings | Request processing warnings | warning[] | no |
2.6.1 | code | Warning code | string() | yes |
2.6.2 | message | Warning description | string() | yes |
http://api.cdek.ru/v2/delivery/72753031-3d4b-42c4-8a87-53ecae1881e3 |
{ "entity": { "uuid": "72753031-3d4b-42c4-8a87-53ecae1881e3", "cdek_number": "1106207236", "order_uuid": "72753031-df04-44a4-bc60-11e8b5253b1d", "date": "2020-02-27", "time_from": "10:00", "time_to": "15:00", "comment": "Офис группы компаний Ланит ?", "delivery_point": "", "to_location": { "code": "137", "postal_code": "190000", "country_code": "RU", "fias_guid": "c2deb16a-0330-4f05-821f-1d09c93331e6", "kladr_code": "7800000000000", "country": "Россия", "region": "Санкт-Петербург", "region_code": "82", "sub_region": "Санкт-Петербург", "city": "Санкт-Петербург", "address": "г.Бердск ул.Ленина 16", "longitude": 30.3159, "latitude": 59.9391 }, "statuses": [ { "code": "ACCEPTED", "name": "Принята", "date_time": "2020-02-26T14:46:17.532+0700" }, { "code": "REGISTERED", "name": "Зарегистрирована", "date_time": "2020-02-26T14:46:19.281+0700" } ] }, "requests": [ { "request_uuid": "72753031-8ab1-4ed2-ab9c-363cce859817", "type": "CREATE", "state": "SUCCESSFUL", "date_time": "2020-02-26T14:46:19+0700", "errors": [], "warnings": [] } ] } |
Annex 1. Delivery appointment statuses
Status code | Status name | Note |
---|---|---|
ACCEPTED | Accepted | The appointment has been created in the CDEK information system, but additional check is required |
REGISTERED | Registered | The appointment has been successfully checked for the possibility of delivery at the specified time and to the specified place |
INVALID | Incorrect | The appointment contains incorrect information |
CANCEL | Cancelled | The appointment has been cancelled because of a new appointment |
© 2000—2023, Курьерская компания СДЭК