Skip to main content
GET
Get deliveries

Авторизации

Authorization
string
header
обязательно

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Заголовки

X-Tenant-Id
integer

Компания, в контексте которой выполняется запрос — её id из GET /v1/tenant/. Пользователь должен состоять в этой компании: чужой id доступа к данным не даёт. Без заголовка компания определяется по домену запроса.

Параметры запроса

created_at__gte
string<date-time>
created_at__lte
string<date-time>
endpoint
number
event
enum<string>[]

Несколько значений могут быть разделены запятыми.

Доступные опции:
order.created,
order.deleted,
order.inventory_changed,
order.price_changed,
order.status_changed,
order.updated,
product.component_changed,
product.created,
product.deleted,
product.price_changed,
product.published_changed,
product.tariff_changed,
product.updated,
webhook.ping
module
enum<string>
  • order - Аренды
  • product - Продукты
  • system - Система
Доступные опции:
order,
product,
system
object_id
integer
page
integer

A page number within the paginated result set.

pageSize
integer

Number of results to return per page.

status
enum<string>
  • pending - Ожидает
  • retrying - Повтор
  • success - Успешно
  • failed - Ошибка
Доступные опции:
failed,
pending,
retrying,
success

Ответ

200 - application/json
count
integer
обязательно
Пример:

123

results
object[]
обязательно
next
string<uri> | null
Пример:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Пример:

"http://api.example.org/accounts/?page=2"