You've already forked OpenIntegrations
mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2026-05-22 10:05:29 +02:00
Main build (Jenkins)
This commit is contained in:
@@ -0,0 +1 @@
|
||||
oint cdek CreateOrder --token %token% --order %order% --ostore %ostore% --testapi %testapi%
|
||||
@@ -0,0 +1 @@
|
||||
oint cdek GetOrderDescription --empty %empty% --required %required% --ostore %ostore%
|
||||
@@ -0,0 +1 @@
|
||||
Result = OPI_CDEK.GetOrderDescription();
|
||||
@@ -37,7 +37,7 @@ Method at API documentation: [Client authorization](https://api-docs.cdek.ru/299
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint cdek GetToken --account "wqGwiQx0gg8mLtiEKsUinjVSICCjtTEP" --pass "RmAmgvSgSl..." --testapi %testapi%
|
||||
oint cdek GetToken --account "wqGwiQx0gg8mLtiEKsUinjVSICCjtTEP" --pass "RmAmgvSgSl..." --testapi %testapi%
|
||||
|
||||
```
|
||||
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Create order
|
||||
Creates an order based on field descriptions
|
||||
|
||||
|
||||
|
||||
`Function CreateOrder(Val Token, Val OrderDescription, Val OnlineStore = False, TestAPI = False) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Auth token |
|
||||
| OrderDescription | --order | Structure of KeyAndValue | Set of order fields. See GetOrderDescription |
|
||||
| OnlineStore | --ostore | Boolean | Flag of Online store order type |
|
||||
| TestAPI | --testapi | Boolean | Flag to use test API for requests |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from CDEK
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [Order registration](https://api-docs.cdek.ru/29923926.html)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint cdek CreateOrder --token %token% --order %order% --ostore %ostore% --testapi %testapi%
|
||||
|
||||
```
|
||||
|
||||
```json title="Result"
|
||||
|
||||
```
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Get order description
|
||||
Gets the layout of order for the CreateOrder function
|
||||
|
||||
|
||||
|
||||
`Function GetOrderDescription(Val Clear = False, Val RequiredOnly = False, Val OnlineStore = False) Export`
|
||||
|
||||
| Parameter | CLI option | Type | 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 |
|
||||
| OnlineStore | --ostore | Boolean | Flag of including fields in the layout exclusively for online store orders |
|
||||
|
||||
|
||||
Returns: Structure of KeyAndValue - Fields structure
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Required fields may depend on the type of order or nesting. Be sure to read the CDEK documentation
|
||||
|
||||
Field descriptions in the documentation: [Order registration](https://api-docs.cdek.ru/29923926.html)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_CDEK.GetOrderDescription();
|
||||
```
|
||||
|
||||
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint cdek GetOrderDescription --empty %empty% --required %required% --ostore %ostore%
|
||||
|
||||
```
|
||||
|
||||
```json title="Result"
|
||||
|
||||
```
|
||||
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Orders managment",
|
||||
"position": "3"
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
oint cdek ПолучитьОписаниеЗаказа --empty %empty% --required %required% --ostore %ostore%
|
||||
@@ -0,0 +1 @@
|
||||
oint cdek СоздатьЗаказ --token %token% --order %order% --ostore %ostore% --testapi %testapi%
|
||||
@@ -0,0 +1 @@
|
||||
Результат = OPI_CDEK.ПолучитьОписаниеЗаказа();
|
||||
@@ -37,7 +37,7 @@ sidebar_position: 1
|
||||
|
||||
```sh title="Пример команды CLI"
|
||||
|
||||
oint cdek ПолучитьТокен --account "wqGwiQx0gg8mLtiEKsUinjVSICCjtTEP" --pass "RmAmgvSgSl..." --testapi %testapi%
|
||||
oint cdek ПолучитьТокен --account "wqGwiQx0gg8mLtiEKsUinjVSICCjtTEP" --pass "RmAmgvSgSl..." --testapi %testapi%
|
||||
|
||||
```
|
||||
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Создать заказ
|
||||
Создает заказ по описанию полей
|
||||
|
||||
|
||||
|
||||
`Функция СоздатьЗаказ(Знач Токен, Знач ОписаниеЗаказа, Знач ИнтернетМагазин = Ложь, ТестовыйAPI = Ложь) Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Назначение |
|
||||
|-|-|-|-|
|
||||
| Токен | --token | Строка | Токен авторизации |
|
||||
| ОписаниеЗаказа | --order | Структура Из КлючИЗначение | Набор полей заказа. См. ПолучитьОписаниеЗаказа |
|
||||
| ИнтернетМагазин | --ostore | Булево | Признак типа заказа Интернет магазин |
|
||||
| ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов |
|
||||
|
||||
|
||||
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Метод в документации API: [Регистрация заказа](https://api-docs.cdek.ru/29923926.html)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Пример кода"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```sh title="Пример команды CLI"
|
||||
|
||||
oint cdek СоздатьЗаказ --token %token% --order %order% --ostore %ostore% --testapi %testapi%
|
||||
|
||||
```
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
```
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Получить описание заказа
|
||||
Получает макет для создания заказа в функции СоздатьЗаказ
|
||||
|
||||
|
||||
|
||||
`Функция ПолучитьОписаниеЗаказа(Знач Пустая = Ложь, Знач ТолькоОбязательные = Ложь, Знач ИнтернетМагазин = Ложь) Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Назначение |
|
||||
|-|-|-|-|
|
||||
| Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей |
|
||||
| ТолькоОбязательные | --required | Булево | Истина > в макете будут только обязательные поля |
|
||||
| ИнтернетМагазин | --ostore | Булево | Признак включения в макет полей исключительно для заказо Интернет магазина |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Структура полей
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Обязательность реквизитов может зависить от типа зказа или вложенности. Обязательно ознакомьтесь с документацией CDEK
|
||||
|
||||
Описания полей в документации: [Регистрация заказа](https://api-docs.cdek.ru/29923926.html)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Пример кода"
|
||||
Результат = OPI_CDEK.ПолучитьОписаниеЗаказа();
|
||||
```
|
||||
|
||||
|
||||
|
||||
```sh title="Пример команды CLI"
|
||||
|
||||
oint cdek ПолучитьОписаниеЗаказа --empty %empty% --required %required% --ostore %ostore%
|
||||
|
||||
```
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
```
|
||||
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Работа с заказми",
|
||||
"position": "3"
|
||||
}
|
||||
Reference in New Issue
Block a user