Отримати список замовлень

GET/api/crm/v2/ordersv2

operationId: orders.default

Авторизація

api-token + language + role

Параметри запиту

cursorinteger

Позиція, з якої читати сторінку: pagination.next_cursor — вперед, pagination.previous_cursor — назад; для першої сторінки не передавайте. Це межа порівняння, а не посилання на рядок: рядок, на який вказує значення, може не існувати, тому застаріле посилання все одно відкриває сторінку з того ж місця. Помилка 346 повертається лише, якщо значення неможливо розібрати як додатне ціле число.

Приклад: 84512

directionstring

Напрямок читання від курсора; last відкриває кінець списку та ігнорує курсор

Значення:nextpreviouslast

За замовчуванням: next

date_creation_fromstring

Приклад: 25/04/2024

date_creation_tostring

Приклад: 26/04/2024

chain_idinteger

branch_idinteger

phone_format_idinteger

phone_numberstring

emailstring

order_statusstring (OrderStatus)

Статус замовлення: в дорозі, виконано, збірка, на кухні, не оброблено, готовий до відправки, очікує відправки на кухню, очікує переробки, скасовано, підтверджено, приготовано

Значення:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Приклад: confirmed

platformstring (OrderPlatform)

Платформа замовлення

Значення:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Спосіб доставки: кур'єр або самовивіз

Значення:courierpickup

payment_statusstring (OrderPayment)

Статус оплати: не оплачено, очікує, оплачено

Значення:not_paidwaitingpaid

order_numberinteger

client_branch_profile_idinteger

client_account_idinteger

operator_idinteger

courier_idinteger

promo_codestring

Фільтр замовлень за промокодом (точний збіг з промокодом, застосованим до акцій замовлення)

Приклад: Promo1

hide_completed_ordersstring

Значення:true

Приклад: true

downloadstring

Значення:yes

Приклад: yes

Відповіді

object

statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject

filtersobject

date_creation_fromobject (FilterDateFrom)

valuestringможе бути null

Приклад: 2026-08-01 00:00:00

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_creation_toobject (FilterDateTo)

valuestringможе бути null

Приклад: 2026-08-31 23:59:59

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

date_creation_rangeobject (FilterDateRange)

Готові періоди фільтра за датою; нижня межа розраховується у часовому поясі користувача. value — період, якому відповідають поточні *_from та *_to; null — довільний період. default — період, який сервер підставляє у запит без дат: також застосовується при першому завантаженні розділу та при скиданні. Верхня межа періоду завжди дорівнює поточному дню користувача, тому option її не містить: передавати *_to для готового періоду не потрібно, сервер встановлює її самостійно. Період довший за рік обрізається зі сторони новішої межі.

valuestring (DateRange) може бути null

Готовий період фільтра за датою. Власного параметра запиту не має: нижня межа вже розрахована в option і підставляється в *_from. Верхня межа не передається ні у відповіді, ні у запиті — вона завжди дорівнює поточному дню користувача і задається сервером.

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

defaultstring (DateRange) обов’язковий

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

typestringобов’язковий

Приклад: select

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

optionarray of objectобов’язковий

valuestring (DateRange) обов’язковий

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

date_fromstringобов’язковий

Приклад: 25/08/2026

chain_idobject (FilterSelectInteger)

valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object

valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

branch_idobject (FilterSelectInteger)

valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object

valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

phone_format_idobject (FilterSelectInteger)

valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object

valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

phone_numberobject (FilterInput)

valuestring

Приклад: example

typestringобов’язковий

Приклад: integer or string

placeholderstring

Приклад: string

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

emailobject (FilterInput)

valuestring

Приклад: example

typestringобов’язковий

Приклад: integer or string

placeholderstring

Приклад: string

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

order_statusobject (FilterEnum)

Фільтр-перерахування — плоский список значень перерахування

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of string

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

platformobject (FilterEnum)

Фільтр-перерахування — плоский список значень перерахування

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of string

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

