Список заказов

Получение списка заказов в Лайнере. В случае успеха возвращает все активные (не архивированные) заказы.

Примечание

Пока не реализует пагинацию — возвращается весь список активных заказов.

---

Адрес и метод

GET /v1/order/list/

---

Пример запроса

CURLPHP (cURL)JavaScript (fetch)

curl -X GET "https://YOUR_LINER_API_HOST/v1/order/list/" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_TOKEN"

<?php

$host = 'https://YOUR_LINER_API_HOST';
$token = 'YOUR_API_TOKEN';

$ch = curl_init($host . '/v1/order/list/');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'X-Api-Key: ' . $token,
    ],
    CURLOPT_TIMEOUT => 15,
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ($response === false) {
    throw new RuntimeException('cURL error: ' . curl_error($ch));
}

curl_close($ch);

echo "HTTP {$httpCode}\n";
echo $response;

const host = "https://YOUR_LINER_API_HOST";
const token = "YOUR_API_TOKEN";

const res = await fetch(`${host}/v1/order/list/`, {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "X-Api-Key": token
  }
});

const data = await res.json();
console.log("HTTP", res.status, data);

---

Пример ответа

{
  "success": true,
  "message": "",
  "data": [
    {
      "id": 1,
      "title": "Example | Title",
      "code": "example-code",
      "callsAllowed": true
    }
  ]
}

Поля ответа

Поле	Тип	Описание
id	int	Идентификатор заказа.
title	string	Название заказа.
code	string	Код заказа.
callsAllowed	boolean	Разрешены ли звонки по заказу.

Примечание

Ниже описана структура поля data. Общий формат ответа API см. в разделе Схема запросов