Загрузка прайс-листа: различия между версиями

Версия 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)

@@ Строка 1: / Строка 1: @@
 <languages/>
 <translate>
-Перед отправкой запроса на формирование прайс-листа необходимо получить список доступных форматов и список брендов, по которым прайс-лист может быть сформирован. Сделать это можно, выполнив следующий запрос:
+Перед відправкою запросу на формування прайс-листа необхідно отримати список доступних форматів та список брендів, по яким прайс-лист може бути сформовано. Зробити це можно, выконавши наступний запрос:
 <pre>
 GET https://order24-api.utr.ua/pricelists/export-params
 </pre>
-добавив при этом в headers<br>
+додав при цьому в headers<br>
 Authorization: Bearer eyJ0eXAiOiJKV1Q...<br>
-Где в Authorization после ключевого слова Bearer нужно передать полученный при прохождении аутентификации token
+Де в Authorization після ключового слова Bearer потрібно передати отриманий при проходженні аутентифікації token
 <br><br>
-В результате вы получите один из следующих ответов:
+В результаті ви отримаєте одну із наступних відповідей:
-== Ошибка аутентификации ==
+== Помилка аутентифікації ==
-Возможные ответы API при ошибке аутентификации приведены в разделе [[Special:MyLanguage/Ошибка аутентификации (API версия 2)|Ошибка аутентификации]]
+Можливі відповіді API при помилці аутентифікації наведено в розділі [[Special:MyLanguage/Ошибка аутентификации (API версия 2)|Ошибка аутентификации]]
-== Список параметров ==
+== Список параметрів ==
 * Status Code:	200 OK
@@ Строка 48: / Строка 48: @@
-== Запрос на формирование прайс-листа ==
+== Запрос на формування прайс-листа ==
-Для добавления задачи на формирования прайс-листа необходимо отправлять следующий запрос:
+Для додавання задачі на формування прайс-листа необхідно відправляти наступний запрос:
 <pre>
 POST https://order24-api.utr.ua/pricelists/export-request
 </pre>
-добавив при этом в headers<br>
+додав при цьому в headers<br>
 Authorization: Bearer eyJ0eXAiOiJKV1Q...<br>
-Где в Authorization после ключевого слова Bearer нужно передать полученный при прохождении аутентификации token
+Де в Authorization після ключового слова Bearer потрібно передати отриманий при проходженні аутентифікації token
 <br><br>
 * Body:
@@ Строка 67: / Строка 67: @@
 }
 </pre>
-где:<br>
+де:<br>
-brandsId - массив идентификаторов брендов, по которым необходимо сформировать прайс-лист (из списка брендов)<br>
+brandsId - массив ідентифікаторів брендів, по яким необхідно сформувати прайс-лист (із списка брендов)<br>
-format - формат прайс-листа (из списка допустимых форматов)<br>
+format - формат прайс-листа (із списка допустимих форматів)<br>
-utrArticle - флаг включения в прайс-лист дополнительного поля - артикула Юник Трейд<br>
+utrArticle - флаг включення в прайс-лист додаткового поля - артикула Юник Трейд<br>
-inStock - флаг включения в прайс только позиций с остатком
+inStock - флаг включення в прайс лише позицій с залишками
-В случае успешной авторизации вы получите следующий ответ:
+В разі вдалої авторизації вы отримаєте наступну відповідь:
 <pre>
 {
@@ Строка 91: / Строка 91: @@
 </pre>
-где:<br>
+де:<br>
-Id - идентификатор прайс-листа. Данное поле необходимо для проверки статуса и последующей закрузки прайс-листа<br>
+Id - ідентифікатор прайс-листа. Дане поле необхідно для перевірки статуса и наступного завантаження прайс-листа<br>
-Status - статус прайс-листа, "in queue" - в очереди, "complete" - сформирован
+Status - статус прайс-листа, "in queue" - в черзі, "complete" - сформован
-== Проверка состояния прайс-листа ==
+== Перевірка стану прайс-листа ==
-Для проверки состояния прайс-листа необходимо отправить следующий запрос:
+Для перевірки стану прайс-листа необхідно відправляти наступний запрос:
 <pre>
 GET https://order24-api.utr.ua/pricelists/{id}
 </pre>
-где:<br>
+де:<br>
-Id - идентификатор прайс-листа (полученный в поле id ответа на запрос на формирование прайс-листа).
+Id - ідентифікатор прайс-листа (отриманий в поле id відповіді на запрос на формування прайс-листа).
-В результате получаем один из следующих ответов
+В результаті отримуєм одну із наступних відповідей:
-* data: in queue - прайс лист формируется
+* data: in queue - прайс лист формується
-* data: complete - прайс лист сформирован
+* data: complete - прайс лист сформовано
-== Получение списка своих прайс-листов ==
+== Отримання списка своїх прайс-листів ==
-Для получения списка прайс-листов необходимо отправлять следующий запрос:
+Для отримання списка прайс-листов необхідно відправляти наступний запрос:
 <pre>
 GET https://order24-api.utr.ua/pricelists
 </pre>
-добавив при этом в headers<br>
+додав при цьому в headers<br>
 Authorization: Bearer eyJ0eXAiOiJKV1Q...<br>
-Где в Authorization после ключевого слова Bearer нужно передать полученный при прохождении аутентификации token
+де в Authorization після ключового слова Bearer потрібно передати отриманий при проходженні аутентифікаціх token
 <br><br>
-В случае успешной авторизации вы получите следующий ответ:
+В разі вдалої авторизації ви отримаєте наступну відповідь:
 <pre>
 [
@@ Строка 155: / Строка 155: @@
-== Загрузка прайс-листа ==
+== Завантаження прайс-листа ==
-Для получения списка прайс-листов необходимо отправлять следующий запрос:
+Для отримання списка прайс-листов необхідно відправляти наступний запрос:
 <pre>
 https://order24-api.utr.ua/pricelists/export/{token}
 </pre>
-где:<br>
+де:<br>
-token - идентификатор прайс-листа, полученный в поле token результата запроса на получение списка прайс-листов
+token - ідентифікатор прайс-листа, отриманий в полі token результату запроса на отримання списку прайс-листів
 <br><br>
-Status - статус прайс-листа, "in queue" - в очереди, "complete" - сформирован
+Status - статус прайс-листа, "in queue" - в черзі, "complete" - сформовано
-добавив при этом в headers<br>
+додавши при цьому в headers<br>
 Authorization: Bearer eyJ0eXAiOiJKV1Q...<br>
-Где в Authorization после ключевого слова Bearer нужно передать полученный при прохождении аутентификации token
+Де в Authorization після ключевого слова Bearer потрібно передати отрианий при проходженні аутентифікації token
-== Удаление прайс-листа ==
+== Видалення прайс-листа ==
-Для удаления прайс-листа из списка необходимо отправлять следующий запрос:
+Для видалення прайс-листа із списку необхідно відправляти наступний запрос:
 <pre>
 DELETE https://order24-api.utr.ua/pricelists/delete/6440
 </pre>
-где:<br>
+де:<br>
-Id - идентификатор прайс-листа (полученный в поле id)
+Id - ідентифікатор прайс-листа (отриманий в полі id)
 </translate>