Sifarişlərin siyahısını əldə et

GET/api/crm/v2/ordersv2

operationId: orders.default

Avtorizasiya

api-token + language + role

Sorğu parametrləri

cursorinteger

Səhifəni oxumağa başlanacaq mövqe: pagination.next_cursor — irəli, pagination.previous_cursor — geri; ilk səhifə üçün göndərməyin. Bu, müqayisə sərhədidir, sətrin özü deyil: dəyərin göstərdiyi sətr mövcud olmaya bilər, buna görə köhnəlmiş istinad yenə də səhifəni həmin mövqedən açır. Yalnız dəyəri müsbət tam ədəd kimi təhlil etmək mümkün olmadıqda 346 xətası qaytarılır.

Nümunə: 84512

directionstring

Kursorun oxu istiqaməti; last siyahının sonunu açır və kursoru nəzərə almır

Dəyərlər:nextpreviouslast

Standart olaraq: next

date_creation_fromstring

Nümunə: 25/04/2024

date_creation_tostring

Nümunə: 26/04/2024

chain_idinteger

branch_idinteger

phone_format_idinteger

phone_numberstring

emailstring

order_statusstring (OrderStatus)

Sifariş statusu: yoldadır, tamamlandı, yığılır, mətbəxdədir, işlənməyib, göndərilməyə hazırdır, mətbəxə göndərilməyi gözləyir, yenidən hazırlanmanı gözləyir, ləğv edilib, təsdiqlənib, hazırlanıb

Dəyərlər:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Nümunə: confirmed

platformstring (OrderPlatform)

Sifariş platforması

Dəyərlər:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Çatdırılma üsulu: kuryer və ya özün götürmə

Dəyərlər:courierpickup

payment_statusstring (OrderPayment)

Ödəniş statusu: ödənilməyib, gözləyir, ödənilib

Dəyərlər:not_paidwaitingpaid

order_numberinteger

client_branch_profile_idinteger

client_account_idinteger

operator_idinteger

courier_idinteger

promo_codestring

Sifarişlərin promo koduna görə filtri (sifarişdə tətbiq olunan aksiya promo kodu ilə tam uyğunluq)

Nümunə: Promo1

hide_completed_ordersstring

Dəyərlər:true

Nümunə: true

downloadstring

Dəyərlər:yes

Nümunə: yes

Cavablar

object

statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject

filtersobject

date_creation_fromobject (FilterDateFrom)

valuestringnull ola bilər

Nümunə: 2026-08-01 00:00:00

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

date_creation_toobject (FilterDateTo)

valuestringnull ola bilər

Nümunə: 2026-08-31 23:59:59

typestringmütləq

Nümunə: date

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

date_creation_rangeobject (FilterDateRange)

Hazır tarix aralığı filtrləri; aşağı sərhəd istifadəçinin saat qurşağında hesablanır. value — cari *_from və *_to-ya uyğun olan aralıq; null — istənilən aralıq. default — serverin tarixsiz sorğuda təyin etdiyi aralıq: həmçinin bölmə ilk dəfə yüklənəndə və sıfırlama zamanı tətbiq olunur. Aralığın yuxarı sərhədi həmişə istifadəçinin cari gününə bərabərdir, buna görə option onu ehtiva etmir: hazır aralıq üçün *_to göndərmək lazım deyil, server onu özü təyin edir. Bir ildən uzun aralıq yeni sərhəd tərəfindən kəsilir.

valuestring (DateRange) null ola bilər

Hazır tarix aralığı filtri. Bunun üçün ayrıca sorğu parametri yoxdur: aşağı sərhəd artıq hesablanmış şəkildə option daxilində gəlir və *_from sahəsinə əlavə olunur. Yuxarı sərhəd nə cavabda, nə də sorğuda ötürülmür — o, həmişə istifadəçinin cari gününə bərabərdir və server tərəfindən təyin olunur.

Dəyərlər:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Nümunə: today

defaultstring (DateRange) mütləq

Dəyərlər:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Nümunə: today

typestringmütləq

Nümunə: select

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

optionarray of objectmütləq

valuestring (DateRange) mütləq

Dəyərlər:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Nümunə: today

date_fromstringmütləq

Nümunə: 25/08/2026

chain_idobject (FilterSelectInteger)

valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object

valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

branch_idobject (FilterSelectInteger)

valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object

valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

phone_format_idobject (FilterSelectInteger)

valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object

valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

phone_numberobject (FilterInput)

valuestring

Nümunə: example

typestringmütləq

Nümunə: integer or string

placeholderstring

Nümunə: string

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

emailobject (FilterInput)

valuestring

Nümunə: example

typestringmütləq

Nümunə: integer or string

placeholderstring

Nümunə: string

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

order_statusobject (FilterEnum)

Filtr-siyahı — düz siyahı enum dəyərləri

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of string

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

platformobject (FilterEnum)

Filtr-siyahı — düz siyahı enum dəyərləri

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of string

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

delivery_methodobject (FilterEnum)

Filtr-siyahı — düz siyahı enum dəyərləri

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of string

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

payment_statusobject (FilterEnum)

Filtr-siyahı — düz siyahı enum dəyərləri

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of string

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

order_numberobject (FilterId)

valueany

Nümunə: 0

typestringmütləq

Nümunə: integer

placeholderstring

Nümunə: integer

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

client_branch_profile_idobject (FilterId)

