Pobierz listę zamówień

GET/api/crm/v2/ordersv2

operationId: orders.default

Autoryzacja

api-token + language + role

Parametry zapytania

cursorinteger

Pozycja, od której czytana jest strona: pagination.next_cursor — do przodu, pagination.previous_cursor — do tyłu; dla pierwszej strony nie przekazuj. To jest granica porównania, a nie odnośnik do rekordu: rekord wskazywany przez wartość może nie istnieć, dlatego nieaktualny odnośnik nadal otwiera stronę od tego samego miejsca. Błąd 346 jest zwracany tylko wtedy, gdy wartość nie może zostać zinterpretowana jako dodatnia liczba całkowita.

Przykład: 84512

directionstring

Kierunek odczytu od kursora; last otwiera koniec listy i ignoruje kursor

Wartości:nextpreviouslast

Domyślnie: next

date_creation_fromstring

Przykład: 25/04/2024

date_creation_tostring

Przykład: 26/04/2024

chain_idinteger

branch_idinteger

phone_format_idinteger

phone_numberstring

emailstring

order_statusstring (OrderStatus)

Status zamówienia: w drodze, zrealizowane, kompletowanie, na kuchni, nieprzetworzone, gotowe do wysyłki, oczekuje na wysłanie do kuchni, oczekuje na poprawkę, anulowane, potwierdzone, przygotowane

Wartości:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Przykład: confirmed

platformstring (OrderPlatform)

Platforma zamówień

Wartości:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Sposób dostawy: kurier lub odbiór osobisty

Wartości:courierpickup

payment_statusstring (OrderPayment)

Status płatności: nieopłacone, oczekuje, opłacone

Wartości:not_paidwaitingpaid

order_numberinteger

client_branch_profile_idinteger

client_account_idinteger

operator_idinteger

courier_idinteger

promo_codestring

Filtruj zamówienia według kodu promocyjnego (dokładne dopasowanie do kodu promocyjnego użytego w promocjach zamówienia)

Przykład: Promo1

hide_completed_ordersstring

Wartości:true

Przykład: true

downloadstring

Wartości:yes

Przykład: yes

Odpowiedzi

object

statusstringwymagane

Wartości:successerror

Przykład: success

dataobject

filtersobject

date_creation_fromobject (FilterDateFrom)

valuestringmoże być null

Przykład: 2026-08-01 00:00:00

typestringwymagane

Przykład: date

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

date_creation_toobject (FilterDateTo)

valuestringmoże być null

Przykład: 2026-08-31 23:59:59

typestringwymagane

Przykład: date

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

date_creation_rangeobject (FilterDateRange)

Gotowe okresy filtrowania według daty; dolna granica jest obliczana w strefie czasowej użytkownika. value — okres, któremu odpowiadają bieżące *_from i *_to; null — dowolny okres. default — okres, który serwer ustawia w zapytaniu bez dat: jest stosowany przy pierwszym ładowaniu sekcji oraz po resecie. Górna granica okresu zawsze odpowiada bieżącemu dniu użytkownika, dlatego option jej nie zawiera: nie trzeba przekazywać *_to dla gotowego okresu, serwer ustawia ją samodzielnie. Okres dłuższy niż rok jest obcinany od najnowszej granicy.

valuestring (DateRange) może być null

Gotowy zakres dat do filtrowania. Nie posiada własnego parametru zapytania: dolna granica jest już obliczona i przekazywana w option, a następnie podstawiana do *_from. Górna granica nie jest przekazywana ani w odpowiedzi, ani w zapytaniu — zawsze jest równa bieżącemu dniu użytkownika i ustalana przez serwer.

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

defaultstring (DateRange) wymagane

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

typestringwymagane

Przykład: select

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

optionarray of objectwymagane

valuestring (DateRange) wymagane

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

date_fromstringwymagane

Przykład: 25/08/2026

chain_idobject (FilterSelectInteger)

valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object

valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

branch_idobject (FilterSelectInteger)

valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object

valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

phone_format_idobject (FilterSelectInteger)

valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object

valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

phone_numberobject (FilterInput)

valuestring

Przykład: example

typestringwymagane

Przykład: integer or string

placeholderstring

Przykład: string

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

emailobject (FilterInput)

valuestring

Przykład: example

typestringwymagane

Przykład: integer or string

placeholderstring

Przykład: string

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

order_statusobject (FilterEnum)

Filtr-wyliczenie — płaska lista wartości wyliczenia

valuestring

Przykład: example

typestringwymagane

Przykład: select

optionarray of string

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

platformobject (FilterEnum)

Filtr-wyliczenie — płaska lista wartości wyliczenia

valuestring

Przykład: example

typestringwymagane

Przykład: select

optionarray of string

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

delivery_methodobject (FilterEnum)

Filtr-wyliczenie — płaska lista wartości wyliczenia

valuestring

Przykład: example

typestringwymagane

Przykład: select

optionarray of string

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

payment_statusobject (FilterEnum)

Filtr-wyliczenie — płaska lista wartości wyliczenia

valuestring

Przykład: example

typestringwymagane

Przykład: select

optionarray of string

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

order_numberobject (FilterId)

valueany

Przykład: 0

