Passport data information

The method is used to get information about passport data (informs about the ready to transfer orders to customs) for an international order / orders.

Request for Passport Data Information

In order to use this process, a GET request should be sent to URL:

Environment	URL
testing	https://api.edu.cdek.ru/v2/passport
production	https://api.cdek.ru/v2/passport

Request Parameters

The following parameters are supported:

No.	Field name	Description	Field type	Mandatory (yes/no)
1	order_uuid	Order identifier in CDEK information system	UUID [ ]	yes, if cdek_number isn't specified
2	cdek_number	CDEK order number	long [ ]	yes, if order_uuid isn't specified
3	client	Client for which information about passport data will be returned: sender, recipient If the value is not specified, then information about passport data will be returned both for the sender and by the recipient	string	no

No.

Field name

Description

Field type

Mandatory

(yes/no)

order_uuid

Order identifier in CDEK information system

UUID [ ]

yes, if cdek_number isn't specified

cdek_number

CDEK order number

long [ ]

yes, if order_uuid isn't specified

client

Client for which information about passport data will be returned: sender, recipient

If the value is not specified, then information about passport data will be returned both for the sender and by the recipient

string

Response to the Request for Passport Data Information

The response body is returned in the JSON format:

No.	Field name	Description	Field type	Mandatory (yes/no)
1	orders	List of orders	order [ ]	no
1.1	order_uuid	Order identifier in CDEK information system	UUID	yes
1.2	cdek_number	CDEK order number	long	yes
1.3	passport	Passport data information	passport [ ]	yes
1.3.1	client	The client for whom information about passport data was returned: sender, recipient	string	yes
1.3.2	passport_requirements_satisfied	Requirements for passport data are satisfied (actual for international orders): true - passport data is collected or not required false - passport data is required and not collected	boolean	yes
2	errors	Request processing errors	error [ ]	no
2.1	code	Error code	string()	yes
2.2	message	Error description	string()	yes
3	warnings	Request processing warnings	warning[ ]	no
3.1	code	Warning code	string()	yes
3.2	message	Warning description	string()	yes

https://api.cdek.ru/v2/passport?order_uuid=72753031-e460-49ab-add6-030ddba1bc94

{
  "orders": [
    {
      "order_uuid": "72753031-e460-49ab-add6-030ddba1bc94",
      "cdek_number": 1114267441,
      "passport": [
        {
          "client": "SENDER",
          "passport_requirements_satisfied": false
        },
        {
          "client": "RECEIVER",
          "passport_requirements_satisfied": false
        }
      ]
    }
  ]
}