Page tree
Skip to end of metadata
Go to start of metadata

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:

{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)

1entityData of the courier invitation over which request is sent
no

1.1

uuidInvitation identifier in the CDEK ISUUIDyes

1.2

intake_numberCDEK courier invitation numberlongno

1.3

cdek_numberCDEK order numberlongno

1.4

order_uuidOrder identifier in the CDEK ISUUIDno

1.5

intake_dateDate of courier waitingdate (yyyy- MM-dd)yes

1.6

intake_time_fromStart time of courier waitingtimeyes

1.7

intake_time_toEnd time of courier waitingtimeyes

1.8

lunch_time_fromThe lunch start time, should be included in the interval [intake_time_to;intake_time_to]timeno

1.9

lunch_time_toThe lunch end time, should be included in the interval [intake_time_to;intake_time_to]timeno

1.10

nameCargo descriptionstringno

1.11

weightTotal weight (in grams)integerno

1.12

lengthPackage dimensions. Length (in centimeters)integerno

1.13

widthPackage dimensions. Width (in centimeters)integerno

1.14

heightPackage dimensions. Height (in centimeters)integerno

1.15

commentComment for the courier invitationstring(255)no

1.16

senderSendercontactno

1.16.1

companyName of sender's companystring(255)no

1.16.2

nameContact person's full namestring(255)yes

1.16.3

phones

List of phones

No more than 10 numbers
phone[]yes

1.16.3.1

numberPhone numberstring(24)yes

1.16.3.2

additionalAdditional information (additional number)string(255)no

1.17

from_locationSender's address (pickup's address)locationyes

1.17.1

codeCDEK location code ("List of Cities" method)integeryes

1.17.2

fias_guidFIAS unique identifierUUIDno

1.17.3

postal_codePostal codestring(255)no

1.17.4

longitudeLongitudefloatno

1.17.5

latitudeLatitudefloatno

1.17.6

country_codeCountry code (two-letter code from the international directory)string(2)yes

1.17.7

regionRegion namestring(255)no

1.17.8

sub_regionName of region's districtstring(255)no

1.17.9

cityCity namestring(255)yes

1.17.10

kladr_code

KLADR (Russian Classifier of Addresses) code

Deprecated field

string(255)no

1.17.11

addressAddress stringstring(255)yes

1.18

need_callNotification calls to the sender are required (default value: false)booleanno

1.19

statusesCourier invitation statusstatus[]yes

1.19.1

codeStatus code (for more details, see Appendix 1)string()yes

1.19.2

nameStatus namestring()yes

1.19.3

date_timeDate and time of status setting (format yyyy-MM- dd'T'HH:mm:ssZ)datetimeyes
2requestsData on the request/requests over the courier Invitationrequest[]yes
2.1request_uuidRequest identifier in CDEK information systemUUIDno
2.2typeRequest type
May take on values: CREATE, UPDATE, DELETE, AUTH, GET
string()yes
2.3state

Current status of the request
May take on values: 

ACCEPTED - pre-validation passed and request accepted
WAITING - the request is awaiting processing (depends on the execution of another request)
SUCCESSFUL - the request was processed successfully
INVALID - the request was processed with an error

string()yes
2.4date_timeDate and time of setting current status of the request (format yyyy-MM-dd'T'HH:mm:ssZ)datetimeyes
2.5errorsRequest processing errorserror[]no
2.5.1codeError codestring()yes
2.5.2messageError descriptionstring()yes
2.6warningsRequest processing warningswarning[]no
2.6.1codeWarning codestring()yes
2.6.2messageWarning descriptionstring()yes


Sample Request
https://api.cdek.ru/v2/intakes/72753031-0525-4aa4-9629-d6ae52e825f5
Sample Response
{
    "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

ACCEPTEDAcceptedThe courier invitation has been created in the CDEK information system, but additional validations are required.
CREATEDCreatedThe courier invitation has been registered in the CDEK information system and passed the necessary validations.
REMOVEDDeletedThe courier invitation has been canceled by the IS after having been registered in the system.
READY_FOR_APPOINTMENTReady for appointmentThe courier invitation is ready for appointment
APPOINTED_COURIERCourier appointedCourier assigned upon request
DONECompletedThe courier invitation completed
PROBLEM_DETECTEDProblem identifiedProblem identified on request
PROCESSING_REQUIREDRequires processingThe courier invitation was created in the CDEK information system, but additional processing is required
INVALIDIncorrect courier invitationThe courier invitation contains incorrect data.



  • No labels