К содержанию
WEBRAAPI

Заказы

Заказы покупателей. Учётная система забирает новые заказы с портала, подтверждает их и передаёт изменения: статусы, состав, данные отгрузки.

Получить новые заказы

Возвращает до 10 новых заказов, оформленных на портале и ещё не подтверждённых учётной системой. Заказы отдаются по возрастанию ordersId.

Заказ возвращается при каждом запросе, пока учётная система не подтвердит его методом Orders/confirm. Чтобы забрать все новые заказы, повторяйте запрос после подтверждения, пока список не станет пустым.

Тело запроса

application/json
  1. body
baseID*string

Идентификатор информационной базы учётной системы. Подробнее в разделе «Авторизация».

apiKey*string

Ключ API портала.

modelName*string

Название модели.

calledMethod*string

Название метода.

Тело ответа

Список новых заказов. Если новых заказов нет, массив orders пустой.

application/json
  1. response
status*string
serverTime*ServerTime

Время ответа сервера, Unix timestamp.

data*
Пример запроса
curl -X POST 'https://api.your-portal.example/api/v1/json#Orders.get' \  -H 'Content-Type: application/json' \  -d '{  "baseID": "YOUR_BASE_ID",  "apiKey": "YOUR_API_KEY",  "modelName": "Orders",  "calledMethod": "get"}'
Пример ответа
{  "status": "success",  "serverTime": 1795183704,  "data": {    "orders": [      {        "ordersId": 1052,        "baseId": 1,        "documentDate": "2026-11-12 15:23:00",        "counterpartiesRef": "6f1c2a10-4b7e-11f1-80d9-a1b2c3d4e5f6",        "companiesRef": "3f6c7c1f-4a0c-11f1-80d9-a1b2c3d4e5f6",        "contractsRef": "6f1c2a11-4b7e-11f1-80d9-a1b2c3d4e5f6",        "currenciesRef": "6410b15c-4a0c-11f1-80d9-a1b2c3d4e5f6",        "documentSum": "9657.26",        "paymentType": 1,        "desiredShippingDate": "2026-11-14 00:00:00",        "comments": "Поставьте в резерв до пятницы",        "deliveryInfo": "самовивіз з Нової Пошти, Київ, Відділення №1, Мельник Ігор (+380501234567)",        "delivery": {          "typeId": 1,          "type": "самовивіз з Нової Пошти",          "address": "Київ, Відділення №1",          "receiver": "Мельник Ігор (+380501234567)",          "data": {            "city": "Київ",            "cityRef": "8d5a980d-391c-11dd-90d9-001a92567626",            "warehouseRef": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",            "branch": "1",            "receiverType": 1,            "receiverName": "Мельник Ігор",            "receiverPhone": "0501234567"          },          "additionalData": []        },        "items": [          {            "catalogItemsRef": "459afdeb-4a62-11f1-80d9-a1b2c3d4e5f6",            "quantity": "2.000",            "measuresRef": "1f4eec80-3cf0-11dc-8e55-a1b2c3d4e5f6",            "price": "4828.63",            "discountManual": "0.00",            "discountAuto": "0.00",            "sum": "9657.26",            "storesRef": null          }        ],        "author": {          "isManager": false,          "managersRef": null,          "usersId": 2,          "email": "buyer@example.com",          "name": "Ігор Мельник",          "phone": "+380501234567"        }      }    ]  }}

Подтвердить новые заказы

Сообщает порталу, что заказы из Orders/get созданы в учётной системе. Портал сохраняет идентификатор заказа в учётной системе (ordersRef) и новый статус. После подтверждения заказ больше не возвращается в Orders/get.

Подтверждение выполняется сразу, без очереди.

Тело запроса

application/json
  1. body
baseID*string

Идентификатор информационной базы учётной системы. Подробнее в разделе «Авторизация».

apiKey*string

Ключ API портала.

modelName*string

Название модели.

calledMethod*string

Название метода.

methodProperties*array<>

Тело ответа

Запрос выполнен.

application/json
  1. response
status*string
serverTime*ServerTime

Время ответа сервера, Unix timestamp.

Пример запроса
curl -X POST 'https://api.your-portal.example/api/v1/json#Orders.confirm' \  -H 'Content-Type: application/json' \  -d '{  "baseID": "YOUR_BASE_ID",  "apiKey": "YOUR_API_KEY",  "modelName": "Orders",  "calledMethod": "confirm",  "methodProperties": [    {      "ordersId": 1052,      "ordersRef": "a1c41b78-d628-11e9-80bc-a1b2c3d4e5f6",      "status": 2,      "code": "ET-0000000032"    }  ]}'
Пример ответа
{  "status": "success",  "serverTime": 1795183704}

Создаёт или обновляет заказы по ref. Так передают заказы, созданные в учётной системе, и изменения заказов с портала: состав, суммы, статус, данные отгрузки.

Состав заказа заменяется целиком: позиции, которых нет в запросе, удаляются.

Тело запроса

application/json
  1. body
baseID*string

Идентификатор информационной базы учётной системы. Подробнее в разделе «Авторизация».

apiKey*string

Ключ API портала.

modelName*string

Название модели.

calledMethod*string

Название метода.

methodProperties*array<>

Тело ответа

Данные приняты и поставлены в очередь. Обычно портал обрабатывает их в течение минуты. Результат обработки смотрите в журнале «Обработка запросов обмена» в админке портала.

application/json
  1. response
status*string
serverTime*ServerTime

Время ответа сервера, Unix timestamp.

Пример запроса
curl -X POST 'https://api.your-portal.example/api/v1/json#Orders.set' \  -H 'Content-Type: application/json' \  -d '{  "baseID": "YOUR_BASE_ID",  "apiKey": "YOUR_API_KEY",  "modelName": "Orders",  "calledMethod": "set",  "methodProperties": [    {      "ref": "a1c41b78-d628-11e9-80bc-a1b2c3d4e5f6",      "counterpartiesRef": "6f1c2a10-4b7e-11f1-80d9-a1b2c3d4e5f6",      "contractsRef": "6f1c2a11-4b7e-11f1-80d9-a1b2c3d4e5f6",      "currenciesRef": "6410b15c-4a0c-11f1-80d9-a1b2c3d4e5f6",      "managersRef": "",      "deletionFlag": false,      "status": 3,      "code": "ET-0000000032",      "documentDate": "2026-11-12 15:23:00",      "documentSum": 9657.26,      "includesVat": true,      "shippingDate": "2026-11-14 10:00:00",      "waybillDeliveryType": 1,      "waybillNumber": "20450000000001",      "items": [        {          "catalogItemsRef": "459afdeb-4a62-11f1-80d9-a1b2c3d4e5f6",          "measuresRef": "1f4eec80-3cf0-11dc-8e55-a1b2c3d4e5f6",          "quantity": 2,          "price": 4828.63,          "discountManual": 0,          "discountAuto": 0,          "vatRate": "20%",          "vatAmount": 1609.54,          "sum": 9657.26        }      ],      "services": []    }  ]}'
Пример ответа
{  "status": "success",  "serverTime": 1795183704}

Изменить статусы заказов

Меняет только статус заказа, остальные данные не трогает. Удобно, когда в учётной системе изменился лишь статус: заказ отгружен, отменён и т. п.

Для статусов «Частично отгружен», «Отменён» и «Отгружен» портал отправляет покупателю уведомление.

Тело запроса

application/json
  1. body
baseID*string

Идентификатор информационной базы учётной системы. Подробнее в разделе «Авторизация».

apiKey*string

Ключ API портала.

modelName*string

Название модели.

calledMethod*string

Название метода.

methodProperties*array<>

Тело ответа

Данные приняты и поставлены в очередь. Обычно портал обрабатывает их в течение минуты. Результат обработки смотрите в журнале «Обработка запросов обмена» в админке портала.

application/json
  1. response
status*string
serverTime*ServerTime

Время ответа сервера, Unix timestamp.

Пример запроса
curl -X POST 'https://api.your-portal.example/api/v1/json#Orders.status' \  -H 'Content-Type: application/json' \  -d '{  "baseID": "YOUR_BASE_ID",  "apiKey": "YOUR_API_KEY",  "modelName": "Orders",  "calledMethod": "status",  "methodProperties": [    {      "ref": "a1c41b78-d628-11e9-80bc-a1b2c3d4e5f6",      "status": 10    }  ]}'
Пример ответа
{  "status": "success",  "serverTime": 1795183704}