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:
Vitaly the Alpaca (bot)
@@ -42,5 +42,11 @@ Method at API documentation: [Client authorization](https://api-docs.cdek.ru/299
|
||||
```
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg2NDk4NDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJzb2xpZC1hZGRyZXNzOmZhbHNlIiwiY29udHJhZ2VudC11dWlkOmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImZ1bGwtbmFtZTrQotC10YHRgtC40YDQvtCy0LDQvdC40LUg0JjQvdGC0LXQs9GA0LDRhtC40Lgg0JjQnCJdLCJqdGkiOiJob3R5QmQtd2xqdzJsd3V6NGp1ZUcxckU1NDAiLCJjbGllbnRfaWQiOiJ3cUd3aVF4MGdnOG1MdGlFS3NVaW5qVlNJQ0NqdFRFUCJ9.IXSw8O68ucBPSFm_sUv-HqRVe9jRi9Iv945fWN2vBKPNiG4CQSTnIKKzpub932vskhDC3MoR3sjIPDhcheOrc9jgpDl4gpLwIfgcz_a5xwikPxph6gpakIU16mrwp110AvkJvJchktNYpty44YjIKOi8UgwgtaJvbsWR-Ztb5A__TfikmtHZuvHZbhCU_QuGD9oloIdgtLueyQO7HsOqWHGy1VpUat_a985FRswUM96Jao66qO5zAeZmUkfzcz7mQPG1IDtMP1eLIV-OeX78W3F1aW5wkIpfjcV-iRe-JZRJH-mjSQI9TWcwy7g3mgxsyfqyHmSzGwIBd0v58_3jzg",
|
||||
"token_type": "bearer",
|
||||
"expires_in": 3599,
|
||||
"scope": "location:all order:all payment:all",
|
||||
"jti": "hotyBd-wljw2lwuz4jueG1rE540"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Create customer refund
|
||||
Processes customer returns for online store orders
|
||||
|
||||
|
||||
|
||||
`Function CreateCustomerRefund(Val Token, Val UUID, Val Tariff, Val TestAPI = False) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Auth token |
|
||||
| UUID | --uuid | String | Order UUID |
|
||||
| Tariff | --tariff | Number | Tariff code (from those available under the contract) |
|
||||
| TestAPI | --testapi | Boolean | Flag to use test API for requests |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from CDEK
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
This method is used if the direct order was delivered by CDEK and the recipient wants to return it in full
|
||||
|
||||
If the order was delivered by another service, or you need to return not all items, you must use the CreateOrder method with is_client_return = true
|
||||
|
||||
Method at API documentation: [Customer returns](https://api-docs.cdek.ru/122762174.html)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg2ODEyNjEsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJhY2NvdW50LWxhbmc6cnVzIiwiY29udHJhY3Q60JjQnC3QoNCkLdCT0JvQky0yMiIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJzb2xpZC1hZGRyZ...";
|
||||
UUID = "f1799065-01de-448c-91cf-8afe7d4c0cfc";
|
||||
Tariff = 139;
|
||||
|
||||
Result = OPI_CDEK.CreateCustomerRefund(Token, UUID, Tariff, True);
|
||||
```
|
||||
|
||||
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint cdek CreateCustomerRefund --token "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg2ODEyNjEsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJhY2NvdW50LWxhbmc6cnVzIiwiY29udHJhY3Q60JjQnC3QoNCkLdCT0JvQky0yMiIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJzb2xpZC1hZGRyZ..." --uuid "f1799065-01de-448c-91cf-8afe7d4c0cfc" --tariff %tariff% --testapi %testapi%
|
||||
|
||||
```
|
||||
|
||||
```json title="Result"
|
||||
|
||||
```
|
||||
@@ -7,7 +7,7 @@ sidebar_position: 1
|
||||
|
||||
|
||||
|
||||
`Function CreateOrder(Val Token, Val OrderDescription, Val OnlineStore = False, TestAPI = False) Export`
|
||||
`Function CreateOrder(Val Token, Val OrderDescription, Val OnlineStore = False, Val TestAPI = False) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
@@ -28,7 +28,84 @@ Method at API documentation: [Order registration](https://api-docs.cdek.ru/29923
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg2ODEyNjEsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJhY2NvdW50LWxhbmc6cnVzIiwiY29udHJhY3Q60JjQnC3QoNCkLdCT0JvQky0yMiIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJzb2xpZC1hZGRyZ...";
|
||||
|
||||
OrderDescription = New Structure;
|
||||
|
||||
SendLocation = New Structure;
|
||||
SendLocation.Insert("code" , "44");
|
||||
SendLocation.Insert("city" , "Moscow");
|
||||
SendLocation.Insert("address", "Ave. Leningradsky, 4");
|
||||
|
||||
DestLocation = New Structure;
|
||||
DestLocation.Insert("code" , "270");
|
||||
DestLocation.Insert("city" , "Novosibirsk");
|
||||
DestLocation.Insert("address", "st. Bluchera, 32");
|
||||
|
||||
Recipient = New Structure;
|
||||
|
||||
Phones = New Array;
|
||||
Phones.Add(New Structure("number", "+79134637228"));
|
||||
|
||||
Recipient.Insert("phones", Phones);
|
||||
Recipient.Insert("name" , "Ivaniv Ivan");
|
||||
|
||||
Sender = New Structure("name", "Petrov Petr");
|
||||
|
||||
Services = New Array;
|
||||
|
||||
Service = New Structure;
|
||||
Service.Insert("code" , "SECURE_PACKAGE_A2");
|
||||
Service.Insert("parameter", 10);
|
||||
|
||||
Services.Add(Service);
|
||||
|
||||
Packages = New Array;
|
||||
|
||||
Package = New Structure;
|
||||
|
||||
Items = New Array;
|
||||
|
||||
Item = New Structure;
|
||||
|
||||
Payment = New Structure;
|
||||
Payment.Insert("value", 3000);
|
||||
|
||||
Item.Insert("payment" , Payment);
|
||||
Item.Insert("ware_key", "00055");
|
||||
Item.Insert("name" , "Product");
|
||||
Item.Insert("cost" , 300);
|
||||
Item.Insert("amount" , 2);
|
||||
Item.Insert("weight" , 700);
|
||||
Item.Insert("url" , "www.item.ru");
|
||||
|
||||
Items.Add(Item);
|
||||
|
||||
Package.Insert("items" , Items);
|
||||
Package.Insert("number" , "bar-001");
|
||||
Package.Insert("comment", "Packaging");
|
||||
Package.Insert("height" , 10);
|
||||
Package.Insert("length" , 10);
|
||||
Package.Insert("weight" , "4000");
|
||||
Package.Insert("width" , 10);
|
||||
|
||||
Packages.Add(Package);
|
||||
|
||||
OrderDescription.Insert("from_location", SendLocation);
|
||||
OrderDescription.Insert("to_location" , DestLocation);
|
||||
OrderDescription.Insert("packages" , Packages);
|
||||
OrderDescription.Insert("recipient" , Recipient);
|
||||
OrderDescription.Insert("sender" , Sender);
|
||||
OrderDescription.Insert("services" , Services);
|
||||
|
||||
OrderDescription.Insert("number" , "ddOererre7450813980068");
|
||||
OrderDescription.Insert("comment" , "New order");
|
||||
OrderDescription.Insert("tariff_code", 139);
|
||||
|
||||
OrderDescription.Insert("delivery_recipient_cost" , New Structure("value" , 50));
|
||||
OrderDescription.Insert("delivery_recipient_cost_adv", New Structure("sum,threshold", 3000, 200));
|
||||
|
||||
Result = OPI_CDEK.CreateOrder(Token, OrderDescription, True, True);
|
||||
```
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# Create refusal
|
||||
Creates an order refusal to return to the online store
|
||||
|
||||
|
||||
|
||||
`Function CreateRefusal(Val Token, Val UUID, Val TestAPI = False) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Auth token |
|
||||
| UUID | --uuid | String | Order UUID |
|
||||
| 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: [Registration of refusal](https://api-docs.cdek.ru/55327658.html)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg2ODEyNjEsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJhY2NvdW50LWxhbmc6cnVzIiwiY29udHJhY3Q60JjQnC3QoNCkLdCT0JvQky0yMiIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJzb2xpZC1hZGRyZ...";
|
||||
UUID = "f1799065-01de-448c-91cf-8afe7d4c0cfc";
|
||||
|
||||
Result = OPI_CDEK.CreateRefusal(Token, UUID, True);
|
||||
```
|
||||
|
||||
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint cdek CreateRefusal --token "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg2ODEyNjEsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJhY2NvdW50LWxhbmc6cnVzIiwiY29udHJhY3Q60JjQnC3QoNCkLdCT0JvQky0yMiIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJzb2xpZC1hZGRyZ..." --uuid "f1799065-01de-448c-91cf-8afe7d4c0cfc" --testapi %testapi%
|
||||
|
||||
```
|
||||
|
||||
```json title="Result"
|
||||
|
||||
```
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Delete order
|
||||
Deletes order by UUID
|
||||
|
||||
|
||||
|
||||
`Function DeleteOrder(Val Token, Val UUID, Val TestAPI = False) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Auth token |
|
||||
| UUID | --uuid | String | Order UUID for deletion |
|
||||
| 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: [Deleting an order](https://api-docs.cdek.ru/29924487.html)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg2ODEyNjEsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJhY2NvdW50LWxhbmc6cnVzIiwiY29udHJhY3Q60JjQnC3QoNCkLdCT0JvQky0yMiIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJzb2xpZC1hZGRyZ...";
|
||||
UUID = "f1799065-01de-448c-91cf-8afe7d4c0cfc";
|
||||
|
||||
Result = OPI_CDEK.DeleteOrder(Token, UUID, True);
|
||||
```
|
||||
|
||||
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint cdek DeleteOrder --token "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg2ODEyNjEsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJhY2NvdW50LWxhbmc6cnVzIiwiY29udHJhY3Q60JjQnC3QoNCkLdCT0JvQky0yMiIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJzb2xpZC1hZGRyZ..." --uuid "f1799065-01de-448c-91cf-8afe7d4c0cfc" --testapi %testapi%
|
||||
|
||||
```
|
||||
|
||||
```json title="Result"
|
||||
|
||||
```
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Get order by number
|
||||
Receives the order by CDEK number or number from customer IB
|
||||
|
||||
|
||||
|
||||
`Function GetOrderByNumber(Val Token, Val OrderNumber, Val Internal = False, Val TestAPI = False) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Auth token |
|
||||
| OrderNumber | --number | String | Order number |
|
||||
| Internal | --internal | Boolean | Type of order number. True > number in the customer base, False > CDEK number |
|
||||
| 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 information](https://api-docs.cdek.ru/29923975.html)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg2ODEyNjEsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJhY2NvdW50LWxhbmc6cnVzIiwiY29udHJhY3Q60JjQnC3QoNCkLdCT0JvQky0yMiIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJzb2xpZC1hZGRyZ...";
|
||||
|
||||
OrderNumber = "ddOererre7450813980068";
|
||||
Result = OPI_CDEK.GetOrderByNumber(Token, OrderNumber, True, True);
|
||||
```
|
||||
|
||||
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint cdek GetOrderByNumber --token "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg2ODEyNjEsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJhY2NvdW50LWxhbmc6cnVzIiwiY29udHJhY3Q60JjQnC3QoNCkLdCT0JvQky0yMiIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJzb2xpZC1hZGRyZ..." --number "ddOererre7450813980068" --internal %internal% --testapi %testapi%
|
||||
|
||||
```
|
||||
|
||||
```json title="Result"
|
||||
|
||||
```
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
# Get order description
|
||||
@@ -41,5 +41,119 @@ Required fields may depend on the type of order or nesting. Be sure to read the
|
||||
```
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"tariff_code": "<Tariff code)>",
|
||||
"recipient": {
|
||||
"company": "<Company name>",
|
||||
"name": "<Full name of contact person>",
|
||||
"passport_series": "<Passport series>",
|
||||
"passport_number": "<Passport number>",
|
||||
"passport_date_of_issue": "<Date of issue of passport>",
|
||||
"passport_organization": "<Passport issuing authority>",
|
||||
"tin": "<TIN>",
|
||||
"passport_date_of_birth": "<Birth date>",
|
||||
"email": "<Email as RFC 2822>",
|
||||
"contragent_type": "<Sender type: LEGAL_ENTITY, INDIVIDUAL >",
|
||||
"phones": [
|
||||
{
|
||||
"number": "<Phone number>",
|
||||
"additional": "<Additional information (extension number)>"
|
||||
}
|
||||
]
|
||||
},
|
||||
"packages": [
|
||||
{
|
||||
"number": "<Package number>",
|
||||
"weight": "<Total weight (grams)>",
|
||||
"length": "<Package Dimensions. Length (cm)>",
|
||||
"width": "<Package Dimensions. Width (cm)>",
|
||||
"height": "<Package Dimensions. Height (cm)>",
|
||||
"comment": "<Package withommentary>",
|
||||
"items": [
|
||||
{
|
||||
"name": "<Product name>",
|
||||
"ware_key": "<Product ID/article>",
|
||||
"marking": "<Product marking>",
|
||||
"payment": {
|
||||
"value": "<Amount of cash on delivery, including VAT>",
|
||||
"vat_sum": "<VAT amount>",
|
||||
"vat_rate": "<VAT rate (value - 0, 10, 12, 20, null - no VAT)>"
|
||||
},
|
||||
"cost": "<Declared product price>",
|
||||
"weight": "<Weight (per unit, grams)>",
|
||||
"weight_gross": "<Gross weight>",
|
||||
"amount": "<Number of units (pcs)>",
|
||||
"name_i18n": "<Foreign language name>",
|
||||
"brand": "<Brand in a foreign language>",
|
||||
"country_code": "<Country code of the product manufacturer as ISO_3166-1_alpha-2>",
|
||||
"material": "<Material code>",
|
||||
"wifi_gsm": "<Contains wifi or gsm>",
|
||||
"url": "<Link to the website of the online store with the description of the product>"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"additional_order_types": "<Additional order type>",
|
||||
"comment": "<Order comment>",
|
||||
"developer_key": "<Developer key (for module developers)>",
|
||||
"shipment_point": "<Code of CDEK POZ for self carriage by the customer>",
|
||||
"delivery_point": "<Code of CDEK office to which the package will be delivered>",
|
||||
"date_invoice": "<Invoice date>",
|
||||
"shipper_name": "<Shipper>",
|
||||
"shipper_address": "<Shippers address>",
|
||||
"sender": {
|
||||
"company": "<Company name>",
|
||||
"name": "<Full name of contact person>",
|
||||
"email": "<Email for alerts as RFC 2822>",
|
||||
"passport_series": "<Passport series>",
|
||||
"passport_number": "<Passport number>",
|
||||
"passport_date_of_issue": "<Date of issue of passport>",
|
||||
"passport_organization": "<Passport issuing authority>",
|
||||
"tin": "<TIN>",
|
||||
"passport_date_of_birth": "<Birth date>",
|
||||
"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": "<Code withтраны in format ISO_3166-1_alpha-2>",
|
||||
"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>",
|
||||
"address": "<Address string >"
|
||||
},
|
||||
"to_location": {
|
||||
"code": "<CDEC locality code>",
|
||||
"fias_guid": "<Unique FIAS identifier>",
|
||||
"postal_code": "<Postal code>",
|
||||
"longitude": "<Longitude>",
|
||||
"latitude": "<Latitude>",
|
||||
"country_code": "<Code withтраны in format ISO_3166-1_alpha-2>",
|
||||
"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>",
|
||||
"address": "<Address string >"
|
||||
},
|
||||
"services": {
|
||||
"code": "<Type of additional service>",
|
||||
"parameter": "<Additional service parameter>"
|
||||
},
|
||||
"print": "<Need to generate a document>",
|
||||
"is_client_return": "<Customer refund>",
|
||||
"accompanying_number": "<Number of the accompanying consignment note>",
|
||||
"widget_token": "<Token received from widget.cdek.ru>"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Get order
|
||||
Gets the order by UUID
|
||||
|
||||
|
||||
|
||||
`Function GetOrder(Val Token, Val UUID, Val TestAPI = False) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Auth token |
|
||||
| UUID | --uuid | String | Order UUID |
|
||||
| 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 information](https://api-docs.cdek.ru/29923975.html)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg2ODEyNjEsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJhY2NvdW50LWxhbmc6cnVzIiwiY29udHJhY3Q60JjQnC3QoNCkLdCT0JvQky0yMiIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJzb2xpZC1hZGRyZ...";
|
||||
UUID = "f1799065-01de-448c-91cf-8afe7d4c0cfc";
|
||||
|
||||
Result = OPI_CDEK.GetOrder(Token, UUID, True);
|
||||
```
|
||||
|
||||
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint cdek GetOrder --token "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg2ODEyNjEsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJhY2NvdW50LWxhbmc6cnVzIiwiY29udHJhY3Q60JjQnC3QoNCkLdCT0JvQky0yMiIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJzb2xpZC1hZGRyZ..." --uuid "f1799065-01de-448c-91cf-8afe7d4c0cfc" --testapi %testapi%
|
||||
|
||||
```
|
||||
|
||||
```json title="Result"
|
||||
|
||||
```
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Update order
|
||||
Changes the field values of the selected order
|
||||
|
||||
|
||||
|
||||
`Function UpdateOrder(Val Token, Val UUID, Val OrderDescription, Val TestAPI = False) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Auth token |
|
||||
| UUID | --uuid | String | Order UUID for updating |
|
||||
| OrderDescription | --order | Structure of KeyAndValue | Set of changing order fields |
|
||||
| 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: [Change of order](https://api-docs.cdek.ru/36981178.html)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg2ODEyNjEsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJhY2NvdW50LWxhbmc6cnVzIiwiY29udHJhY3Q60JjQnC3QoNCkLdCT0JvQky0yMiIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJzb2xpZC1hZGRyZ...";
|
||||
UUID = "f1799065-01de-448c-91cf-8afe7d4c0cfc";
|
||||
|
||||
OrderDescription = New Structure("comment", "NewComment");
|
||||
|
||||
Result = OPI_CDEK.UpdateOrder(Token, UUID, OrderDescription, True);
|
||||
```
|
||||
|
||||
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint cdek UpdateOrder --token "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg2ODEyNjEsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJhY2NvdW50LWxhbmc6cnVzIiwiY29udHJhY3Q60JjQnC3QoNCkLdCT0JvQky0yMiIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJzb2xpZC1hZGRyZ..." --uuid "f1799065-01de-448c-91cf-8afe7d4c0cfc" --order %order% --testapi %testapi%
|
||||
|
||||
```
|
||||
|
||||
```json title="Result"
|
||||
|
||||
```
|
||||
Reference in New Issue
Block a user