delivery_methodobject (FilterEnum)

Фільтр-перерахування — плоский список значень перерахування

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of string

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

payment_statusobject (FilterEnum)

Фільтр-перерахування — плоский список значень перерахування

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of string

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

order_numberobject (FilterId)

valueany

Приклад: 0

typestringобов’язковий

Приклад: integer

placeholderstring

Приклад: integer

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

client_branch_profile_idobject (FilterId)

valueany

Приклад: 0

typestringобов’язковий

Приклад: integer

placeholderstring

Приклад: integer

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

client_account_idobject (FilterId)

valueany

Приклад: 0

typestringобов’язковий

Приклад: integer

placeholderstring

Приклад: integer

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

operator_idobject (FilterSelectInteger)

valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object

valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

courier_idobject (FilterSelectInteger)

valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object

valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

promo_codeobject (FilterInput)

valuestring

Приклад: example

typestringобов’язковий

Приклад: integer or string

placeholderstring

Приклад: string

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

hide_completed_ordersobject (FilterBooleanCheckbox)

valueboolean

Для true передайте 1 в запросе, для false ничего не передавайте

Приклад: false

typestringобов’язковий

Приклад: checkbox

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

downloadobject (FilterButtonDownloadCsv)

Кнопка завантаження вибірки: при натисканні передайте download=yes

valuestring

Приклад: Download

typestringобов’язковий

Приклад: button_download_csv

listarray of object

idintegerобов’язковий

Приклад: 12863367

branch_idintegerобов’язковий

Приклад: 9054

sms_statusstring (OrderSmsStatus) обов’язковий

Статус SMS

Значення:errorsuccessempty_fieldswrong_phonewrong_api_fieldsserver_not_availablenot_enough_moneywaitingneed_phoneoperators_not_connected_to_botssend_via_bots_failedsending_via_botssent_via_botssent_via_maxsent_via_telegramunsupported_sms_serviceapi_disabledwrong_sender_name

email_statusstring (OrderEmailStatus) обов’язковий

Статус email

Значення:errorwaitingsuccessneed_email

order_statusstring (OrderStatus) обов’язковий

Значення:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Приклад: confirmed

cart_totalnumberобов’язковий

Приклад: 100.55

order_numberinteger

Приклад: 1

date_creationstring (DataTimeFormatSQL) обов’язковий

Приклад: 2024-05-02 08:31:16

date_preorderstring (DataTimeFormatSQL)

Приклад: 2024-05-02 08:31:16

timestamp_countdownintegerобов’язковий

Приклад: 1718625496

time_preorderinteger

Приклад: 7160

seconds_for_timerinteger

Приклад: -14500

last_order_doneboolean

Приклад: true

minutes_to_doneinteger

Приклад: 60

payment_statusstring (OrderPayment) обов’язковий

Статус оплати: не оплачено, очікує, оплачено

Значення:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Спосіб оплати

Значення:cashonlinecard_upon_receipt

platformstring (Platform) обов’язковий

Значення:androidiosallmobile_appssitesocial_apps

Приклад: all

operator_phone_format_idinteger (PhoneFormatId)

Код країни: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

Приклад: 1

operator_phone_numberstring

Приклад: 9114579423

operator_emailstring

Приклад: email@example.com

percent_rateintegerобов’язковий

Приклад: 4

sender_namestring

Приклад: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Приклад: 1

sender_phone_numberstring

Приклад: 9114579423

sender_emailstring

Приклад: email@example.com

recipient_namestring

Приклад: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Приклад: 1

recipient_phone_numberstring

Приклад: 9114579423

address_zip_codestring

Приклад: 236039

address_line_1string

Приклад: Korablestroiteley st. 9 bld. 2

address_line_2string

Приклад: Korablestroiteley st. 9 bld. 2

address_streetstring

Приклад: Partizanskaya street

address_housestring

Приклад: 20

address_buildingstring

Приклад: 20

address_entrance_numberstring

