Získat seznam objednávek

GET/api/crm/v2/ordersv2

operationId: orders.default

Autorizace

api-token + language + role

Parametry dotazu

cursorinteger

Pozice, od které se stránka čte: pagination.next_cursor — vpřed, pagination.previous_cursor — zpět; pro první stránku nepředávejte. Jedná se o hranici porovnání, nikoli odkaz na řádek: řádek, na který hodnota ukazuje, nemusí existovat, proto i zastaralý odkaz otevře stránku od stejného místa. Chyba 346 se vrací pouze v případě, že hodnotu nelze rozpoznat jako kladné celé číslo.

Příklad: 84512

directionstring

Směr čtení od kurzoru; last otevře konec seznamu a ignoruje kurzor

Hodnoty:nextpreviouslast

Ve výchozím nastavení: next

date_creation_fromstring

Příklad: 25/04/2024

date_creation_tostring

Příklad: 26/04/2024

chain_idinteger

branch_idinteger

phone_format_idinteger

phone_numberstring

emailstring

order_statusstring (OrderStatus)

Stav objednávky: na cestě, dokončeno, kompletace, v kuchyni, nezpracováno, připraveno k odeslání, čeká na odeslání do kuchyně, čeká na přepracování, zrušeno, potvrzeno, připraveno

Hodnoty:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Příklad: confirmed

platformstring (OrderPlatform)

Objednávková platforma

Hodnoty:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Způsob doručení: kurýr nebo osobní odběr

Hodnoty:courierpickup

payment_statusstring (OrderPayment)

Stav platby: nezaplaceno, čeká, zaplaceno

Hodnoty:not_paidwaitingpaid

order_numberinteger

client_branch_profile_idinteger

client_account_idinteger

operator_idinteger

courier_idinteger

promo_codestring

Filtr objednávek podle promo kódu (přesná shoda s promo kódem použitým na akce objednávky)

Příklad: Promo1

hide_completed_ordersstring

Hodnoty:true

Příklad: true

downloadstring

Hodnoty:yes

Příklad: yes

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

filtersobject

date_creation_fromobject (FilterDateFrom)

valuestringmůže být null

Příklad: 2026-08-01 00:00:00

typestringpovinné

Příklad: date

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

date_creation_toobject (FilterDateTo)

valuestringmůže být null

Příklad: 2026-08-31 23:59:59

typestringpovinné

Příklad: date

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

date_creation_rangeobject (FilterDateRange)

Přednastavená období filtru podle data; dolní hranice je vypočítána v časovém pásmu uživatele. value — období, kterému odpovídají aktuální *_from a *_to; null — vlastní období. default — období, které server nastaví v požadavku bez dat: použije se také při prvním načtení sekce a při resetování. Horní hranice období je vždy rovna aktuálnímu dni uživatele, proto ji option neobsahuje: pro přednastavené období není třeba předávat *_to, server ji nastaví sám. Období delší než jeden rok je zkráceno na straně novější hranice.

valuestring (DateRange) může být null

Předdefinované období filtru podle data. Nemá vlastní parametr dotazu: dolní hranice je již vypočítána v option a je použita v *_from. Horní hranice není vrácena v odpovědi ani odeslána v dotazu — vždy odpovídá aktuálnímu dni uživatele a je nastavena serverem.

Hodnoty:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Příklad: today

defaultstring (DateRange) povinné

Hodnoty:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Příklad: today

typestringpovinné

Příklad: select

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

optionarray of objectpovinné

valuestring (DateRange) povinné

Hodnoty:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Příklad: today

date_fromstringpovinné

Příklad: 25/08/2026

chain_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

branch_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

phone_format_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

phone_numberobject (FilterInput)

valuestring

Příklad: example

typestringpovinné

Příklad: integer or string

placeholderstring

Příklad: string

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

emailobject (FilterInput)

valuestring

Příklad: example

typestringpovinné

Příklad: integer or string

placeholderstring

Příklad: string

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

order_statusobject (FilterEnum)

Filtr-enum — plochý seznam hodnot výčtu

valuestring

Příklad: example

typestringpovinné

Příklad: select

optionarray of string

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

platformobject (FilterEnum)

Filtr-enum — plochý seznam hodnot výčtu

valuestring

Příklad: example

typestringpovinné

Příklad: select

optionarray of string

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

delivery_methodobject (FilterEnum)

Filtr-enum — plochý seznam hodnot výčtu

valuestring

Příklad: example

typestringpovinné

Příklad: select

optionarray of string

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

payment_statusobject (FilterEnum)

Filtr-enum — plochý seznam hodnot výčtu

valuestring

Příklad: example

typestringpovinné

Příklad: select

optionarray of string

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

order_numberobject (FilterId)

valueany

Příklad: 0

typestringpovinné

Příklad: integer

placeholderstring

Příklad: integer

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

client_branch_profile_idobject (FilterId)

valueany

Příklad: 0

typestringpovinné

Příklad: integer

placeholderstring

Příklad: integer

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

client_account_idobject (FilterId)

valueany

Příklad: 0

typestringpovinné

Příklad: integer

placeholderstring

Příklad: integer

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

