1
0
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:
Vitaly the Alpaca (bot)
2024-10-09 16:35:56 +03:00
parent b6af2b4a73
commit bd90b054c9
36 changed files with 6047 additions and 5084 deletions
+1 -1
View File
@@ -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"
}