Просмотр списка заказов (API версия 2): различия между версиями
Перейти к навигации
Перейти к поиску
(Новая страница: «Для просмотра списка заказов нужно отправлять следующий запрос: <pre> GET https://order24-api.utr.ua/api/o...») |
|||
| (не показаны 4 промежуточные версии этого же участника) | |||
| Строка 1: | Строка 1: | ||
Для | <languages/> | ||
<translate> | |||
Для перегляду списка замовлень потрібно відправити наступний запит: | |||
<pre> | <pre> | ||
GET https://order24-api.utr.ua/api/order-list/{date} | GET https://order24-api.utr.ua/api/order-list/{date} | ||
</pre> | </pre> | ||
{date} - дата | '''{date}''' - дата початку періоду для выборки замовлень (кінець періоду - поточна дата)<br> | ||
додавши при цьому в headers<br> | |||
<pre> | |||
Authorization: Bearer eyJ0eXAiOiJKV1Q...<br> | Authorization: Bearer eyJ0eXAiOiJKV1Q...<br> | ||
</pre> | |||
Де в '''Authorization''' після ключового слова Bearer потрібно передати отриманий при проходженні аутентифікації token | |||
<br><br> | <br><br> | ||
Також запит може бути уточнено шляхом вказання поточної сторінки та кількості елеметів на сторінці: | |||
<pre> | <pre> | ||
GET https://order24-api.utr.ua/api/order-list/{date}?page=1&limit=20&mode=period | GET https://order24-api.utr.ua/api/order-list/{date}?page=1&limit=20&mode=period | ||
</pre> | </pre> | ||
Можливо також виконати пошук замовлень, які містять певну деталь | |||
<pre> | <pre> | ||
GET https://order24-api.utr.ua/api/order-list/{date}/{detail_id} | GET https://order24-api.utr.ua/api/order-list/{date}/{detail_id} | ||
</pre> | </pre> | ||
де: '''{detail_id}''' – код товара | |||
<br><br> | <br><br> | ||
В | В результаті ви отримаєте одну із наступних відповідей: | ||
== Помилка аутентифікації == | |||
Можливі відповіді API при помилці аутентифікації приведено в розділі [[Special:MyLanguage/Ошибка аутентификации (API версия 2)|Помилка аутентификації]] | |||
== | == Замовлення не знайдено == | ||
* Status Code: 200 OK | * Status Code: 200 OK | ||
* Body: | * Body: | ||
| Строка 31: | Строка 36: | ||
</pre> | </pre> | ||
== Список | |||
== Список замовлень == | |||
* Status Code: 200 OK | * Status Code: 200 OK | ||
* Body: | * Body: | ||
| Строка 37: | Строка 44: | ||
[ | [ | ||
{ | { | ||
"id": | "id": 6802274, | ||
"externalCode": " | "externalCode": "УЭТ000008", | ||
"date": " | "date": "2024-02-13T08:31:22+02:00", | ||
"orderItems": [ | "orderItems": [ | ||
{ | { | ||
"detail": { | "detail": { | ||
"id": | "multiplicity": 1, | ||
"id": 1022206, | |||
"brand": { | "brand": { | ||
"name": " | "name": "SACHS", | ||
"externalCode": "00005" | |||
}, | }, | ||
"article": " | "displayBrand": "SACHS", | ||
"title": " | "article": "317 577", | ||
"title": "Амортизатор", | |||
"quantity": 1, | "quantity": 1, | ||
"remains": [ | "remains": [ | ||
{ | { | ||
"storage": { | "storage": { | ||
"id": | "id": 15, | ||
"name": " | "name": "Kиїв Правий", | ||
"originalName": "Kиев Правый" | |||
}, | }, | ||
"remain": "6" | "remain": "6" | ||
}, | }, | ||
{ | { | ||
"storage": { | "storage": { | ||
"id": | "id": 23, | ||
"name": " | "name": "Дніпро", | ||
"originalName": "Днепр" | |||
}, | }, | ||
"remain": " | "remain": "2" | ||
}, | }, | ||
... | ... | ||
], | ], | ||
" | "detailScanCodes": [ | ||
{ | { | ||
" | "scanCode": "4013872967957" | ||
} | } | ||
], | ], | ||
"category": { | "category": { | ||
"name": " | "name": "Амортизатор" | ||
} | }, | ||
"modifier": 0, | |||
"isDisabled": false, | |||
"hasPartnerRemain": false | |||
}, | }, | ||
"storage": { | "storage": { | ||
"id": | "id": 15, | ||
"name": " | "name": "Kиїв Правий", | ||
"originalName": "Kиев Правый" | |||
}, | }, | ||
"quantity": 1, | "quantity": 1, | ||
"price": { | "price": { | ||
"amount": | "amount": 2158.3 | ||
} | } | ||
} | } | ||
], | ], | ||
"status": "processing", | "status": "processing", | ||
"delivery": { | "delivery": { | ||
"name": " | "name": "Курьер Киев Розничный Магазин 9:00" | ||
}, | }, | ||
"paymentType": "nal", | "paymentType": "nal", | ||
"comment": "test4", | |||
"amount": { | "amount": { | ||
"amount": | "amount": 2158.3, | ||
"currency": { | "currency": { | ||
"code": "UAH" | "code": "UAH" | ||
| Строка 171: | Строка 118: | ||
] | ] | ||
</pre> | </pre> | ||
</translate> | |||
Текущая версия на 10:53, 21 февраля 2024
Для перегляду списка замовлень потрібно відправити наступний запит:
GET https://order24-api.utr.ua/api/order-list/{date}
{date} - дата початку періоду для выборки замовлень (кінець періоду - поточна дата)
додавши при цьому в headers
Authorization: Bearer eyJ0eXAiOiJKV1Q...<br>
Де в Authorization після ключового слова Bearer потрібно передати отриманий при проходженні аутентифікації token
Також запит може бути уточнено шляхом вказання поточної сторінки та кількості елеметів на сторінці:
GET https://order24-api.utr.ua/api/order-list/{date}?page=1&limit=20&mode=period
Можливо також виконати пошук замовлень, які містять певну деталь
GET https://order24-api.utr.ua/api/order-list/{date}/{detail_id}
де: {detail_id} – код товара
В результаті ви отримаєте одну із наступних відповідей:
Помилка аутентифікації
Можливі відповіді API при помилці аутентифікації приведено в розділі Помилка аутентификації
Замовлення не знайдено
- Status Code: 200 OK
- Body:
[]
Список замовлень
- Status Code: 200 OK
- Body:
[
{
"id": 6802274,
"externalCode": "УЭТ000008",
"date": "2024-02-13T08:31:22+02:00",
"orderItems": [
{
"detail": {
"multiplicity": 1,
"id": 1022206,
"brand": {
"name": "SACHS",
"externalCode": "00005"
},
"displayBrand": "SACHS",
"article": "317 577",
"title": "Амортизатор",
"quantity": 1,
"remains": [
{
"storage": {
"id": 15,
"name": "Kиїв Правий",
"originalName": "Kиев Правый"
},
"remain": "6"
},
{
"storage": {
"id": 23,
"name": "Дніпро",
"originalName": "Днепр"
},
"remain": "2"
},
...
],
"detailScanCodes": [
{
"scanCode": "4013872967957"
}
],
"category": {
"name": "Амортизатор"
},
"modifier": 0,
"isDisabled": false,
"hasPartnerRemain": false
},
"storage": {
"id": 15,
"name": "Kиїв Правий",
"originalName": "Kиев Правый"
},
"quantity": 1,
"price": {
"amount": 2158.3
}
}
],
"status": "processing",
"delivery": {
"name": "Курьер Киев Розничный Магазин 9:00"
},
"paymentType": "nal",
"comment": "test4",
"amount": {
"amount": 2158.3,
"currency": {
"code": "UAH"
}
}
},
...
]