1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-02-11 13:53:00 +02:00
OpenIntegrations/docs/ru/md/CDEK/Delivery-management/Get-appointment-description.mdx
Vitaly the Alpaca (bot) 115f4e7594 Main build (Jenkins)
2024-10-22 00:14:15 +03:00

81 lines
3.4 KiB
Plaintext

---
sidebar_position: 8
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Получить описание договоренности
Получает макет для создания о доставке в функции ЗафиксироватьДоговоренностьОДоставке
`Функция ПолучитьОписаниеДоговоренности(Знач Пустая = Ложь, Знач ТолькоОбязательные = Ложь) Экспорт`
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|-|-|-|-|-|
| Пустая | --empty | Булево | ✖ | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей |
| ТолькоОбязательные | --required | Булево | ✖ | Истина > в макете будут только обязательные поля |
Возвращаемое значение: Структура Из КлючИЗначение - Структура полей
<br/>
:::tip
Обязательность реквизитов может зависить от типа зказа или вложенности. Обязательно ознакомьтесь с документацией CDEK
Описания полей в документации: [Регистрация договоренности о доставке](https://api-docs.cdek.ru/36981338.html)
:::
<br/>
```bsl title="Пример использования для 1С:Предприятие/OneScript"
Результат = OPI_CDEK.ПолучитьОписаниеДоговоренности();
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint cdek ПолучитьОписаниеДоговоренности \
--empty true
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint cdek ПолучитьОписаниеДоговоренности ^
--empty true
```
</TabItem>
</Tabs>
```json title="Результат"
{
"date": "<Дата доставки, согласованная с получателем>",
"cdek_number": "<Номер заказа СДЭК>",
"order_uuid": "<Идентификатор заказа в ИС СДЭК>",
"time_from": "<Время доставки С, согласованное с получателем>",
"time_to": "<Время доставки ПО, согласованное с получателем>",
"comment": "<Комментарий>",
"delivery_point": "<Буквенно-цифровой код ПВЗ СДЭК>",
"to_location": {
"code": "<Код населенного пункта СДЭК>",
"fias_guid": "<Уникальный идентификатор ФИАС>",
"postal_code": "<Почтовый индекс>",
"longitude": "<Долгота>",
"latitude": "<Широта>",
"country_code": "<Код страны в формате ISO_3166-1_alpha-2>",
"region": "<Название региона>",
"region_code": "<Код региона>",
"sub_region": "<Название района региона>",
"city": "<Название города>",
"kladr_code": "<Код КЛАДР>",
"address": "<Строка адреса>"
}
}
```