typestringwymagane

Przykład: integer

placeholderstring

Przykład: integer

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

client_branch_profile_idobject (FilterId)

valueany

Przykład: 0

typestringwymagane

Przykład: integer

placeholderstring

Przykład: integer

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

client_account_idobject (FilterId)

valueany

Przykład: 0

typestringwymagane

Przykład: integer

placeholderstring

Przykład: integer

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

operator_idobject (FilterSelectInteger)

valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object

valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

courier_idobject (FilterSelectInteger)

valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object

valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

promo_codeobject (FilterInput)

valuestring

Przykład: example

typestringwymagane

Przykład: integer or string

placeholderstring

Przykład: string

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

hide_completed_ordersobject (FilterBooleanCheckbox)

valueboolean

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

Przykład: false

typestringwymagane

Przykład: checkbox

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

downloadobject (FilterButtonDownloadCsv)

Przycisk pobierania wyników: po kliknięciu przekaż download=yes

valuestring

Przykład: Download

typestringwymagane

Przykład: button_download_csv

listarray of object

idintegerwymagane

Przykład: 12863367

branch_idintegerwymagane

Przykład: 9054

sms_statusstring (OrderSmsStatus) wymagane

Status SMS

Wartości: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) wymagane

Status email

Wartości:errorwaitingsuccessneed_email

order_statusstring (OrderStatus) wymagane

Wartości:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Przykład: confirmed

cart_totalnumberwymagane

Przykład: 100.55

order_numberinteger

Przykład: 1

date_creationstring (DataTimeFormatSQL) wymagane

Przykład: 2024-05-02 08:31:16

date_preorderstring (DataTimeFormatSQL)

Przykład: 2024-05-02 08:31:16

timestamp_countdownintegerwymagane

Przykład: 1718625496

time_preorderinteger

Przykład: 7160

seconds_for_timerinteger

Przykład: -14500

last_order_doneboolean

Przykład: true

minutes_to_doneinteger

Przykład: 60

payment_statusstring (OrderPayment) wymagane

Status płatności: nieopłacone, oczekuje, opłacone

Wartości:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Metoda płatności

Wartości:cashonlinecard_upon_receipt

platformstring (Platform) wymagane

Wartości:androidiosallmobile_appssitesocial_apps

Przykład: all

operator_phone_format_idinteger (PhoneFormatId)

Kod kraju: 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)

Przykład: 1

operator_phone_numberstring

Przykład: 9114579423

operator_emailstring

Przykład: email@example.com

percent_rateintegerwymagane

Przykład: 4

sender_namestring

Przykład: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Przykład: 1

sender_phone_numberstring

Przykład: 9114579423

sender_emailstring

Przykład: email@example.com

recipient_namestring

Przykład: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Przykład: 1

recipient_phone_numberstring

Przykład: 9114579423

address_zip_codestring

Przykład: 236039

address_line_1string

Przykład: Korablestroiteley st. 9 bld. 2

address_line_2string

Przykład: Korablestroiteley st. 9 bld. 2

address_streetstring

Przykład: Partizanskaya street

address_housestring

Przykład: 20

address_buildingstring

Przykład: 20

address_entrance_numberstring

Przykład: 20

address_entrance_codestring

Przykład: 1234

address_floorstring

Przykład: 10

address_apartmentstring

Przykład: 10

additional_changestring

Przykład: 100

additional_personsstring

Przykład: 2

additional_commentstring

Przykład: Test order, remove

additional_greeting_cardstring

Przykład: example

additional_discountstring

Przykład: example

tokenstring

Przykład: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) wymagane

Metoda dostawy: no — brak, all — wszystkie, courier — kurier, pickup — odbiór osobisty

Wartości:noallcourierpickup

phone_settingsobject

mask_enableboolean

Przykład: true

formatboolean

Przykład: true

internationalboolean

Przykład: true

branch_namestring

Przykład: Green Basket | Main

chain_namestringwymagane

Przykład: Green Basket

city_namestringwymagane

Przykład: Voronezh

courier_namestring

Przykład: courier name

district_namestring

Przykład: Voronezh-Uh

district_idinteger

Przykład: 55329

application_uuidstring

Przykład: 03addc0d-1051-4534-9ba8-792b763a274b

paginationobject (PaginationCursor)

max_countintegerwymagane

Liczba elementów na stronie

Przykład: 30

cursorintegerwymaganemoże być null

Kursor użyty do pobrania bieżącej strony; null — dla pierwszej strony

next_cursorintegerwymaganemoże być null

id ostatniego wiersza na tej stronie: przekaż go z direction=next, aby przejść dalej; null — jeśli nie ma już dalszych danych

Przykład: 84512

previous_cursorintegerwymaganemoże być null

id pierwszego wiersza na tej stronie: przekaż go z direction=previous, aby przejść wstecz; null — jeśli wcześniej nic nie ma

Przykład: 84543

has_nextbooleanwymagane

Czy istnieje następna strona

Przykład: true

has_previousbooleanwymagane

Czy istnieje poprzednia strona

Przykład: false

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

Odpowiedź 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
    }
  }
}

Żądania są wysyłane na foodsoul.pro — to jest host tego portalu, nie można wybrać innego.