API: Список заявок

Ліміти

Період Ліміт запитів
1 хв 10
1 година 100
24 години 1000

Документація в кабінеті SalesDrive, API-ключі

Документація по API з описом доступна у вашому кабінеті SalesDrive:

Створити API-ключ з правами читання заявок.

Авторизація

У запитах по отриманню списку заявок - передавайте заголовок:

Приклад запитів для отримання списку заявок

Заявки, створені після 01.11.2023 з id статусу = 3:

GET https://yourdomain.salesdrive.me/api/order/list/?page=1&limit=50&filter[orderTime][from]=2023-11-01&filter[statusId]=3

Заявки, змінені після 01.11.2023 11:00:

GET https://yourdomain.salesdrive.me/api/order/list/?page=1&limit=50&filter[updateAt][from]=2023-11-24 11:00:00

Параметри запиту, фільтри

Параметр Опис
page Сторінка
limit Кількість результатів на сторінці (максимум 100), за замовчуванням 50
filter масив фільтрів
Фільтри
Ви можете фільтрувати заявки по будь-яких полях. Повний перелік фільтрів доступний у вашому кабінеті SalesDrive.
Нижче наведені найбільш популярні фільтри:
filter[updateAt][from] Дата зміни заявки від (формат: "РРРР-ММ-ДД ГГ:ХХ:СС")
filter[updateAt][to] Дата зміни заявки до (формат: "РРРР-ММ-ДД ГГ:ХХ:СС")
filter[id][from] Номер заявки від
filter[id][to] Номер заявки до
filter[orderTime][from] Дата створення від (формат: "РРРР-ММ-ДД ГГ:ХХ:СС")
filter[orderTime][to] Дата створення до (формат: "РРРР-ММ-ДД ГГ:ХХ:СС")
filter[statusId]
Статус. Можна передавати декілька значень окремими полями filter[statusId][].
За замовчуванням – усі, окрім видалених.
Окрім id стаусів, можна використовувати:
  • __NOTDELETED__ - усі, окрім видалених.
  • __ALL__ - всі (у тому числі видалені).
filter[setStatusTime][from] Дата зміни статусу заявки від (формат: "РРРР-ММ-ДД ГГ:ХХ:СС")
filter[setStatusTime][to] Дата зміни статусу заявки до (формат: "РРРР-ММ-ДД ГГ:ХХ:СС")
filter[setStatusId][] Встановлені статуси у період, вказаний параметром setStatusTime. Можна передати декілька значень.

Приклад на PHP

<?php

$url = "https://yourdomain.salesdrive.me/api/order/list/";
$headers = [
    'Form-Api-Key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
];
$filter = [
    'orderTime' => [
        'from' => '2023-09-01',
    ],
    'statusId' => '__ALL__',
];
$data = [
    'page' => 1,
    'limit' => 100,
    'filter' => $filter,
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url.'?'.http_build_query($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
$result = curl_exec($ch);

echo $result;
$resultDecoded = json_decode($result,true);
print_r($resultDecoded);

Формат даних, що повертаються

Поле Опис
data Масив із даними заявок
meta[fields] Назва полів, опцій списків, дані товарів
pagination[currentPage] Поточна сторінка
pagination[pageCount] Кількість сторінок
pagination[perPage] Кількість результатів на сторінці
totals[count] Усього знайдено заявок
totals[paymentAmount] Усього сума
totals[commission] Усього комісія
totals[expenses] Усього витрати
status "success" - успіх, "error" - помилка
message повідомлення з описом помилки (якщо виникла помилка)

Реєстрація в SalesDrive

.salesdrive.me

Реєструючись, ви погоджуєтеся на обробку персональних даних і приймаєте умови надання послуг.