Get withourier invitation
Gets withourier invitation by UUID
- Parameters
- Advanced call ?
Function GetCourierInvitation(Val Token, Val UUID, Val TestAPI = False) Export
| Parameter | CLI option | Type | Required | Description |
|---|---|---|---|---|
| Token | --token | String | ✔ | Auth token |
| UUID | --uuid | String | ✔ | UUID of the invitation |
| TestAPI | --testapi | Boolean | ✖ | Flag to use test API for requests |
Returns
Map Of KeyAndValue - serialized JSON response from CDEK
| Parameter | Description |
|---|---|
| proxy | InternetProxy or a structure with fields Protocol, Host, Port, User, Password, UseOSAuthentication |
| timeout | Request execution timeout |
| adv_response | Formats the response as a complete HTTP structure with fields code, body, and headers |
| retries | Number of HTTP request send attempts on 5** status codes or internal client errors |
| dontwait | Creates a background job and returns its data (for 1C and OneScript only) |
tip
The invitation must be previously created. See CreateCourierInvitation
Method at API documentation: [Details of a courier invitation(https://api-docs.cdek.ru/33828865.html)
1C:Enterprise/OneScript code example
Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3NjE5MTU3NDQsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJhY2NvdW50LWxhbmc6cnVzIiwiY29udHJhY3Q60JjQnC3QoNCkLdCT0JvQky0yMiIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L...";
UUID = "33cdf7bf-7b9e-4a4f-aaf6-6acb86b4639a";
Result = OPI_CDEK.GetCourierInvitation(Token, UUID, True);
- Bash
- CMD/Bat
oint cdek GetCourierInvitation \
--token "***" \
--uuid "c4ba0628-da21-4d99-a369-ce687c1ffd37" \
--testapi "***"
oint cdek GetCourierInvitation ^
--token "***" ^
--uuid "c4ba0628-da21-4d99-a369-ce687c1ffd37" ^
--testapi "***"
Result
{
"entity": {
"uuid": "c4ba0628-da21-4d99-a369-ce687c1ffd37",
"cdek_number": "1109134787",
"order_uuid": "de3ffd2c-4cc1-499c-b125-cb0496519569",
"intake_date": "2026-05-27",
"intake_number": "13312109",
"intake_time_from": "10:00",
"intake_time_to": "17:00",
"name": "Consolidated cargo",
"weight": 1000,
"length": 10,
"width": "***",
"height": 10,
"comment": "Comment to courier",
"sender": {
"company": "Company",
"name": "Company",
"contragent_type": "LEGAL_ENTITY",
"phones": [
{
"number": "79589441654"
}
],
"passport_requirements_satisfied": "***"
},
"from_location": {
"code": 44,
"city_uuid": "7e8f36ba-d937-4ce4-8d53-e44177db6469",
"city": "Москва",
"fias_guid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"country_code": "RU",
"country": "Россия",
"region": "Москва",
"region_code": 81,
"sub_region": "Москва",
"longitude": 37.61556,
"latitude": 55.75222,
"address": "st. Bluchera, 32"
},
"to_location": {
"code": 44,
"city_uuid": "7e8f36ba-d937-4ce4-8d53-e44177db6469",
"city": "Москва",
"country_code": "RU",
"country": "Россия",
"region": "Москва",
"region_code": 81,
"longitude": 37.831928,
"latitude": 55.644399,
"address": "Россия, Москва, Москва, ул. Энергетиков, 22 корп. 2",
"postal_code": "140091"
},
"need_call": false,
"statuses": [
{
"code": "READY_FOR_APPOINTMENT",
"name": "Готова к назначению",
"date_time": "2026-05-26T14:20:36+00:00"
},
{
"code": "CREATED",
"name": "Создан",
"date_time": "2026-05-26T14:20:36+00:00"
},
{
"code": "ACCEPTED",
"name": "Принят",
"date_time": "2026-05-26T14:20:36+00:00"
}
],
"packages": [
{
"package_id": "7f566631-a287-434f-89b4-5d069e2d081e",
"weight": 1000,
"length": 10,
"width": "***",
"height": 10
}
]
},
"requests": [
{
"request_uuid": "ee9a2a95-9bc0-4ab5-becd-753c47493472",
"type": "CREATE",
"date_time": "2026-05-26T14:20:35+00:00",
"state": "SUCCESSFUL"
}
]
}