Get courier invitations description

Gets the layout for creating a request for courier call in the CreateCourierInvitation function

Function GetCourierInvitationsDescription(Val Clear = False, Val RequiredOnly = False) Export

Parameter	CLI option	Type	Required	Description
Clear	--empty	Boolean	✖	True > structure with empty valuse, False > field descriptions at values
RequiredOnly	--required	Boolean	✖	True > only required fields will be in the set

Returns: Structure of KeyAndValue - Fields structure

tip

Required fields may depend on the type of order or nesting. Be sure to read the CDEK documentation

Field descriptions in the documentation: Registration of a courier invitation

1C:Enterprise/OneScript code example

    Result = OPI_CDEK.GetCourierInvitationsDescription();

Bash

    oint cdek GetCourierInvitationsDescription \
     --empty false

CMD/Bat

    oint cdek GetCourierInvitationsDescription ^
     --empty false

Result

{
 "intake_date": "<Courier waiting date>",
 "intake_time_from": "<Start time of waiting for the courier>",
 "intake_time_to": "<End time of waiting for the courier>",
 "cdek_number": "<CDEK order number>",
 "order_uuid": "<Order identifier in CDEK system>",
 "lunch_time_from": "<Lunch start time>",
 "lunch_time_to": "<Lunch finish time>",
 "name": "<Goods description>",
 "weight": "<Total weight (grams)>",
 "length": "<Package Dimensions. Length (cm)>",
 "width": "<Package Dimensions. Width (cm)>",
 "height": "<Package Dimensions. Height (cm)>",
 "comment": "<Comment to the request for courier>",
 "need_call": "<Need to call the sender>",
 "courier_power_of_attorney": "<The courier needs a letter of attorney>",
 "courier_identity_card": "<The courier needs an identity document>",
 "sender": {
  "company": "<Name of senders company>",
  "name": "<Full name of contact person>",
  "contragent_type": "<Sender type: LEGAL_ENTITY, INDIVIDUAL>",
  "phones": [
   {
    "number": "<Phone number>",
    "additional": "<Additional information (extension number)>"
   }
  ]
 },
 "from_location": {
  "code": "<CDEC locality code>",
  "fias_guid": "<Unique FIAS identifier>",
  "postal_code": "<Postal code>",
  "longitude": "<Longitude>",
  "latitude": "<Latitude>",
  "country_code": "<Country code>",
  "region": "<Region name, specifying parameter for the city field>",
  "region_code": "<CDEK region code, specifying parameter for the city field>",
  "sub_region": "<Name of the region's district, specifying parameter for the region field>",
  "city": "<City name, specifying parameter for postal_code>",
  "kladr_code": "<CLADR code. Deprecated field>",
  "address": "<Address string>"
 }
}