completed - виконати роут /api/v1/goods/import/apply_changes/{task_id}.done.Використовуйте цей метод, щоб завантажити ваш файл із номенклатурою товарів.
accept: application/json
Content-Type: multipart/form-data
X-Client-Name: <назва інтеграції (обов'язкове для заповнення)>
X-Client-Version: <версія інтеграції (опціонально)>
ignore_barcode_duplicates: <true/false - ігнорування дублікатів штрихкодів товарів (за замовченням true)>
auto_supply: <true/false - автоматично створювати поставки для нових товарів (якщо для них було вказано кількість в файлі імпорту, за замовченням false) >
📁 Файл імпорту товарів формату .csv, .xlsx або .json.
Приклади файлів:
📥 checkbox_goods.csv
📥 checkbox_goods.json
📥 checkbox_goods.xlsx
curl -X 'POST' \ 'https://api.checkbox.ua/api/v1/goods/import/upload' \ -H 'accept: application/json' \ -H 'Authorization: Bearer token' \ -H 'X-Client-Name: Integration' \ -H 'X-Client-Version: 1.0.1' \ -H 'Content-Type: multipart/form-data' \ -F 'file=@CheckBox Export Goods.xlsx;type=application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
{
"task_id": "159ac640-f310-42ea-9663-e64271411111",
"status": "in_progress"
}
"task_id" - унікальний ідентифікатор операції у форматі UUID (report_task_id).
"status" - статус виконання операції.
Після завантаження файлу товарів методом /api/v1/goods/import/upload та отримання task_id - необхідно перевірити статус виконання завантаження товарів.
Також цей метод необхідно використовувати після методу /api/v1/goods/import/apply_changes для перевірки готовності імпорту або оновлення товарів.
accept: application/json
X-Client-Name: <назва інтеграції (обов'язкове для заповнення)>
X-Client-Version: <версія інтеграції (опціонально)>
task_id: <uuid завдання>
Authorization: <токен авторизації>
Тіло запиту у даному випадку має бути порожнім.
curl -X 'GET' \ 'https://api.checkbox.ua/api/v1/goods/import/task_status/159ac640-f310-42ea-9663-e64271411111' \ -H 'accept: application/json' \ -H 'X-Client-Name: Integration' \ -H 'X-Client-Version: 1.0.1' \ -H 'Authorization: Bearer token'
{
"task_id": "990d2afc-f97f-4700-af18-33d7058e9935",
"status": "completed",
"chunks_count": null,
"total_items": 5,
"processed_items": 5,
"errors": null
}
"task_id" - унікальний ідентифікатор операції у форматі UUID (report_task_id).
"status" - статус виконання операції.
"chunks_count" - кількість послідовностей операцій.
"total_items" - загальна кількість завантажених позицій.
"processed_items" - кількість опрацьованих позицій.
"errors" - масив даних із описом посилки.
Після перевірки статусу імпорту товарів методом /api/v1/goods/import/task_status/{task_id} та отримання статусу completed, необхідно застосувати зміни в товарах методом /api/v1/goods/import/apply_changes/{task_id}. У відповідь ви отримаєте task_id: uuid нового завдання, яке необхідно відслудковувати методом /api/v1/goods/import/task_status/{task_id}. Після отримання статусу done - імпорт або оновлення списку товарів завершено.
accept: application/json
X-Client-Name: <назва інтеграції (обов'язкове для заповнення)>
X-Client-Version: <версія інтеграції (опціонально)>
task_id: <uuid завдання>
Authorization: <токен авторизації>
Тіло запиту у даному випадку має бути порожнім.
curl -X 'POST' \ 'https://api.checkbox.ua/api/v1/goods/import/apply_changes/159ac640-f310-42ea-9663-e64271411111' \ -H 'accept: application/json' \ -H 'X-Client-Name: Integration' \ -H 'X-Client-Version: 1.0.1' \ -H 'Authorization: Bearer token'
{
"task_id": "990d2afc-f97f-4700-af18-33d705811111",
"status": "in_progress"
}
"task_id" - унікальний ідентифікатор операції у форматі UUID (report_task_id).
"status" - статус виконання операції.
done - виконати роут /api/v1/goods/export/file/{task_id} для завантаження файлу.Експорт товарів організації в .xlsx, .csv або .json
accept: application/json
X-Client-Name: <назва інтеграції (обов'язкове для заповнення)>
X-Client-Version: <версія інтеграції (опціонально)>
export_extension: <формат експорту, можливий .csv, .xlsx, .json>
Authorization: <токен авторизації>
Тіло запиту у даному випадку має бути порожнім.
curl -X 'GET' \ 'https://api.checkbox.ua/api/v1/goods/export/excel' \ -H 'accept: application/json' \ -H 'X-Client-Name: Integration' \ -H 'X-Client-Version: 1.0.1' \ -H 'Authorization: Bearer token'
{
"task_id": "a94e429b-eef9-4067-bb97-9839c1b11111",
"status": "in_progress"
}
"task_id" - унікальний ідентифікатор операції у форматі UUID (report_task_id).
"status" - статус виконання операції.
Після завантаження файлу товарів методом /api/v1/goods/export/{export_extension} та отримання task_id - необхідно перевірити статус виконання вивантаження товарів.
accept: application/json
X-Client-Name: <назва інтеграції (обов'язкове для заповнення)>
X-Client-Version: <версія інтеграції (опціонально)>
task_id: <uuid завдання>
Authorization: <токен авторизації>
Тіло запиту у даному випадку має бути порожнім.
curl -X 'GET' \ 'https://api.checkbox.ua/api/v1/goods/export/task_status/646991b3-c076-4173-8b06-f370c3411111' \ -H 'accept: application/json' \ -H 'X-Client-Name: Integration' \ -H 'X-Client-Version: 1.0.1' \ -H 'Authorization: Bearer token'
{
"task_id": "646991b3-c076-4173-8b06-f370c3411111",
"status": "done",
"chunks_count": null,
"total_items": 5,
"processed_items": 5,
"errors": null
}
"task_id" - унікальний ідентифікатор операції у форматі UUID (report_task_id).
"status" - статус виконання операції.
"chunks_count" - кількість послідовностей операцій.
"total_items" - загальна кількість завантажених позицій.
"processed_items" - кількість опрацьованих позицій.
"errors" - масив даних із описом посилки.
Після перевірки статусу виконання завдання на вивантаження товарів, як тільки статус зміниться на done - буде доступний метод вивантаження товарів /api/v1/goods/export/file/{task_id}.
accept: application/json
X-Client-Name: <назва інтеграції (обов'язкове для заповнення)>
X-Client-Version: <версія інтеграції (опціонально)>
chunk_number: <Номер частини експорту товарів (експорт у json)>
task_id: <uuid завдання>
Authorization: <токен авторизації>
Тіло запиту у даному випадку має бути порожнім.
curl -X 'GET' \ 'https://api.checkbox.ua/api/v1/goods/export/file/d9fedb14-97aa-4cc4-b260-f70b71111111' \ -H 'accept: application/json' \ -H 'X-Client-Name: Integration' \ -H 'X-Client-Version: 1.0.1' \ -H 'Authorization: Bearer token'
📁 Файл експорту товарів формату .csv, .xlsx або .json.
Приклади файлів:
📥 checkbox_goods.csv
📥 checkbox_goods.json
📥 checkbox_goods.xlsx