Details of pre-alert document

The method is used to load details of a given pre-alert document.

Request for Details of Pre-alert document

To use it, sent a GET-request to the URL:

Environment	URL
testing	https://api.edu.cdek.ru/v2/prealert/{uuid}
production	https://api.cdek.ru/v2/prealert/{uuid}

{uuid} is the CDEK IS identifier of pre-alert document, details of which are required.

Response to the Request for Details of Pre-alert document

The response body is returned in the JSON format:

No.	Field name	Description	Field type	Mandatory (yes/no)
1	entity	Data of pre-alert document over which request is sent		no
1.1	uuid	Pre-alert document identifier in the CDEK IS	UUID	yes
1.2	prealert_number	Pre-alert document number in the CDEK IS	string()	no
1.3	planned_date	Planned date of transmit of orders to CDEK	dateTime	yes
1.4	shipment_point	Code of the CDEK pickup point to which orders will be transmit	string()	yes
1.5	orders	Orders which will be transmit to CDEK	[ ]	yes
1.5.1	order_uuid	Order identifier in the CDEK IS	UUID	yes
1.5.2	cdek_number	CDEK order number	long	yes
1.5.3	im_number	Order number in the Client IS	string(40)	yes
2	requests	Data on the request/requests over the pre-alert document	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 - 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.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/prealert/72753031-9c28-4ce6-889f-4ef99008a0e4

{
    "entity": {
        "uuid": "72753031-9c28-4ce6-889f-4ef99008a0e4",
        "prealert_number": "PA/1305/386",
        "planned_date": "2021-08-03T13:08:49+0000",
        "shipment_point": "NSK27",
        "orders": [
            {
                "order_uuid": "72753031-924c-4db8-b158-9a5148fc3e83",
                "cdek_number": 1107487669,
                "im_number": "1627452531640"
            },
            {
                "order_uuid": "72753031-bce5-4f06-801a-45c047f94269",
                "cdek_number": 1107487670,
                "im_number": "1627452533178"
            },
            {
                "order_uuid": "72753031-7657-4d64-81a8-ff00c0870d25",
                "cdek_number": 1107487671,
                "im_number": "1627452534559"
            }
        ]
    },
    "requests": [
        {
            "request_uuid": "cf1bbbdc-0a3b-4bcd-8495-aa2f0a759a38",
            "type": "CREATE",
            "date_time": "2021-07-30T14:09:09+0700",
            "state": "SUCCESSFUL"
        }
    ]
}