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

Версия 10:07, 4 июня 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"
        ]
    }
]