Приклад: 20

address_entrance_codestring

Приклад: 1234

address_floorstring

Приклад: 10

address_apartmentstring

Приклад: 10

additional_changestring

Приклад: 100

additional_personsstring

Приклад: 2

additional_commentstring

Приклад: Test order, remove

additional_greeting_cardstring

Приклад: example

additional_discountstring

Приклад: example

tokenstring

Приклад: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) обов’язковий

Спосіб доставки: no — ні, all — всі, courier — кур'єр, pickup — самовивіз

Значення:noallcourierpickup

phone_settingsobject

mask_enableboolean

Приклад: true

formatboolean

Приклад: true

internationalboolean

Приклад: true

branch_namestring

Приклад: Green Basket | Main

chain_namestringобов’язковий

Приклад: Green Basket

city_namestringобов’язковий

Приклад: Voronezh

courier_namestring

Приклад: courier name

district_namestring

Приклад: Voronezh-Uh

district_idinteger

Приклад: 55329

application_uuidstring

Приклад: 03addc0d-1051-4534-9ba8-792b763a274b

paginationobject (PaginationCursor)

max_countintegerобов’язковий

Кількість елементів на сторінці

Приклад: 30

cursorintegerобов’язковийможе бути null

Курсор, з яким запитано поточну сторінку; null — для першої сторінки

next_cursorintegerобов’язковийможе бути null

id останнього рядка на цій сторінці: передайте його з direction=next, щоб перейти вперед; null — якщо далі нічого немає

Приклад: 84512

previous_cursorintegerобов’язковийможе бути null

id першого рядка на цій сторінці: передайте його з direction=previous, щоб перейти назад; null — якщо раніше нічого немає

Приклад: 84543

has_nextbooleanобов’язковий

Чи є наступна сторінка

Приклад: true

has_previousbooleanобов’язковий

Чи є попередня сторінка

Приклад: false

curl -X GET 'https://foodsoul.pro/api/crm/v2/orders' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: uk' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/orders', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'uk',
        'role' => 'partner',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/orders", {
    method: "GET",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "uk",
        "role": "partner"
    },
})
const data = await response.json()

import requests

response = requests.request(
    "GET",
    "https://foodsoul.pro/api/crm/v2/orders",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "uk",
        "role": "partner",
    },
)
data = response.json()

Відповідь 200

