Details of a Courier Invitation
This method is used to load details of a given courier invitation.
Request for Details of a Courier Invitation
In order to use this process, a GET request should be sent to URL:
Environment | URL |
testing | |
production |
{uuid} is the CDEK IS identifier of the courier invitation, details of which are required.
Response to the Request for Details of Courier Invitation
The response body is returned in the JSON format:
No. | Field name | Description | Field type | Mandatory (yes/no) |
1 | entity | Data of the courier invitation over which request is sent | no | |
1.1 | uuid | Invitation identifier in the CDEK IS | UUID | yes |
1.2 | intake_number | CDEK courier invitation number | long | no |
1.3 | cdek_number | CDEK order number | long | no |
1.4 | order_uuid | Order identifier in the CDEK IS | UUID | no |
1.5 | intake_date | Date of courier waiting | date (yyyy- MM-dd) | yes |
1.6 | intake_time_from | Start time of courier waiting | time | yes |
1.7 | intake_time_to | End time of courier waiting | time | yes |
1.8 | lunch_time_from | The lunch start time, should be included in the interval [intake_time_to;intake_time_to] | time | no |
1.9 | lunch_time_to | The lunch end time, should be included in the interval [intake_time_to;intake_time_to] | time | no |
1.10 | name | Cargo description | string | no |
1.11 | weight | Total weight (in grams) | integer | no |
1.12 | length | Package dimensions. Length (in centimeters) | integer | no |
1.13 | width | Package dimensions. Width (in centimeters) | integer | no |
1.14 | height | Package dimensions. Height (in centimeters) | integer | no |
1.15 | comment | Comment for the courier invitation | string(255) | no |
1.16 | sender | Sender | contact | no |
1.16.1 | company | Name of sender's company | string(255) | no |
1.16.2 | name | Contact person's full name | string(255) | yes |
1.16.3 | phones | List of phones No more than 10 numbers | phone[] | yes |
1.16.3.1 | number | Phone number | string(24) | yes |
1.16.3.2 | additional | Additional information (additional number) | string(255) | no |
1.17 | from_location | Sender's address (pickup's address) | location | yes |
1.17.1 | code | CDEK location code ("List of Cities" method) | integer | yes |
1.17.2 | fias_guid | FIAS unique identifier | UUID | no |
1.17.3 | postal_code | Postal code | string(255) | no |
1.17.4 | longitude | Longitude | float | no |
1.17.5 | latitude | Latitude | float | no |
1.17.6 | country_code | Country code (two-letter code from the international directory) | string(2) | yes |
1.17.7 | region | Region name | string(255) | no |
1.17.8 | sub_region | Name of region's district | string(255) | no |
1.17.9 | city | City name | string(255) | yes |
1.17.10 | kladr_code | KLADR (Russian Classifier of Addresses) code Deprecated field | string(255) | no |
1.17.11 | address | Address string | string(255) | yes |
1.18 | need_call | Notification calls to the sender are required (default value: false) | boolean | no |
1.19 | statuses | Courier invitation status | status[] | yes |
1.19.1 | code | Status code (for more details, see Appendix 1) | string() | yes |
1.19.2 | name | Status name | string() | yes |
1.19.3 | date_time | Date and time of status setting (format yyyy-MM- dd'T'HH:mm:ssZ) | datetime | yes |
1.20 | courier_power_of_attorney | The courier needs a power of attorney (default value - false) | boolean | no |
1.21 | courier_identity_card | The courier needs an identity document (default value - false) | boolean | no |
2 | requests | Data on the request/requests over the courier Invitation | 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 |
https://api.cdek.ru/v2/intakes/72753031-0525-4aa4-9629-d6ae52e825f5 |
{ "entity": { "uuid": "72753031-157e-4fad-8a96-c36742ba4f15", "intake_date": "2020-02-07", "intake_number": "13271458", "intake_time_from": "10:00", "intake_time_to": "17:00", "lunch_time_from": "14:00", "lunch_time_to": "15:00", "name": "Покемоны", "weight": 1000, "length": 10, "width": 10, "height": 10, "comment": "Hello, World", "sender": { "company": "", "name": "Князев Олег Борисович", "phones": [ { "number": "+79589441654" } ], "tin": "1234567890" }, "from_location": { "code": "44", "postal_code": "109004", "country_code": "RU", "fias_guid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "kladr_code": "7700000000000", "country": "Россия", "region": "Москва", "region_code": "81", "sub_region": "Москва", "city": "Москва", "address": "ул. Блюхера, 32", "longitude": 37.6204, "latitude": 55.754 }, "need_call": false, "statuses": [ { "code": "ACCEPTED", "name": "Принят", "date_time": "2020-02-06T12:02:28+0700" }, { "code": "CREATED", "name": "Создан", "date_time": "2020-02-06T12:02:28+0700" } ] }, "requests": [ { "request_uuid": "72753031-cd57-47ad-a3a6-9efd153fcc4c", "type": "CREATE", "state": "SUCCESSFUL", "date_time": "2020-02-06T12:02:27+0700", "errors": [], "warnings": [] } ] } |
Appendix 1. Courier Invitation Statuses
Code | Status name | Comment |
ACCEPTED | Accepted | The courier invitation has been created in the CDEK information system, but additional validations are required. |
CREATED | Created | The courier invitation has been registered in the CDEK information system and passed the necessary validations. |
REMOVED | Deleted | The courier invitation has been canceled by the IS after having been registered in the system. |
READY_FOR_APPOINTMENT | Ready for appointment | The courier invitation is ready for appointment |
APPOINTED_COURIER | Courier appointed | Courier assigned upon request |
DONE | Completed | The courier invitation completed |
PROBLEM_DETECTED | Problem identified | Problem identified on request |
PROCESSING_REQUIRED | Requires processing | The courier invitation was created in the CDEK information system, but additional processing is required |
INVALID | Incorrect courier invitation | The courier invitation contains incorrect data. |
© 2000—2024, Курьерская компания СДЭК