1612
правок
Изменения
==Методы==
===Получение списка заказов===
GET /v1/orders
===Получение списка заказов в зависимости от статуса заказа===
GET /v1/orders?status=
===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}
==Описание==
===Получение списка заказов===
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;*3 = оплата заказа по безналичному расчету;*4 = оплата заказа по Raiffeisen QR;*5 = оплата заказа корпоративной картой.
===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/v1/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/v1/orders?status=31. В headers запроса обязательно должна передаваться страна пользователя, а также и уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов поставщика в указанном статусе, а также их данными.
Также возможно получение списка заказов, начиная за период от определенного времени, указав нужную дату и время указанного в '''GET-параметр параметре "updated_from", до времени выполнения запроса: "updated_from=2019-11-27T07:03:01"'''.
''Пример: https://food.smartsatu.com/api/v1/orders?status=7&updated_from=2019-11-27T07:03:01''
Перечень статусов заказа:
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - <small>заказ в статусах "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ , которая приняла не все товары (изменила количество) и подтвердила доставку</small>
|}
Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.
Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.
Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят без изменений",
}
==Безопасность==
| < items> array
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | status
| integer($int64)
| 4
|-
| style="font-weight:bold;" | offer_id
Пример запроса:
{
"comment": "Вот такой комментарий Изменена дата доставки и количество товара", "delivery_date": "09.10.2019",
"items":
[
{
],
"status": 4
}
===Response Orders Items===
'''Items'''
{| class="wikitable"
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| integerstring
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| booleaninteger
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| integerdecimal| 11340.00
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| stringarray
| Ок
|-
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| Массивarray
| < order_items > array
|
|-
| style="font-weight:bold;" | Supplier_company_namesupplier_company_name
| Название поставщика
| string
|-
| style="font-weight:bold;" | store_company
| Массивarray
| < store_company > array
|
|-
| style="font-weight:bold;" | service_fee_amount
| Сумма сервисного сбора
| decimal
| 300.00
|}
'''Order Items'''
|-
| style="font-weight:bold;" | images
| Массивarray
| < images > array
|
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| integer($int32)string
| Магазин для тестирования\r\n
|-