Получить список заказов

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.ru/api/crm/v2/orders' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: ru' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

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

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

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

import requests

response = requests.request(
    "GET",
    "https://foodsoul.ru/api/crm/v2/orders",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "ru",
        "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.ru — хост этого портала, другой выбрать нельзя.