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

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

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

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

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

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

Название поляОписаниеТип поляОбяз. для заполн.
1order_uuidИдентификатор заказа в ИС СДЭКUUID [ ]да, если не указан cdek_number
2cdek_numberНомер заказа СДЭКlong [ ]да, если не указан order_uuid
3client

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

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

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

stringнет

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

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

Название поляОписаниеТип поляОбяз. для заполн.
1ordersСписок заказовorder [ ]нет
1.1order_uuidИдентификатор заказа в PintexUUIDда
1.2cdek_numberНомер заказа СДЭКlongда
1.3passportИнформация о паспортных данных по заказуpassport [ ]да
1.3.1client

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

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

stringда
1.3.2passport_requirements_satisfied

Требования по паспортным данным удовлетворены (актуально для международных заказов):

true - паспортные данные собраны или не требуются
false - паспортные данные требуются и не собраны

booleanда
2errorsОшибки, возникшие в ходе выполнения запросаerror [ ]нет
2.1codeКод ошибкиstring()да
2.2messageОписание ошибкиstring()да
3warningsПредупреждения, возникшие в ходе выполнения запросаwarning[ ]нет
3.1codeКод предупрежденияstring()да
3.2messageОписание предупреждения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
        }
      ]
    }
  ]
}
  • No labels