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

• Документація в кабінеті SalesDrive, API-ключі
• Ліміти
• Авторизація
• Приклад запитів
• Параметри запиту, фільтри
• Приклад на PHP
• Формат даних, що повертаються

Ліміти

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

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

• Установки → Загальні налаштування і інтеграції → Інші сервіси → API → Список заявок

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

• Установки → Загальні налаштування і інтеграції → Інші сервіси → API → API-ключі → Створити API-ключ

Авторизація

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

• Form-Api-Key: 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

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

Приклад на 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);

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