Заказы

Документация REST API

Search…

Документация REST API

Общие правила и ограничения

Заказы

get
https://api.livesklad.com
/shops/{id}/orders
Список заказов в мастерской
get
https://api.livesklad.com
/company/orders
Список заказов без привязки к мастерской
post
https://api.livesklad.com
/shops/{id}/orders
Создание заказа
Контрагент при создании заказ может быть указан двумя способами:
1) counteragentId - id уже существующего контрагента
2) name, typeCounteragentId, phones, isBuyer, isVendor, email, address, isSendSms, rating, counteragentNode - данные контрагента которого необходимо создать при создании заказа. В случае если не указан typeCounteragentId, используется значение указанное в системе по умолчанию.
Один из параметров counteragentId или name - обязателен.
В customFields передаются пользовательские поля по заказу и контрагенту (в том случае если контрагент создается при создании заказа). Поле передается в формате:
1
[
2
  {
3
    id: "5e0cea8e7ae81e080c8be6d8",
4
    value: true
5
  },
6
  {
7
    id: "5e0ceaf77ae81e080c8be700",
8
    value: "Приоритетный клиент"
9
  }
10
]
Copied!
В случае если по заказу нужно внести предоплату, необходимо указать параметры cashRegisterId и какой-то из параметров prepaymentMoney или prepaymentBank (в случае смешанной оплаты можно указать сразу оба параметра)
По умолчанию для создания заказа обязательным является только поле typeOrderId и одно из полей counteragentId или name. Но в случае если для указанного типа заказа (определяется по typeOrderId) изменена форма заказа, то обязательными могут быть так же и другие поля
Для создания контрагента при создании заказа, по умолчанию обязательным является только поле name. Но в случае если для типа контрагента указанного в системе по умолчанию, изменена форма контрагента, то обязательными могут быть так же и другие поля.
get
https://api.livesklad.com
/type-orders
Список типов заказов
get
https://api.livesklad.com
/type-orders/{id}/fields
Список пользовательских полей для типа заказа
get
https://api.livesklad.com
/orders/{id}
Информация о заказе
patch
https://api.livesklad.com
/orders/{id}
Изменить заказ
В customFields передаются пользовательские поля по заказу и контрагенту (в том случае если контрагент создается при создании заказа). Поле передается в формате:
1
[
2
  {
3
    id: "5e0cea8e7ae81e080c8be6d8",
4
    value: true
5
  },
6
  {
7
    id: "5e0ceaf77ae81e080c8be700",
8
    value: "Приоритетный клиент"
9
  }
10
]
Copied!
Произвести оплату по заказу (параметры cashRegisterId, money, bank, nodePay) возможно только в том случае если у заказа меняется статус (указан параметр statusId) и у данного статуса в настройках задан параметр "Затребовать оплату при перехода заказа в этот статус".
delete
https://api.livesklad.com
/orders/{id}
Удалить заказ