Загрузка прайс-листа: различия между версиями
(Подготовленная к переводу страница) |
|||
Строка 1: | Строка 1: | ||
<languages/> | <languages/> | ||
<translate> | <translate> | ||
Перед | Перед відправкою запросу на формування прайс-листа необхідно отримати список доступних форматів та список брендів, по яким прайс-лист може бути сформовано. Зробити це можно, выконавши наступний запрос: | ||
<pre> | <pre> | ||
GET https://order24-api.utr.ua/pricelists/export-params | GET https://order24-api.utr.ua/pricelists/export-params | ||
</pre> | </pre> | ||
додав при цьому в headers<br> | |||
Authorization: Bearer eyJ0eXAiOiJKV1Q...<br> | Authorization: Bearer eyJ0eXAiOiJKV1Q...<br> | ||
Де в Authorization після ключового слова Bearer потрібно передати отриманий при проходженні аутентифікації token | |||
<br><br> | <br><br> | ||
В | В результаті ви отримаєте одну із наступних відповідей: | ||
== | == Помилка аутентифікації == | ||
Можливі відповіді API при помилці аутентифікації наведено в розділі [[Special:MyLanguage/Ошибка аутентификации (API версия 2)|Ошибка аутентификации]] | |||
== Список | == Список параметрів == | ||
* Status Code: 200 OK | * Status Code: 200 OK | ||
Строка 48: | Строка 48: | ||
== Запрос на | == Запрос на формування прайс-листа == | ||
Для | Для додавання задачі на формування прайс-листа необхідно відправляти наступний запрос: | ||
<pre> | <pre> | ||
POST https://order24-api.utr.ua/pricelists/export-request | POST https://order24-api.utr.ua/pricelists/export-request | ||
</pre> | </pre> | ||
додав при цьому в headers<br> | |||
Authorization: Bearer eyJ0eXAiOiJKV1Q...<br> | Authorization: Bearer eyJ0eXAiOiJKV1Q...<br> | ||
Де в Authorization після ключового слова Bearer потрібно передати отриманий при проходженні аутентифікації token | |||
<br><br> | <br><br> | ||
* Body: | * Body: | ||
Строка 67: | Строка 67: | ||
} | } | ||
</pre> | </pre> | ||
де:<br> | |||
brandsId - массив | brandsId - массив ідентифікаторів брендів, по яким необхідно сформувати прайс-лист (із списка брендов)<br> | ||
format - формат прайс-листа ( | format - формат прайс-листа (із списка допустимих форматів)<br> | ||
utrArticle - флаг | utrArticle - флаг включення в прайс-лист додаткового поля - артикула Юник Трейд<br> | ||
inStock - флаг | inStock - флаг включення в прайс лише позицій с залишками | ||
В | В разі вдалої авторизації вы отримаєте наступну відповідь: | ||
<pre> | <pre> | ||
{ | { | ||
Строка 91: | Строка 91: | ||
</pre> | </pre> | ||
де:<br> | |||
Id - | Id - ідентифікатор прайс-листа. Дане поле необхідно для перевірки статуса и наступного завантаження прайс-листа<br> | ||
Status - статус прайс-листа, "in queue" - в | Status - статус прайс-листа, "in queue" - в черзі, "complete" - сформован | ||
== | == Перевірка стану прайс-листа == | ||
Для | Для перевірки стану прайс-листа необхідно відправляти наступний запрос: | ||
<pre> | <pre> | ||
GET https://order24-api.utr.ua/pricelists/{id} | GET https://order24-api.utr.ua/pricelists/{id} | ||
</pre> | </pre> | ||
де:<br> | |||
Id - | Id - ідентифікатор прайс-листа (отриманий в поле id відповіді на запрос на формування прайс-листа). | ||
В | В результаті отримуєм одну із наступних відповідей: | ||
* data: in queue - прайс лист | * data: in queue - прайс лист формується | ||
* data: complete - прайс лист | * data: complete - прайс лист сформовано | ||
== | == Отримання списка своїх прайс-листів == | ||
Для | Для отримання списка прайс-листов необхідно відправляти наступний запрос: | ||
<pre> | <pre> | ||
GET https://order24-api.utr.ua/pricelists | GET https://order24-api.utr.ua/pricelists | ||
</pre> | </pre> | ||
додав при цьому в headers<br> | |||
Authorization: Bearer eyJ0eXAiOiJKV1Q...<br> | Authorization: Bearer eyJ0eXAiOiJKV1Q...<br> | ||
де в Authorization після ключового слова Bearer потрібно передати отриманий при проходженні аутентифікаціх token | |||
<br><br> | <br><br> | ||
В | В разі вдалої авторизації ви отримаєте наступну відповідь: | ||
<pre> | <pre> | ||
[ | [ | ||
Строка 155: | Строка 155: | ||
== | == Завантаження прайс-листа == | ||
Для | Для отримання списка прайс-листов необхідно відправляти наступний запрос: | ||
<pre> | <pre> | ||
https://order24-api.utr.ua/pricelists/export/{token} | https://order24-api.utr.ua/pricelists/export/{token} | ||
</pre> | </pre> | ||
де:<br> | |||
token - | token - ідентифікатор прайс-листа, отриманий в полі token результату запроса на отримання списку прайс-листів | ||
<br><br> | <br><br> | ||
Status - статус прайс-листа, "in queue" - в | Status - статус прайс-листа, "in queue" - в черзі, "complete" - сформовано | ||
додавши при цьому в headers<br> | |||
Authorization: Bearer eyJ0eXAiOiJKV1Q...<br> | Authorization: Bearer eyJ0eXAiOiJKV1Q...<br> | ||
Де в Authorization після ключевого слова Bearer потрібно передати отрианий при проходженні аутентифікації token | |||
== | == Видалення прайс-листа == | ||
Для | Для видалення прайс-листа із списку необхідно відправляти наступний запрос: | ||
<pre> | <pre> | ||
DELETE https://order24-api.utr.ua/pricelists/delete/6440 | DELETE https://order24-api.utr.ua/pricelists/delete/6440 | ||
</pre> | </pre> | ||
де:<br> | |||
Id - | Id - ідентифікатор прайс-листа (отриманий в полі id) | ||
</translate> | </translate> |
Версия 13:51, 1 июля 2021
Перед відправкою запросу на формування прайс-листа необхідно отримати список доступних форматів та список брендів, по яким прайс-лист може бути сформовано. Зробити це можно, выконавши наступний запрос:
GET https://order24-api.utr.ua/pricelists/export-params
додав при цьому в headers
Authorization: Bearer eyJ0eXAiOiJKV1Q...
Де в Authorization після ключового слова Bearer потрібно передати отриманий при проходженні аутентифікації token
В результаті ви отримаєте одну із наступних відповідей:
Помилка аутентифікації
Можливі відповіді API при помилці аутентифікації наведено в розділі Ошибка аутентификации
Список параметрів
- Status Code: 200 OK
- Body:
{ "supportedFormats": [ "xlsx", "txt", "csv", "csv2", "xml", "json" ], "brands": [ { "id": 33, "name": "4MAX", "displayName": "4MAX" }, { "id": 55844, "name": "ABE", "displayName": "ABE" }, ... ] }
Запрос на формування прайс-листа
Для додавання задачі на формування прайс-листа необхідно відправляти наступний запрос:
POST https://order24-api.utr.ua/pricelists/export-request
додав при цьому в headers
Authorization: Bearer eyJ0eXAiOiJKV1Q...
Де в Authorization після ключового слова Bearer потрібно передати отриманий при проходженні аутентифікації token
- Body:
{ "brandsId": [35,55844], "format":"csv", "utrArticle":false, "inStock":false }
де:
brandsId - массив ідентифікаторів брендів, по яким необхідно сформувати прайс-лист (із списка брендов)
format - формат прайс-листа (із списка допустимих форматів)
utrArticle - флаг включення в прайс-лист додаткового поля - артикула Юник Трейд
inStock - флаг включення в прайс лише позицій с залишками
В разі вдалої авторизації вы отримаєте наступну відповідь:
{ "fileSize": "", "id": 6440, "format": "csv", "isInStock": false, "utrArticle": false, "locale": "ru", "status": "in queue", "createdAt": "2020-02-13T14:52:28+02:00", "brands": [ "ABE", "AE" ] }
де:
Id - ідентифікатор прайс-листа. Дане поле необхідно для перевірки статуса и наступного завантаження прайс-листа
Status - статус прайс-листа, "in queue" - в черзі, "complete" - сформован
Перевірка стану прайс-листа
Для перевірки стану прайс-листа необхідно відправляти наступний запрос:
GET https://order24-api.utr.ua/pricelists/{id}
де:
Id - ідентифікатор прайс-листа (отриманий в поле id відповіді на запрос на формування прайс-листа).
В результаті отримуєм одну із наступних відповідей:
- data: in queue - прайс лист формується
- data: complete - прайс лист сформовано
Отримання списка своїх прайс-листів
Для отримання списка прайс-листов необхідно відправляти наступний запрос:
GET https://order24-api.utr.ua/pricelists
додав при цьому в headers
Authorization: Bearer eyJ0eXAiOiJKV1Q...
де в Authorization після ключового слова Bearer потрібно передати отриманий при проходженні аутентифікаціх token
В разі вдалої авторизації ви отримаєте наступну відповідь:
[ { "fileSize": "", "id": 6577, "format": "csv", "isInStock": true, "utrArticle": false, "locale": "ru", "status": "in queue", "createdAt": "2020-02-14T14:16:38+02:00", "brands": [ "4MAX", "ABE" ] }, { "fileSize": "155.34КБ", "id": 6440, "format": "csv", "isInStock": false, "utrArticle": false, "locale": "ru", "status": "complete", "token": "4f6bb46deb82f7208ff90d046fddbc03", "createdAt": "2020-02-13T14:52:28+02:00", "brands": [ "ABE", "AE" ] } ]
Завантаження прайс-листа
Для отримання списка прайс-листов необхідно відправляти наступний запрос:
https://order24-api.utr.ua/pricelists/export/{token}
де:
token - ідентифікатор прайс-листа, отриманий в полі token результату запроса на отримання списку прайс-листів
Status - статус прайс-листа, "in queue" - в черзі, "complete" - сформовано
додавши при цьому в headers
Authorization: Bearer eyJ0eXAiOiJKV1Q...
Де в Authorization після ключевого слова Bearer потрібно передати отрианий при проходженні аутентифікації token
Видалення прайс-листа
Для видалення прайс-листа із списку необхідно відправляти наступний запрос:
DELETE https://order24-api.utr.ua/pricelists/delete/6440
де:
Id - ідентифікатор прайс-листа (отриманий в полі id)