Ottenere l'elenco degli ordini

GET/api/crm/v2/ordersv2

operationId: orders.default

Autorizzazione

api-token + language + role

Parametri della richiesta

cursorinteger

Posizione da cui leggere la pagina: pagination.next_cursor — avanti, pagination.previous_cursor — indietro; per la prima pagina non specificare nulla. Questo è un limite di confronto, non un riferimento a una riga: la riga indicata dal valore potrebbe non esistere, quindi un riferimento obsoleto aprirà comunque la pagina dallo stesso punto. L’errore 346 viene restituito solo se il valore non può essere interpretato come un numero intero positivo.

Esempio: 84512

directionstring

Direzione di lettura dal cursore; last apre la fine della lista e ignora il cursore

Valori:nextpreviouslast

Per impostazione predefinita: next

date_creation_fromstring

Esempio: 25/04/2024

date_creation_tostring

Esempio: 26/04/2024

chain_idinteger

branch_idinteger

phone_format_idinteger

phone_numberstring

emailstring

order_statusstring (OrderStatus)

Stato dell'ordine: in consegna, completato, in preparazione, in cucina, non elaborato, pronto per la spedizione, in attesa di invio in cucina, in attesa di rifacimento, annullato, confermato, preparato

Valori:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Esempio: confirmed

platformstring (OrderPlatform)

Piattaforma di ordinazione

Valori:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Metodo di consegna: corriere o ritiro in sede

Valori:courierpickup

payment_statusstring (OrderPayment)

Stato del pagamento: non pagato, in attesa, pagato

Valori:not_paidwaitingpaid

order_numberinteger

client_branch_profile_idinteger

client_account_idinteger

operator_idinteger

courier_idinteger

promo_codestring

Filtro degli ordini per codice promozionale (corrispondenza esatta con il codice promozionale applicato alle promozioni dell'ordine)

Esempio: Promo1

hide_completed_ordersstring

Valori:true

Esempio: true

downloadstring

Valori:yes

Esempio: yes

Risposte

object

statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject

filtersobject

date_creation_fromobject (FilterDateFrom)

valuestringpuò essere nullo

Esempio: 2026-08-01 00:00:00

typestringobbligatorio

Esempio: date

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

date_creation_toobject (FilterDateTo)

valuestringpuò essere nullo

Esempio: 2026-08-31 23:59:59

typestringobbligatorio

Esempio: date

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

date_creation_rangeobject (FilterDateRange)

Periodi predefiniti per il filtro data; il limite inferiore è calcolato nel fuso orario dell’utente. value indica il periodo corrispondente agli attuali *_from e *_to; null indica un periodo personalizzato. default è il periodo che il server inserisce nella richiesta senza date: viene applicato al primo caricamento della sezione e al reset. Il limite superiore del periodo corrisponde sempre al giorno attuale dell’utente, quindi option non lo include: non è necessario trasmettere *_to per un periodo predefinito, il server lo imposta automaticamente. Un periodo superiore a un anno viene troncato dal lato più recente.

valuestring (DateRange) può essere nullo

Periodo di filtro data predefinito. Non ha un proprio parametro di richiesta: il limite inferiore viene già calcolato in option e inserito in *_from. Il limite superiore non viene trasmesso né nella risposta né nella richiesta: è sempre uguale al giorno corrente dell’utente e viene impostato dal server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Esempio: today

defaultstring (DateRange) obbligatorio

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Esempio: today

typestringobbligatorio

Esempio: select

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

optionarray of objectobbligatorio

valuestring (DateRange) obbligatorio

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Esempio: today

date_fromstringobbligatorio

Esempio: 25/08/2026

chain_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

branch_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

phone_format_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

phone_numberobject (FilterInput)

valuestring

Esempio: example

typestringobbligatorio

Esempio: integer or string

placeholderstring

Esempio: string

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

emailobject (FilterInput)

valuestring

Esempio: example

typestringobbligatorio

Esempio: integer or string

placeholderstring

Esempio: string

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

order_statusobject (FilterEnum)

Filtro enumerazione: elenco piatto di valori enumerati

valuestring

Esempio: example

typestringobbligatorio

Esempio: select

optionarray of string

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

platformobject (FilterEnum)

Filtro enumerazione: elenco piatto di valori enumerati

valuestring

Esempio: example

typestringobbligatorio

Esempio: select

optionarray of string

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

delivery_methodobject (FilterEnum)

Filtro enumerazione: elenco piatto di valori enumerati

valuestring

Esempio: example

typestringobbligatorio

Esempio: select

optionarray of string

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

payment_statusobject (FilterEnum)

Filtro enumerazione: elenco piatto di valori enumerati

valuestring

Esempio: example

typestringobbligatorio

Esempio: select

optionarray of string

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

order_numberobject (FilterId)

valueany

Esempio: 0

typestringobbligatorio

Esempio: integer

placeholderstring

Esempio: integer

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

client_branch_profile_idobject (FilterId)

valueany

Esempio: 0

typestringobbligatorio

Esempio: integer

placeholderstring

Esempio: integer

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

client_account_idobject (FilterId)

valueany

Esempio: 0

typestringobbligatorio

Esempio: integer

placeholderstring

Esempio: integer

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

operator_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

courier_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

promo_codeobject (FilterInput)

valuestring

Esempio: example

typestringobbligatorio

Esempio: integer or string

placeholderstring

Esempio: string

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

hide_completed_ordersobject (FilterBooleanCheckbox)

valueboolean

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

Esempio: false

typestringobbligatorio

Esempio: checkbox

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

downloadobject (FilterButtonDownloadCsv)

Pulsante di download della selezione: al clic, passa download=yes

valuestring

Esempio: Download

typestringobbligatorio

Esempio: button_download_csv

listarray of object

idintegerobbligatorio

Esempio: 12863367

branch_idintegerobbligatorio

Esempio: 9054

sms_statusstring (OrderSmsStatus) obbligatorio

Stato SMS

Valori: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) obbligatorio

