Сервис заказа REST v2
Размещает заказ в системе
| URL запроса: |
https://api.brinex.ru/v2/order |
| HTTP метод : |
POST |
| Заголовки запроса (request headers): |
Authorization: Bearer [token]
Accept: application/json
Content-type: application/json |
| Параметры запроса: |
| test |
1 - тествый заказ (не создает), 0 - не тестовый (заказ создается). Если не передан, то будет использовано значение 1. |
| return_on_success |
Если выставлен в 1, то в ответе будут возвращены заказанные товары со статусом Success. По умолчанию - 0. |
| shipping |
Если 1 - доставка, если 0 - самовывоз. Доступные значения можно посмотреть в сервисе клиент https://api.brinex.ru/v2/client/shipping. Обязательное значение. |
| user_location |
Идентификатор адреса доставки или магазина в системе. Список адресов/магазинов доставки можно посмотреть в сервисе клиент, для shipping = 0 https://api.brinex.ru/v2/client/stores, shipping = 1 https://api.brinex.ru/v2/client/addresses. Обязательное значение. |
| reserve |
Если выставлен 1, то заказ ставится в резерв на 3 дня. Если 0, то уходит в работу. Если не передан, то будет использовано значение 0. |
| reference |
Ваш идентификатор заказа. Если не указан, то будет сгенерирован. При разбиении заказа используется один и тот же идентификатор на все созданные при разбиении заказы. |
| comment |
Комментарий к заказу |
| stock_id |
ID склада, с которого будет сделан заказ. Обязательное значение. |
| kod_dogovora |
Код договора для заказа, если не передавать первый из списка подставится |
| resale |
Цель приобретения, значение 1 - Для дальнейшей продажи (коды маркировки остаются в обороте), 0 - Для нужд организации (коды маркировки выводятся из оборота). Обязательное значение. |
| tk_id |
ID транспортной компании (Обязательное значение. если до выбранного адреса доставка осуществляется транспортной компанией) |
| orderPositions |
Список товаров, коллекция массивов
| goods_id |
Идентификатор товара в системе |
| price |
Цена товара |
| quantity |
Количество |
| |
|
|
|
| Ответ: |
Возвращает строку JSON с общей инфомацией о заказе и c коллекцией объектов orderPositions, содержащую позиции с ошибками заказа (несоответствие цены, наличие необходимого количества)
Товары прошедшие проверку, не содержатся в ответе. Признаком того, что заказ ушел в работу, является строка Success в ответе.
Структура ответа:
| status |
Статус проверки заказа Success - нет ошибок, Error - есть ошибки. |
| orders |
Если заказ создан, то содержит массив с идентификаторами заказов. Если параметр return_on_success = 1, то содержит массив заказов с информацией о заказе.
| order_id |
идентификатор заказа в системе. |
| shipping |
Доставка/самовывоз. |
| user_location |
Идентификатор адреса доставки или магазина в системе. |
| reserve |
Флаг, в резерв поставить или нет. |
| stock_id |
ID склада, с которого сделан заказ. |
| comment |
Комментарий к заказу. |
| shipping_date |
Дата доставки. |
| reserve_date |
Дата до которой зарезервирован заказ, если заказ поставлен в резерв. |
| reference |
Идентификатор. |
| errorMessage |
Описание ошибки, если есть ошибка в общей информации о заказе. Коллекция объектов. Ключ - название аттрибута, значение - описание ошибки. |
| orderPositions |
Товары для заказа, набор массивов структуры.
| goods_id |
Идентификатор товара в системе. |
| price |
Цена товара. |
| quantity |
Количество. |
| markingCode |
Коды маркировок. |
| status |
Статус проверки заказа: Success - нет ошибок, Error - есть ошибки. |
| errorMessage |
Описание ошибки, если есть ошибка. Коллекция объектов. Ключ - название атрибута, значение - описание ошибки. |
|
|
|
Отправить поставленный в резерв заказ в работу
| URL запроса: |
https://api.brinex.ru/v2/order/work |
| HTTP метод : |
GET |
| Заголовки запроса (request headers): |
Authorization: Bearer [token]
Accept: application/json
Content-type: application/json |
| Параметры запроса: |
Отправляется один из параметров. Если отправить оба, то ищется заказ только по order_id. Если отпрален reference, то все заказы с данным идентификатором будут отправлены в работу.
| order_id |
Идентификатор заказа |
| reference |
Ваш идентификатор заказа |
|
| Ответ: |
Возвращается строка JSON.
При успехе Success. При ошибке массив
| status |
Error |
| errorMessage |
Описание ошибки |
|
Отменить поставленный в резерв заказ
| URL запроса: |
https://api.brinex.ru/v2/order/cancel |
| HTTP метод : |
GET |
| Заголовки запроса (request headers): |
Authorization: Bearer [token]
Accept: application/json
Content-type: application/json |
| Параметры запроса: |
Отправляется один из параметров, если отправить оба, то ищется заказ только по order_id.
| order_id |
Идентификатор заказа |
| reference |
Ваш идентификатор заказа |
|
| Ответ: |
Возвращается строка JSON.
При успехе Success. При ошибке массив
| status |
Error |
| errorMessage |
Описание ошибки |
|
Передать заказ другому пользователю
Как получить имя пользователя, которому разрешено передать заказ, описано в сервисе Клиент.
| URL запроса: |
https://api.brinex.ru/v2/order/transfer |
| HTTP метод : |
GET |
| Заголовки запроса (request headers): |
Authorization: Bearer [token]
Accept: application/json
Content-type: application/json |
| Параметры запроса: |
Отправляется один из параметров, если отправить оба, то ищется заказ только по order_id.
| order_id |
Идентификатор заказа |
| user |
Имя пользователя, которому передать заказ |
|
| Ответ: |
Возвращается строка JSON.
| status |
Error - ошибка / Success - успех |
| order_id |
Новый номер заказа, который был присвоен при передаче заказа. |
| errorMessage |
Описание ошибки, если произошла ошибка |
|