{
  "status": "success",
  "data": {
    "filters": {
      "date_creation_from": {
        "value": "2026-08-01 00:00:00",
        "type": "date",
        "mode": "value_required"
      },
      "date_creation_to": {
        "value": "2026-08-31 23:59:59",
        "type": "date",
        "mode": "value_required"
      },
      "date_creation_range": {
        "value": "today",
        "default": "today",
        "type": "select",
        "mode": "value_required",
        "option": [
          {
            "value": "today",
            "date_from": "25/08/2026"
          }
        ]
      },
      "chain_id": {
        "value": 8920,
        "type": "select",
        "option": [
          {
            "value": 8920,
            "name": "Green Basket | Kaliningrad"
          }
        ],
        "mode": "value_required"
      },
      "branch_id": {
        "value": 8920,
        "type": "select",
        "option": [
          {
            "value": 8920,
            "name": "Green Basket | Kaliningrad"
          }
        ],
        "mode": "value_required"
      },
      "phone_format_id": {
        "value": 8920,
        "type": "select",
        "option": [
          {
            "value": 8920,
            "name": "Green Basket | Kaliningrad"
          }
        ],
        "mode": "value_required"
      },
      "phone_number": {
        "value": "example",
        "type": "integer or string",
        "placeholder": "string",
        "mode": "value_required"
      },
      "email": {
        "value": "example",
        "type": "integer or string",
        "placeholder": "string",
        "mode": "value_required"
      },
      "order_status": {
        "value": "example",
        "type": "select",
        "option": [
          "string"
        ],
        "mode": "value_required"
      },
      "platform": {
        "value": "example",
        "type": "select",
        "option": [
          "string"
        ],
        "mode": "value_required"
      },
      "delivery_method": {
        "value": "example",
        "type": "select",
        "option": [
          "string"
        ],
        "mode": "value_required"
      },
      "payment_status": {
        "value": "example",
        "type": "select",
        "option": [
          "string"
        ],
        "mode": "value_required"
      },
      "order_number": {
        "value": 0,
        "type": "integer",
        "placeholder": "integer",
        "mode": "value_required"
      },
      "client_branch_profile_id": {
        "value": 0,
        "type": "integer",
        "placeholder": "integer",
        "mode": "value_required"
      },
      "client_account_id": {
        "value": 0,
        "type": "integer",
        "placeholder": "integer",
        "mode": "value_required"
      },
      "operator_id": {
        "value": 8920,
        "type": "select",
        "option": [
          {
            "value": 8920,
            "name": "Green Basket | Kaliningrad"
          }
        ],
        "mode": "value_required"
      },
      "courier_id": {
        "value": 8920,
        "type": "select",
        "option": [
          {
            "value": 8920,
            "name": "Green Basket | Kaliningrad"
          }
        ],
        "mode": "value_required"
      },
      "promo_code": {
        "value": "example",
        "type": "integer or string",
        "placeholder": "string",
        "mode": "value_required"
      },
      "hide_completed_orders": {
        "value": false,
        "type": "checkbox",
        "mode": "value_required"
      },
      "download": {
        "value": "Download",
        "type": "button_download_csv"
      }
    },
    "list": [
      {
        "id": 12863367,
        "branch_id": 9054,
        "sms_status": "error",
        "email_status": "error",
        "order_status": "confirmed",
        "cart_total": 100.55,
        "order_number": 1,
        "date_creation": "2024-05-02 08:31:16",
        "date_preorder": "2024-05-02 08:31:16",
        "timestamp_countdown": 1718625496,
        "time_preorder": 7160,
        "seconds_for_timer": -14500,
        "last_order_done": true,
        "minutes_to_done": 60,
        "payment_status": "not_paid",
        "payment_method": "cash",
        "platform": "all",
        "operator_phone_format_id": 1,
        "operator_phone_number": "9114579423",
        "operator_email": "email@example.com",
        "percent_rate": 4,
        "sender_name": "John Doe",
        "sender_phone_format_id": 1,
        "sender_phone_number": "9114579423",
        "sender_email": "email@example.com",
        "recipient_name": "John Doe",
        "recipient_phone_format_id": 1,
        "recipient_phone_number": "9114579423",
        "address_zip_code": "236039",
        "address_line_1": "Korablestroiteley st. 9 bld. 2",
        "address_line_2": "Korablestroiteley st. 9 bld. 2",
        "address_street": "Partizanskaya street",
        "address_house": "20",
        "address_building": "20",
        "address_entrance_number": "20",
        "address_entrance_code": "1234",
        "address_floor": "10",
        "address_apartment": "10",
        "additional_change": "100",
        "additional_persons": "2",
        "additional_comment": "Test order, remove",
        "additional_greeting_card": "example",
        "additional_discount": "example",
        "token": "72901fbe661d3e142ea9af5248856f20",
        "delivery_method": "no",
        "phone_settings": {
          "mask_enable": true,
          "format": true,
          "international": true
        },
        "branch_name": "Green Basket | Main",
        "chain_name": "Green Basket",
        "city_name": "Voronezh",
        "courier_name": "courier name",
        "district_name": "Voronezh-Uh",
        "district_id": 55329,
        "application_uuid": "03addc0d-1051-4534-9ba8-792b763a274b"
      }
    ],
    "pagination": {
      "max_count": 30,
      "cursor": 0,
      "next_cursor": 84512,
      "previous_cursor": 84543,
      "has_next": true,
      "has_previous": false
    }
  }
}

Запити надсилаються на foodsoul.pro — це хост цього порталу, інший обрати неможливо.