Skip to main content

Список заказов

Метод позволяет получать список поступающих заказов из маркетплейсов в рамках одной компании.

Параметры запроса#

ПараметрОписание
seller* intКомпания, по которому выполнить выгрузку
limit intОграничение элементов ответа. По умолчанию возвращается 10 последних, отсортированных по времени заказа
page intСтраница ответа. По умолчанию возвращается 1-ая страница
markets string[]Маркетплейсы, заказы по которым необходимо выгрузить заказы. По умолчанию заказы выгружаются по всем доступным
periodFrom stringДата начала выборки, в формате Y-m-d H:i:s
periodTo stringДата конца выборки, в формате Y-m-d H:i:s
status stringОграничить выборку по статусу заказов [in_process, cancelled, success_completed, unknown] in_process - В работе, cancelled - Отмене, success_completed - Доставлен, unknown - Статус неизвестен (исключительный статус, ошибка в данных получаемых от МП)

Параметры ответа#

ПараметрОписание
success boolУспешность запроса
errors string[string]Ошибки запроса
data string[object]Список заказов
data[].id stringИдентификатор заказа в системе LK.MARKET
data[].externalId stringИдентификатор заказа в маркетплейсе
data[].marketId stringИдентификатор маркетплейса. Полный список маркетплейсов доступен по методу https://lk.market/api/v1/dictionaries/markets
data[].createdAt stringВремя создания заказа
data[].items arrayСписок позиций заказа
data[].items[].id stringИдентификатор позиции заказа в системе LK.MARKET
data[].items[].externalId stringИдентификатор позиции заказа на маркетплейсе
data[].items[].updatedAt stringВремя обновления статуса позиции заказа
data[].items[].status stringСтатус позиции заказа [in_process, cancelled, success_completed, unknown]
data[].items[].quantity stringКоличество продукта в заказе
data[].items[].saleScheme stringсхема продажи [FBM, FBS, FBM+, DBS, ADV]. Подробнее о схемах продаж
data[].items[].product objectДанные заказанного продукта
data[].items[].product.id intИдентификатор продукта в системе LK.MARKET
data[].items[].product.externalId stringИдентификатор продукта на маркетплейсе
data[].items[].product.sku stringАртикул продукта в системе LK.MARKET
data[].items[].product.externalSku stringАртикул продукта на маркетплейсе

Запрос#

GET /api/v1/orders HTTP/1.1
Host: lk.market
X-Client-Id: 1
X-Api-Token: f9327c5ec57vz66136923e101a4f2821m5c9983fa321123d86b3a7187t3a5c81
Content-Type: application/json

Успешный ответ 200:

{  "success": true,  "errors": [],  "data": [    {      "id": 123456,      "externalId": "1111111-0000-0",      "marketId": "Ozon",      "createdAt": "2021-01-01 09:32:15",      "items": [        {          "id": 12345678,          "externalId": "11111111-0000-0000000000",          "updatedAt": null,          "status": "unknown",          "quantity": 1,          "saleScheme": "FBS",          "product": {            "id": 12345,            "externalId": "11111111",            "sku": "ART-1",            "externalSku": "ART-1"          }        }      ]    }  ]}

Неудачный ответ 422:

{    "success": false,     "errors": {         "email": "invalid"    },     "data": null }