valueany

Nümunə: 0

typestringmütləq

Nümunə: integer

placeholderstring

Nümunə: integer

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

client_account_idobject (FilterId)

valueany

Nümunə: 0

typestringmütləq

Nümunə: integer

placeholderstring

Nümunə: integer

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

operator_idobject (FilterSelectInteger)

valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object

valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

courier_idobject (FilterSelectInteger)

valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object

valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

promo_codeobject (FilterInput)

valuestring

Nümunə: example

typestringmütləq

Nümunə: integer or string

placeholderstring

Nümunə: string

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

hide_completed_ordersobject (FilterBooleanCheckbox)

valueboolean

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

Nümunə: false

typestringmütləq

Nümunə: checkbox

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

downloadobject (FilterButtonDownloadCsv)

Seçimi yükləmə düyməsi: basıldıqda download=yes göndərin

valuestring

Nümunə: Download

typestringmütləq

Nümunə: button_download_csv

listarray of object

idintegermütləq

Nümunə: 12863367

branch_idintegermütləq

Nümunə: 9054

sms_statusstring (OrderSmsStatus) mütləq

SMS status

Dəyərlər: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) mütləq

Email status

Dəyərlər:errorwaitingsuccessneed_email

order_statusstring (OrderStatus) mütləq

Dəyərlər:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Nümunə: confirmed

cart_totalnumbermütləq

Nümunə: 100.55

order_numberinteger

Nümunə: 1

date_creationstring (DataTimeFormatSQL) mütləq

Nümunə: 2024-05-02 08:31:16

date_preorderstring (DataTimeFormatSQL)

Nümunə: 2024-05-02 08:31:16

timestamp_countdownintegermütləq

Nümunə: 1718625496

time_preorderinteger

Nümunə: 7160

seconds_for_timerinteger

Nümunə: -14500

last_order_doneboolean

Nümunə: true

minutes_to_doneinteger

Nümunə: 60

payment_statusstring (OrderPayment) mütləq

Ödəniş statusu: ödənilməyib, gözləyir, ödənilib

Dəyərlər:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Ödəniş üsulu

Dəyərlər:cashonlinecard_upon_receipt

platformstring (Platform) mütləq

Dəyərlər:androidiosallmobile_appssitesocial_apps

Nümunə: all

operator_phone_format_idinteger (PhoneFormatId)

Ölkə kodu: 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)

Nümunə: 1

operator_phone_numberstring

Nümunə: 9114579423

operator_emailstring

Nümunə: email@example.com

percent_rateintegermütləq

Nümunə: 4

sender_namestring

Nümunə: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Nümunə: 1

sender_phone_numberstring

Nümunə: 9114579423

sender_emailstring

Nümunə: email@example.com

recipient_namestring

Nümunə: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Nümunə: 1

recipient_phone_numberstring

Nümunə: 9114579423

address_zip_codestring

Nümunə: 236039

address_line_1string

Nümunə: Korablestroiteley st. 9 bld. 2

address_line_2string

Nümunə: Korablestroiteley st. 9 bld. 2

address_streetstring

Nümunə: Partizanskaya street

address_housestring

Nümunə: 20

address_buildingstring

Nümunə: 20

address_entrance_numberstring

Nümunə: 20

address_entrance_codestring

Nümunə: 1234

address_floorstring

Nümunə: 10

address_apartmentstring

Nümunə: 10

additional_changestring

Nümunə: 100

additional_personsstring

Nümunə: 2

additional_commentstring

Nümunə: Test order, remove

additional_greeting_cardstring

Nümunə: example

additional_discountstring

Nümunə: example

tokenstring

Nümunə: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) mütləq

Çatdırılma üsulu: no — yoxdur, all — hamısı, courier — kuryer, pickup — özün götür

Dəyərlər:noallcourierpickup

phone_settingsobject

mask_enableboolean

Nümunə: true

formatboolean

Nümunə: true

internationalboolean

Nümunə: true

branch_namestring

Nümunə: Green Basket | Main

chain_namestringmütləq

Nümunə: Green Basket

city_namestringmütləq

Nümunə: Voronezh

courier_namestring

Nümunə: courier name

district_namestring

Nümunə: Voronezh-Uh

district_idinteger

Nümunə: 55329

application_uuidstring

Nümunə: 03addc0d-1051-4534-9ba8-792b763a274b

paginationobject (PaginationCursor)

max_countintegermütləq

Səhifədəki elementlərin sayı

Nümunə: 30

cursorintegermütləqnull ola bilər

Cari səhifə üçün sorğu edilən kursor; birinci səhifə üçün null

next_cursorintegermütləqnull ola bilər

Bu səhifədəki son sətrin id-si: irəli keçmək üçün onu direction=next ilə göndərin; əgər davamı yoxdursa, null

Nümunə: 84512

previous_cursorintegermütləqnull ola bilər

Səhifədəki ilk sətrin id dəyəri: geri keçmək üçün onu direction=previous ilə göndərin; əvvəl heç nə yoxdursa, null göndərin

Nümunə: 84543

has_nextbooleanmütləq

Növbəti səhifə varmı

Nümunə: true

has_previousbooleanmütləq

Əvvəlki səhifə var

Nümunə: false

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

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

Sorğular foodsoul.pro ünvanına göndərilir — bu portalın hostudur, başqa birini seçmək mümkün deyil.