Период | Лимит запросов |
---|---|
1 мин | 10 |
1 час | 100 |
24 часа | 1000 |
Документация 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 стаусов можно использовать:
|
filter[setStatusTime][from] | Дата изменения статуса заявки от (формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС") |
filter[setStatusTime][to] | Дата изменения статуса заявки до (формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС") |
filter[setStatusId][] | Установленные статусы в период, указанный параметром setStatusTime. Можно передавать несколько значений. |
<?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 | сообщение с описанием ошибки (если возникла ошибка) |