Информация о паспортных данных

Метод используется для получения информации о паспортных данных (сообщает о готовности передавать заказы на таможню) по международным заказу/заказам.

Запрос на получение информации о паспортных данных

Для использования необходимо отправить GET-запрос на URL:

Среда	URL
тестовая	https://api.edu.cdek.ru/v2/passport
боевая	https://api.cdek.ru/v2/passport

Параметры запроса

Поддерживаются следующие параметры:

№	Название поля	Описание	Тип поля	Обяз. для заполн.
1	order_uuid	Идентификатор заказа в ИС СДЭК	UUID [ ]	да, если не указан cdek_number
2	cdek_number	Номер заказа СДЭК	long [ ]	да, если не указан order_uuid
3	client	Клиент, по которому будет выведена информация о паспортных данных: sender - отправитель receiver- получатель Если значение не передано, то информация о паспортных данных будет выводиться и по отправителю, и по получателю	string	нет

№

Название поля

Описание

Тип поля

Обяз. для заполн.

order_uuid

Идентификатор заказа в ИС СДЭК

UUID [ ]

да, если не указан cdek_number

cdek_number

Номер заказа СДЭК

long [ ]

да, если не указан order_uuid

client

Клиент, по которому будет выведена информация о паспортных данных:

sender - отправитель
receiver- получатель

Если значение не передано, то информация о паспортных данных будет выводиться и по отправителю, и по получателю

string

нет

Ответ на запрос получения информации о паспортных данных

Ответ возвращается в формате JSON:

№	Название поля	Описание	Тип поля	Обяз. для заполн.
1	orders	Список заказов	order [ ]	нет
1.1	order_uuid	Идентификатор заказа в Pintex	UUID	да
1.2	cdek_number	Номер заказа СДЭК	long	да
1.3	passport	Информация о паспортных данных по заказу	passport [ ]	да
1.3.1	client	Клиент, по которому выведена информация о наличии паспортных данных: sender - отправитель receiver- получатель	string	да
1.3.2	passport_requirements_satisfied	Требования по паспортным данным удовлетворены (актуально для международных заказов): true - паспортные данные собраны или не требуются false - паспортные данные требуются и не собраны	boolean	да
2	errors	Ошибки, возникшие в ходе выполнения запроса	error [ ]	нет
2.1	code	Код ошибки	string()	да
2.2	message	Описание ошибки	string()	да
3	warnings	Предупреждения, возникшие в ходе выполнения запроса	warning[ ]	нет
3.1	code	Код предупреждения	string()	да
3.2	message	Описание предупреждения	string()	да

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
        }
      ]
    }
  ]
}

Пример запроса для получения информации по нескольким заказам:

https://api.cdek.ru/v2/passport?cdek_number=1400000000&cdek_number=1400000001

{
    "orders": [
        {
            "order_uuid": "72753031-aa87-42e3-94ae-f71c7b3e0182",
            "cdek_number": 1106022736,
            "passport": [
                {
                    "client": "SENDER",
                    "passport_requirements_satisfied": false
                },
                {
                    "client": "RECEIVER",
                    "passport_requirements_satisfied": false
                }
            ]
        },
        {
            "order_uuid": "72753031-529e-4065-b1ec-37b7c92c09df",
            "cdek_number": 1106012781,
            "passport": [
                {
                    "client": "SENDER",
                    "passport_requirements_satisfied": false
                },
                {
                    "client": "RECEIVER",
                    "passport_requirements_satisfied": false
                }
            ]
        }
    ]
}