Получить описание заказа

Получает макет для создания заказа в функции СоздатьЗаказ

Функция ПолучитьОписаниеЗаказа(Знач Пустая = Ложь, Знач ТолькоОбязательные = Ложь, Знач ИнтернетМагазин = Ложь) Экспорт

Параметр	CLI опция	Тип	Обяз.	Назначение
Пустая	--empty	Булево	✖	Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей
ТолькоОбязательные	--required	Булево	✖	Истина > в макете будут только обязательные поля
ИнтернетМагазин	--ostore	Булево	✖	Признак включения в макет полей исключительно для заказо Интернет магазина

Возвращаемое значение: Структура Из КлючИЗначение - Структура полей

подсказка

Обязательность реквизитов может зависить от типа зказа или вложенности. Обязательно ознакомьтесь с документацией CDEK

Описания полей в документации: Регистрация заказа

Пример использования для 1С:Предприятие/OneScript

    Результат = OPI_CDEK.ПолучитьОписаниеЗаказа();

Bash

    oint cdek ПолучитьОписаниеЗаказа \
      --empty false

CMD/Bat

    oint cdek ПолучитьОписаниеЗаказа ^
      --empty false

Результат

{
 "tariff_code": "<Код тарифа (подробнее см. приложение 1)>",
 "recipient": {
  "company": "<Название компании>",
  "name": "<ФИО контактного лица>",
  "passport_series": "<Серия паспорта>",
  "passport_number": "<Номер паспорта>",
  "passport_date_of_issue": "<Дата выдачи паспорта>",
  "passport_organization": "<Орган выдачи паспорта>",
  "tin": "<ИНН>",
  "passport_date_of_birth": "<Дата рождения>",
  "email": "<Email как RFC 2822>",
  "contragent_type": "<Тип отправителя: LEGAL_ENTITY, INDIVIDUAL >",
  "phones": [
   {
    "number": "<Номер телефона>",
    "additional": "<Дополнительная информация (добавочный номер)>"
   }
  ]
 },
 "packages": [
  {
   "number": "<Номер упаковки>",
   "weight": "<Общий вес (в граммах)>",
   "length": "<Габариты упаковки. Длина (в сантиметрах)>",
   "width": "<Габариты упаковки. Ширина (в сантиметрах)>",
   "height": "<Габариты упаковки. Высота (в сантиметрах)>",
   "comment": "<Комментарий к упаковке>",
   "items": [
    {
     "name": "<Наименование товара>",
     "ware_key": "<Идентификатор/артикул товара>",
     "marking": "<Маркировка товара>",
     "payment": {
      "value": "<Сумма наложенного платежа, в том числе и НДС>",
      "vat_sum": "<Сумма НДС>",
      "vat_rate": "<Ставка НДС (значение - 0, 10, 12, 20, null - нет НДС)>"
     },
     "cost": "<Объявленная стоимость товара>",
     "weight": "<Вес (за единицу товара, в граммах)>",
     "weight_gross": "<Вес брутто>",
     "amount": "<Количество единиц товара (в штуках)>",
     "name_i18n": "<Наименование на иностранном языке>",
     "brand": "<Бренд на иностранном языке>",
     "country_code": "<Код страны производителя товара ISO_3166-1_alpha-2>",
     "material": "<Код материала>",
     "wifi_gsm": "<Содержит wifi или gsm>",
     "url": "<Ссылка на сайт интернет-магазина с описанием товара>"
    }
   ]
  }
 ],
 "additional_order_types": "<Дополнительный тип заказа>",
 "comment": "<Комментарий к заказу>",
 "developer_key": "<Ключ разработчика (для разработчиков модулей)>",
 "shipment_point": "<Код ПВЗ СДЭК для самостоятельного привоза клиентом>",
 "delivery_point": "<Код офиса СДЭК, на который будет доставлена посылка>",
 "date_invoice": "<Дата инвойса>",
 "shipper_name": "<Грузоотправитель>",
 "shipper_address": "<Адрес грузоотправителя>",
 "sender": {
  "company": "<Название компании>",
  "name": "<ФИО контактного лица>",
  "email": "<Email для оповещений RFC 2822>",
  "passport_series": "<Серия паспорта>",
  "passport_number": "<Номер паспорта>",
  "passport_date_of_issue": "<Дата выдачи паспорта>",
  "passport_organization": "<Орган выдачи паспорта>",
  "tin": "<ИНН>",
  "passport_date_of_birth": "<Дата рождения>",
  "contragent_type": "<Тип отправителя: LEGAL_ENTITY, INDIVIDUAL>",
  "phones": [
   {
    "number": "<Номер телефона>",
    "additional": "<Дополнительная информация (добавочный номер)>"
   }
  ]
 },
 "from_location": {
  "code": "<Код населенного пункта СДЭК>",
  "fias_guid": "<Уникальный идентификатор ФИАС>",
  "postal_code": "<Почтовый индекс>",
  "longitude": "<Долгота>",
  "latitude": "<Широта>",
  "country_code": "<Код страны в формате  ISO_3166-1_alpha-2>",
  "region": "<Название региона, уточняющий параметр для поля city>",
  "region_code": "<Код региона СДЭК, уточняющий параметр для поля city>",
  "sub_region": "<Название района региона, уточняющий параметр для поля region>",
  "city": "<Название города, уточняющий параметр для postal_code>",
  "kladr_code": "<Код КЛАДР>",
  "address": "<Строка адреса >"
 },
 "to_location": {
  "code": "<Код населенного пункта СДЭК>",
  "fias_guid": "<Уникальный идентификатор ФИАС>",
  "postal_code": "<Почтовый индекс>",
  "longitude": "<Долгота>",
  "latitude": "<Широта>",
  "country_code": "<Код страны в формате  ISO_3166-1_alpha-2>",
  "region": "<Название региона, уточняющий параметр для поля city>",
  "region_code": "<Код региона СДЭК, уточняющий параметр для поля city>",
  "sub_region": "<Название района региона, уточняющий параметр для поля region>",
  "city": "<Название города, уточняющий параметр для postal_code>",
  "kladr_code": "<Код КЛАДР>",
  "address": "<Строка адреса >"
 },
 "services": {
  "code": "<Тип дополнительной услуги>",
  "parameter": "<Параметр дополнительной услуги>"
 },
 "print": "<Необходимость сформировать печатную форму>",
 "is_client_return": "<Клиентский возврат>",
 "accompanying_number": "<Номер сопроводительной накладной>",
 "widget_token": "<Токен, полученный от widget.cdek.ru>"
}