Bestellliste abrufen

GET/api/crm/v2/ordersv2

operationId: orders.default

Autorisierung

api-token + language + role

Abfrageparameter

cursorinteger

Position, ab der die Seite gelesen wird: pagination.next_cursor — vorwärts, pagination.previous_cursor — rückwärts; für die erste Seite nicht übergeben. Dies ist eine Vergleichsgrenze, kein Verweis auf eine Zeile: Die Zeile, auf die der Wert zeigt, kann nicht existieren, daher öffnet ein veralteter Verweis trotzdem die Seite an derselben Stelle. Fehler 346 wird nur zurückgegeben, wenn der Wert nicht als positive ganze Zahl interpretiert werden kann.

Beispiel: 84512

directionstring

Leserichtung ab dem Cursor; last öffnet das Ende der Liste und ignoriert den Cursor

Werte:nextpreviouslast

Standardmäßig: next

date_creation_fromstring

Beispiel: 25/04/2024

date_creation_tostring

Beispiel: 26/04/2024

chain_idinteger

branch_idinteger

phone_format_idinteger

phone_numberstring

emailstring

order_statusstring (OrderStatus)

Bestellstatus: unterwegs, abgeschlossen, Zusammenstellung, in der Küche, nicht bearbeitet, versandbereit, wartet auf Versand in die Küche, wartet auf Nachbesserung, storniert, bestätigt, zubereitet

Werte:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Beispiel: confirmed

platformstring (OrderPlatform)

Bestellplattform

Werte:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Lieferart: Kurier oder Selbstabholung

Werte:courierpickup

payment_statusstring (OrderPayment)

Zahlungsstatus: nicht bezahlt, ausstehend, bezahlt

Werte:not_paidwaitingpaid

order_numberinteger

client_branch_profile_idinteger

client_account_idinteger

operator_idinteger

courier_idinteger

promo_codestring

Filtert Bestellungen nach dem Promo-Code (genaue Übereinstimmung mit dem im Auftrag angewendeten Promo-Code)

Beispiel: Promo1

hide_completed_ordersstring

Werte:true

Beispiel: true

downloadstring

Werte:yes

Beispiel: yes

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

filtersobject

date_creation_fromobject (FilterDateFrom)

valuestringkann null sein

Beispiel: 2026-08-01 00:00:00

typestringerforderlich

Beispiel: date

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

date_creation_toobject (FilterDateTo)

valuestringkann null sein

Beispiel: 2026-08-31 23:59:59

typestringerforderlich

Beispiel: date

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

date_creation_rangeobject (FilterDateRange)

Vordefinierte Datumsfilterzeiträume; die Untergrenze wird in der Zeitzone des Benutzers berechnet. value — der Zeitraum, dem die aktuellen *_from und *_to entsprechen; null — benutzerdefinierter Zeitraum. default — der Zeitraum, den der Server bei Anfragen ohne Datumsangaben verwendet: Er wird auch beim ersten Laden des Bereichs angewendet und bei Zurücksetzen wiederhergestellt. Das obere Ende des Zeitraums entspricht immer dem aktuellen Tag des Benutzers, daher enthält option dieses nicht: Für vordefinierte Zeiträume muss *_to nicht übergeben werden, der Server setzt es automatisch. Zeiträume, die länger als ein Jahr sind, werden an der aktuellen Grenze abgeschnitten.

valuestring (DateRange) kann null sein

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

defaultstring (DateRange) erforderlich

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

typestringerforderlich

Beispiel: select

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

optionarray of objecterforderlich

valuestring (DateRange) erforderlich

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

date_fromstringerforderlich

Beispiel: 25/08/2026

chain_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

branch_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

phone_format_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

phone_numberobject (FilterInput)

valuestring

Beispiel: example

typestringerforderlich

Beispiel: integer or string

placeholderstring

Beispiel: string

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

emailobject (FilterInput)

valuestring

Beispiel: example

typestringerforderlich

Beispiel: integer or string

placeholderstring

Beispiel: string

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

order_statusobject (FilterEnum)

Filter-Enum — flache Liste von Enumerationswerten

valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of string

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

platformobject (FilterEnum)

Filter-Enum — flache Liste von Enumerationswerten

valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of string

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

delivery_methodobject (FilterEnum)

Filter-Enum — flache Liste von Enumerationswerten

valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of string

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

payment_statusobject (FilterEnum)

Filter-Enum — flache Liste von Enumerationswerten

valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of string

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

order_numberobject (FilterId)

valueany

Beispiel: 0

typestringerforderlich

Beispiel: integer

placeholderstring

Beispiel: integer

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

client_branch_profile_idobject (FilterId)

valueany

Beispiel: 0

typestringerforderlich

Beispiel: integer

placeholderstring

Beispiel: integer

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

client_account_idobject (FilterId)

valueany

Beispiel: 0

typestringerforderlich

Beispiel: integer

placeholderstring

Beispiel: integer

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

operator_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

courier_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