operator_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

courier_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

promo_codeobject (FilterInput)

valuestring

Příklad: example

typestringpovinné

Příklad: integer or string

placeholderstring

Příklad: string

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

hide_completed_ordersobject (FilterBooleanCheckbox)

valueboolean

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

Příklad: false

typestringpovinné

Příklad: checkbox

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

downloadobject (FilterButtonDownloadCsv)

Tlačítko pro stažení výběru: při kliknutí předejte download=yes

valuestring

Příklad: Download

typestringpovinné

Příklad: button_download_csv

listarray of object

idintegerpovinné

Příklad: 12863367

branch_idintegerpovinné

Příklad: 9054

sms_statusstring (OrderSmsStatus) povinné

Stav SMS

Hodnoty: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) povinné

Stav e-mailu

Hodnoty:errorwaitingsuccessneed_email

order_statusstring (OrderStatus) povinné

Stav objednávky: na cestě, dokončeno, kompletace, v kuchyni, nezpracováno, připraveno k odeslání, čeká na odeslání do kuchyně, čeká na přepracování, zrušeno, potvrzeno, připraveno

Hodnoty:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Příklad: confirmed

cart_totalnumberpovinné

Příklad: 100.55

order_numberinteger

Příklad: 1

date_creationstring (DataTimeFormatSQL) povinné

Příklad: 2024-05-02 08:31:16

date_preorderstring (DataTimeFormatSQL)

Příklad: 2024-05-02 08:31:16

timestamp_countdownintegerpovinné

Příklad: 1718625496

time_preorderinteger

Příklad: 7160

seconds_for_timerinteger

Příklad: -14500

last_order_doneboolean

Příklad: true

minutes_to_doneinteger

Příklad: 60

payment_statusstring (OrderPayment) povinné

Stav platby: nezaplaceno, čeká, zaplaceno

Hodnoty:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Způsob platby

Hodnoty:cashonlinecard_upon_receipt

platformstring (Platform) povinné

Hodnoty:androidiosallmobile_appssitesocial_apps

Příklad: all

operator_phone_format_idinteger (PhoneFormatId)

Kód země: 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)

Příklad: 1

operator_phone_numberstring

Příklad: 9114579423

operator_emailstring

Příklad: email@example.com

percent_rateintegerpovinné

Příklad: 4

sender_namestring

Příklad: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Příklad: 1

sender_phone_numberstring

Příklad: 9114579423

sender_emailstring

Příklad: email@example.com

recipient_namestring

Příklad: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Příklad: 1

recipient_phone_numberstring

Příklad: 9114579423

address_zip_codestring

Příklad: 236039

address_line_1string

Příklad: Korablestroiteley st. 9 bld. 2

address_line_2string

Příklad: Korablestroiteley st. 9 bld. 2

address_streetstring

Příklad: Partizanskaya street

address_housestring

Příklad: 20

address_buildingstring

Příklad: 20

address_entrance_numberstring

Příklad: 20

address_entrance_codestring

Příklad: 1234

address_floorstring

Příklad: 10

address_apartmentstring

Příklad: 10

additional_changestring

Příklad: 100

additional_personsstring

Příklad: 2

additional_commentstring

Příklad: Test order, remove

additional_greeting_cardstring

Příklad: example

additional_discountstring

Příklad: example

tokenstring

Příklad: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) povinné

Způsob doručení: no — žádný, all — všechny, courier — kurýr, pickup — osobní odběr

Hodnoty:noallcourierpickup

phone_settingsobject

mask_enableboolean

Příklad: true

formatboolean

Příklad: true

internationalboolean

Příklad: true

branch_namestring

Příklad: Green Basket | Main

chain_namestringpovinné

Příklad: Green Basket

city_namestringpovinné

Příklad: Voronezh

courier_namestring

Příklad: courier name

district_namestring

Příklad: Voronezh-Uh

district_idinteger

Příklad: 55329

application_uuidstring

Příklad: 03addc0d-1051-4534-9ba8-792b763a274b

paginationobject (PaginationCursor)

max_countintegerpovinné

Počet položek na stránku

Příklad: 30

cursorintegerpovinnémůže být null

Kurzor, se kterým byla požadována aktuální stránka; null — pro první stránku

next_cursorintegerpovinnémůže být null

id posledního řádku na této stránce: předejte jej s direction=next pro přechod vpřed; null — pokud už nic dalšího není

Příklad: 84512

previous_cursorintegerpovinnémůže být null

id prvního řádku na této stránce: pošlete jej s direction=previous pro návrat zpět; null — pokud předtím nic není

Příklad: 84543

has_nextbooleanpovinné

Zda existuje další stránka

Příklad: true

has_previousbooleanpovinné

Zda existuje předchozí stránka

Příklad: false

curl -X GET 'https://foodsoul.ru/api/crm/v2/orders' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: cs' \
  -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' => 'cs',
        '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": "cs",
        "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": "cs",
        "role": "partner",
    },
)
data = response.json()

Odpověď 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
    }
  }
}

Žádosti jsou odesílány na foodsoul.ru — to je hostitel tohoto portálu, jiný vybrat nelze.