Stato dell'email

Valori:errorwaitingsuccessneed_email

order_statusstring (OrderStatus) obbligatorio

Valori:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Esempio: confirmed

cart_totalnumberobbligatorio

Esempio: 100.55

order_numberinteger

Esempio: 1

date_creationstring (DataTimeFormatSQL) obbligatorio

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

date_preorderstring (DataTimeFormatSQL)

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

timestamp_countdownintegerobbligatorio

Esempio: 1718625496

time_preorderinteger

Esempio: 7160

seconds_for_timerinteger

Esempio: -14500

last_order_doneboolean

Esempio: true

minutes_to_doneinteger

Esempio: 60

payment_statusstring (OrderPayment) obbligatorio

Stato del pagamento: non pagato, in attesa, pagato

Valori:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Metodo di pagamento

Valori:cashonlinecard_upon_receipt

platformstring (Platform) obbligatorio

Valori:androidiosallmobile_appssitesocial_apps

Esempio: all

operator_phone_format_idinteger (PhoneFormatId)

Codice paese: 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)

Esempio: 1

operator_phone_numberstring

Esempio: 9114579423

operator_emailstring

Esempio: email@example.com

percent_rateintegerobbligatorio

Esempio: 4

sender_namestring

Esempio: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Esempio: 1

sender_phone_numberstring

Esempio: 9114579423

sender_emailstring

Esempio: email@example.com

recipient_namestring

Esempio: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Esempio: 1

recipient_phone_numberstring

Esempio: 9114579423

address_zip_codestring

Esempio: 236039

address_line_1string

Esempio: Korablestroiteley st. 9 bld. 2

address_line_2string

Esempio: Korablestroiteley st. 9 bld. 2

address_streetstring

Esempio: Partizanskaya street

address_housestring

Esempio: 20

address_buildingstring

Esempio: 20

address_entrance_numberstring

Esempio: 20

address_entrance_codestring

Esempio: 1234

address_floorstring

Esempio: 10

address_apartmentstring

Esempio: 10

additional_changestring

Esempio: 100

additional_personsstring

Esempio: 2

additional_commentstring

Esempio: Test order, remove

additional_greeting_cardstring

Esempio: example

additional_discountstring

Esempio: example

tokenstring

Esempio: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) obbligatorio

Metodo di consegna: no — nessuno, all — tutti, courier — corriere, pickup — ritiro

Valori:noallcourierpickup

phone_settingsobject

mask_enableboolean

Esempio: true

formatboolean

Esempio: true

internationalboolean

Esempio: true

branch_namestring

Esempio: Green Basket | Main

chain_namestringobbligatorio

Esempio: Green Basket

city_namestringobbligatorio

Esempio: Voronezh

courier_namestring

Esempio: courier name

district_namestring

Esempio: Voronezh-Uh

district_idinteger

Esempio: 55329

application_uuidstring

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

paginationobject (PaginationCursor)

max_countintegerobbligatorio

Numero di elementi per pagina

Esempio: 30

cursorintegerobbligatoriopuò essere nullo

Cursore utilizzato per richiedere la pagina corrente; null — per la prima pagina

next_cursorintegerobbligatoriopuò essere nullo

id dell'ultima riga in questa pagina: passalo con direction=next per andare avanti; null se non ci sono altri dati

Esempio: 84512

previous_cursorintegerobbligatoriopuò essere nullo

id della prima riga in questa pagina: passalo con direction=previous per tornare indietro; null — se non ci sono elementi precedenti

Esempio: 84543

has_nextbooleanobbligatorio

C'è una pagina successiva

Esempio: true

has_previousbooleanobbligatorio

C'è una pagina precedente

Esempio: false

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

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

Le richieste vengono inviate a foodsoul.ru, che è l’host di questo portale; non è possibile sceglierne un altro.