promo_codeobject (FilterInput)

valuestring

Beispiel: example

typestringerforderlich

Beispiel: integer or string

placeholderstring

Beispiel: string

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

hide_completed_ordersobject (FilterBooleanCheckbox)

valueboolean

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

Beispiel: false

typestringerforderlich

Beispiel: checkbox

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

downloadobject (FilterButtonDownloadCsv)

Download-Button für die Auswahl: Beim Klicken übergeben Sie download=yes

valuestring

Beispiel: Download

typestringerforderlich

Beispiel: button_download_csv

listarray of object

idintegererforderlich

Beispiel: 12863367

branch_idintegererforderlich

Beispiel: 9054

sms_statusstring (OrderSmsStatus) erforderlich

SMS-Status

Werte: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) erforderlich

E-Mail-Status

Werte:errorwaitingsuccessneed_email

order_statusstring (OrderStatus) erforderlich

Werte:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Beispiel: confirmed

cart_totalnumbererforderlich

Beispiel: 100.55

order_numberinteger

Beispiel: 1

date_creationstring (DataTimeFormatSQL) erforderlich

Beispiel: 2024-05-02 08:31:16

date_preorderstring (DataTimeFormatSQL)

Beispiel: 2024-05-02 08:31:16

timestamp_countdownintegererforderlich

Beispiel: 1718625496

time_preorderinteger

Beispiel: 7160

seconds_for_timerinteger

Beispiel: -14500

last_order_doneboolean

Beispiel: true

minutes_to_doneinteger

Beispiel: 60

payment_statusstring (OrderPayment) erforderlich

Zahlungsstatus: nicht bezahlt, ausstehend, bezahlt

Werte:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Zahlungsmethode

Werte:cashonlinecard_upon_receipt

platformstring (Platform) erforderlich

Werte:androidiosallmobile_appssitesocial_apps

Beispiel: all

operator_phone_format_idinteger (PhoneFormatId)

Ländercode: 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)

Beispiel: 1

operator_phone_numberstring

Beispiel: 9114579423

operator_emailstring

Beispiel: email@example.com

percent_rateintegererforderlich

Beispiel: 4

sender_namestring

Beispiel: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Beispiel: 1

sender_phone_numberstring

Beispiel: 9114579423

sender_emailstring

Beispiel: email@example.com

recipient_namestring

Beispiel: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Beispiel: 1

recipient_phone_numberstring

Beispiel: 9114579423

address_zip_codestring

Beispiel: 236039

address_line_1string

Beispiel: Korablestroiteley st. 9 bld. 2

address_line_2string

Beispiel: Korablestroiteley st. 9 bld. 2

address_streetstring

Beispiel: Partizanskaya street

address_housestring

Beispiel: 20

address_buildingstring

Beispiel: 20

address_entrance_numberstring

Beispiel: 20

address_entrance_codestring

Beispiel: 1234

address_floorstring

Beispiel: 10

address_apartmentstring

Beispiel: 10

additional_changestring

Beispiel: 100

additional_personsstring

Beispiel: 2

additional_commentstring

Beispiel: Test order, remove

additional_greeting_cardstring

Beispiel: example

additional_discountstring

Beispiel: example

tokenstring

Beispiel: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) erforderlich

Liefermethode: no — keine, all — alle, courier — Kurier, pickup — Abholung

Werte:noallcourierpickup

phone_settingsobject

mask_enableboolean

Beispiel: true

formatboolean

Beispiel: true

internationalboolean

Beispiel: true

branch_namestring

Beispiel: Green Basket | Main

chain_namestringerforderlich

Beispiel: Green Basket

city_namestringerforderlich

Beispiel: Voronezh

courier_namestring

Beispiel: courier name

district_namestring

Beispiel: Voronezh-Uh

district_idinteger

Beispiel: 55329

application_uuidstring

Beispiel: 03addc0d-1051-4534-9ba8-792b763a274b

paginationobject (PaginationCursor)

max_countintegererforderlich

Anzahl der Elemente pro Seite

Beispiel: 30

cursorintegererforderlichkann null sein

Der Cursor, mit dem die aktuelle Seite angefordert wurde; null — für die erste Seite

next_cursorintegererforderlichkann null sein

id der letzten Zeile auf dieser Seite: Übergeben Sie ihn mit direction=next, um vorwärts zu blättern; null — wenn es keine weiteren Einträge gibt

Beispiel: 84512

previous_cursorintegererforderlichkann null sein

Die id der ersten Zeile auf dieser Seite: Übergeben Sie sie mit direction=previous, um zurückzugehen; null, wenn es nichts davor gibt

Beispiel: 84543

has_nextbooleanerforderlich

Gibt es eine nächste Seite

Beispiel: true

has_previousbooleanerforderlich

Gibt es eine vorherige Seite

Beispiel: false

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

Antwort 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
    }
  }
}

Anfragen werden an foodsoul.pro gesendet – dies ist der Host dieses Portals, ein anderer kann nicht ausgewählt werden.