Получение списка заказов
Метод: GET
Путь: /cp/ts/orders/list
Параметры запроса
Параметры авторизации описаны в общем справочнике.
| Параметр | Описание |
|---|---|
number | номер заказа |
agreementId | идентификатор соглашения |
managerId | идентификатор менеджера |
deliveryId | идентификатор доставки |
message | комментарий к заказу или позиции заказа |
dateStart | rfc3339 начальная дата диапазона поиска по дате создания заказа (обязательное, если задан dateEnd) |
dateEnd | rfc3339 конечная дата диапазона поиска по дате создания заказа (обязательное, если задан dateStart) |
updateDateStart | rfc3339 начальная дата диапазона поиска по дате обновления заказа |
updateDateEnd | rfc3339 конечная дата диапазона поиска по дате обновления заказа |
deadlineDateStart | rfc3339 начальная дата диапазона поиска по дате ожидаемой поставки позиций заказа |
deadlineDateEnd | rfc3339 конечная дата диапазона поиска по дате ожидаемой поставки позиций заказа |
assembledDateStart | rfc3339 начальная дата диапазона поиска по дате полной комплектации заказа |
assembledDateEnd | rfc3339 конечная дата диапазона поиска по дате полной комплектации заказа |
orderIds | массив идентификаторов заказов |
productIds | идентификаторы карточек товаров через запятую |
positionStatuses | статусы позиций заказов через запятую |
skip | количество заказов в ответе, которое нужно пропустить |
limit | максимальное количество заказов, которое должно быть возвращено в ответе |
Пример запроса
- cURL
- JavaScript
- Go
- PHP
curl --get 'https://demo.public.api.abcp.ru/cp/ts/orders/list' \
--data-urlencode 'userlogin=YOUR_LOGIN' \
--data-urlencode 'userpsw=YOUR_PASSWORD_MD5' \
--data-urlencode 'agreementId=256' \
--data-urlencode 'limit=20'
const params = new URLSearchParams();
params.append('userlogin', 'YOUR_LOGIN');
params.append('userpsw', 'YOUR_PASSWORD_MD5');
params.append('agreementId', '256');
params.append('limit', '20');
const response = await fetch(`https://demo.public.api.abcp.ru/cp/ts/orders/list?${params}`);
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"io"
"log"
"net/http"
"net/url"
)
func main() {
params := url.Values{}
params.Add("userlogin", "YOUR_LOGIN")
params.Add("userpsw", "YOUR_PASSWORD_MD5")
params.Add("agreementId", "256")
params.Add("limit", "20")
response, err := http.Get("https://demo.public.api.abcp.ru/cp/ts/orders/list?" + params.Encode())
if err != nil {
log.Fatal(err)
}
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil {
log.Fatal(err)
}
fmt.Println(string(body))
}
<?php
$params = [
'userlogin' => 'YOUR_LOGIN',
'userpsw' => 'YOUR_PASSWORD_MD5',
'agreementId' => '256',
'limit' => '20',
];
$url = 'https://demo.public.api.abcp.ru/cp/ts/orders/list?' . http_build_query($params);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
echo $response;
?>
Ответ
Метод возвращает объект вида:
| Поле | Описание |
|---|---|
total | число найденных заказов |
list | список найденных заказов |