Изменение статуса заказа

Адрес: https://service.leadhit.ru/api/v1/orders
Метод: set_order_status

Описание

Изменение статусов заказов можно использовать для настройки триггерных рассылок.

Параметры

Метод: POST
Заголовки: api-key
Параметры:

  • JSON с полями "order_id", "status";
  • Версия JSON-RPC: 2.0;
  • ID запроса: 0.

Статус должен быть одним из списка: "submitted", "paid", "delivered", "cancelled".
После получения нами заказа, ему выставляется статус "submitted" - оформлен.

API-key запросите у нас.

Пример использования

POST https://service.leadhit.ru/api/v1/orders

Headers (application/json):

api-key: <api-key>

Body (application/json):

{
  "method": "set_order_status",
  "params": {
    "order_id": "f168148717",
    "status": "paid"
  },
  "jsonrpc": "2.0",
  "id": 0
}

Response 200 (application/json):

{
  "jsonrpc": "2.0",
  "result": {
	"status": "ok",
	"message": "Order status changed"
  },
  "id": 0
}

Возможные ошибки
  • Если номер заказа не найден:
    Response 200 (application/json):
{
  'message': "Order with this id doesn't exist"
}
  • Если неправильно указан статус заказа:
    Response 200 (application/json):
{
  'message': 'Possible statuses: cancelled, delivered, paid, submitted'
}

Пример запроса с помощью CURL:

Curl:
```sh
$ curl -i \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "API-KEY: 4f8425fc77796b0266000009:TKW0i5FP5vkIrgMlnpoZbfOEagA" \
    -X POST -d '{"method":"set_order_status","params":{"order_id":"f168148717","status":"paid"},"jsonrpc":"2.0","id":0}' \
    https://service.leadhit.ru/api/v1/orders/

>>> {"jsonrpc": "2.0", "result": {"status": "ok", "order_status": "paid"}, "id": 0}

Revision #7
Created Wed, Oct 13, 2021 11:40 AM by Leadhit
Updated Tue, Nov 29, 2022 12:20 PM by Leadhit