Sipariş listesini al

GET/api/crm/v2/ordersv2

operationId: orders.default

Yetkilendirme

api-token + language + role

Sorgu parametreleri

cursorinteger

Sayfanın okunmaya başlanacağı konum: ileri gitmek için pagination.next_cursor, geri gitmek için pagination.previous_cursor; ilk sayfa için göndermeyin. Bu bir karşılaştırma sınırıdır, satır bağlantısı değildir: değerin işaret ettiği satır mevcut olmayabilir, bu nedenle eski bir bağlantı yine de aynı yerden sayfayı açar. 346 hatası yalnızca değer pozitif bir tam sayı olarak ayrıştırılamazsa döner.

Örnek: 84512

directionstring

Okuma yönü imleçten itibaren; last listenin sonunu açar ve imleci yok sayar

Değerler:nextpreviouslast

Varsayılan: next

date_creation_fromstring

Örnek: 25/04/2024

date_creation_tostring

Örnek: 26/04/2024

chain_idinteger

branch_idinteger

phone_format_idinteger

phone_numberstring

emailstring

order_statusstring (OrderStatus)

Sipariş durumu: yolda, tamamlandı, hazırlanıyor, mutfakta, işlenmedi, gönderime hazır, mutfağa gönderilmeyi bekliyor, yeniden yapılmayı bekliyor, iptal edildi, onaylandı, hazırlandı

Değerler:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Örnek: confirmed

platformstring (OrderPlatform)

Sipariş platformu

Değerler:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Teslimat yöntemi: kurye veya self-servis

Değerler:courierpickup

payment_statusstring (OrderPayment)

Ödeme durumu: ödenmedi, beklemede, ödendi

Değerler:not_paidwaitingpaid

order_numberinteger

client_branch_profile_idinteger

client_account_idinteger

operator_idinteger

courier_idinteger

promo_codestring

Siparişleri promosyon koduna göre filtreleme (siparişteki kampanyalara uygulanan promosyon kodu ile tam eşleşme)

Örnek: Promo1

hide_completed_ordersstring

Değerler:true

Örnek: true

downloadstring

Değerler:yes

Örnek: yes

Yanıtlar

object

statusstringzorunlu

Değerler:successerror

Örnek: success

dataobject

filtersobject

date_creation_fromobject (FilterDateFrom)

valuestringnull olabilir

Örnek: 2026-08-01 00:00:00

typestringzorunlu

Örnek: date

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

date_creation_toobject (FilterDateTo)

valuestringnull olabilir

Örnek: 2026-08-31 23:59:59

typestringzorunlu

Örnek: date

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

date_creation_rangeobject (FilterDateRange)

Hazır tarih filtre dönemleri; alt sınır, kullanıcının saat diliminde hesaplanır. value — mevcut *_from ve *_to ile eşleşen dönem; null — özel dönem. default — sunucunun tarih belirtilmeyen istekte kullandığı dönemdir: ayrıca bölüm ilk yüklendiğinde ve sıfırlama yapıldığında da uygulanır. Dönemin üst sınırı her zaman kullanıcının bugünkü tarihine eşittir, bu nedenle option bunu içermez: hazır dönem için *_to göndermeye gerek yoktur, sunucu bunu otomatik olarak ayarlar. Bir yıldan uzun dönemler, yeni tarihe yakın taraftan kesilir.

valuestring (DateRange) null olabilir

Hazır tarih aralığı filtresi. Bunun için ayrı bir sorgu parametresi yoktur: alt sınır, önceden hesaplanmış olarak option içinde gelir ve *_from alanına eklenir. Üst sınır ise ne yanıtta ne de istekte iletilir — her zaman kullanıcının bugünkü tarihiyle aynıdır ve sunucu tarafından belirlenir.

Değerler:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Örnek: today

defaultstring (DateRange) zorunlu

Değerler:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Örnek: today

typestringzorunlu

Örnek: select

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

optionarray of objectzorunlu

valuestring (DateRange) zorunlu

Değerler:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Örnek: today

date_fromstringzorunlu

Örnek: 25/08/2026

chain_idobject (FilterSelectInteger)

valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object

valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

branch_idobject (FilterSelectInteger)

valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object

valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

phone_format_idobject (FilterSelectInteger)

valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object

valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

phone_numberobject (FilterInput)

valuestring

Örnek: example

typestringzorunlu

Örnek: integer or string

placeholderstring

Örnek: string

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

emailobject (FilterInput)

valuestring

Örnek: example

typestringzorunlu

Örnek: integer or string

placeholderstring

Örnek: string

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

order_statusobject (FilterEnum)

Filtre-enum — düz enum değerleri listesi

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of string

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

platformobject (FilterEnum)

Filtre-enum — düz enum değerleri listesi

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of string

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

delivery_methodobject (FilterEnum)

Filtre-enum — düz enum değerleri listesi

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of string

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

payment_statusobject (FilterEnum)

Filtre-enum — düz enum değerleri listesi

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of string

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

order_numberobject (FilterId)

valueany

Örnek: 0

typestringzorunlu

Örnek: integer

placeholderstring

Örnek: integer

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

client_branch_profile_idobject (FilterId)

valueany

Örnek: 0

typestringzorunlu

Örnek: integer

placeholderstring

Örnek: integer

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

client_account_idobject (FilterId)

valueany

Örnek: 0

typestringzorunlu

Örnek: integer

placeholderstring

Örnek: integer

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

operator_idobject (FilterSelectInteger)

valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object

valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

courier_idobject (FilterSelectInteger)

valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object

valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

promo_codeobject (FilterInput)

valuestring

Örnek: example

typestringzorunlu

Örnek: integer or string

placeholderstring

Örnek: string

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

hide_completed_ordersobject (FilterBooleanCheckbox)

valueboolean

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

Örnek: false

typestringzorunlu

Örnek: checkbox

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

downloadobject (FilterButtonDownloadCsv)

İndirme düğmesi: tıklandığında download=yes iletin

valuestring

Örnek: Download

typestringzorunlu

Örnek: button_download_csv

listarray of object

idintegerzorunlu

Örnek: 12863367

branch_idintegerzorunlu

Örnek: 9054

sms_statusstring (OrderSmsStatus) zorunlu

SMS durumu

Değerler: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) zorunlu

E-posta durumu

Değerler:errorwaitingsuccessneed_email

order_statusstring (OrderStatus) zorunlu

Sipariş durumu: yolda, tamamlandı, hazırlanıyor, mutfakta, işlenmedi, gönderime hazır, mutfağa gönderilmeyi bekliyor, yeniden yapılmayı bekliyor, iptal edildi, onaylandı, hazırlandı

Değerler:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Örnek: confirmed

cart_totalnumberzorunlu

Örnek: 100.55

order_numberinteger

Örnek: 1

date_creationstring (DataTimeFormatSQL) zorunlu

Örnek: 2024-05-02 08:31:16

date_preorderstring (DataTimeFormatSQL)

Örnek: 2024-05-02 08:31:16

timestamp_countdownintegerzorunlu

Örnek: 1718625496

time_preorderinteger

Örnek: 7160

seconds_for_timerinteger

Örnek: -14500

last_order_doneboolean

Örnek: true

minutes_to_doneinteger

Örnek: 60

payment_statusstring (OrderPayment) zorunlu

Ödeme durumu: ödenmedi, beklemede, ödendi

Değerler:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Ödeme yöntemi

Değerler:cashonlinecard_upon_receipt

platformstring (Platform) zorunlu

Değerler:androidiosallmobile_appssitesocial_apps

Örnek: all

operator_phone_format_idinteger (PhoneFormatId)

Ülke 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)

Örnek: 1

operator_phone_numberstring

Örnek: 9114579423

operator_emailstring

Örnek: email@example.com

percent_rateintegerzorunlu

Örnek: 4

sender_namestring

Örnek: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Örnek: 1

sender_phone_numberstring

Örnek: 9114579423

sender_emailstring

Örnek: email@example.com

recipient_namestring

Örnek: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Örnek: 1

recipient_phone_numberstring

Örnek: 9114579423

address_zip_codestring

Örnek: 236039

address_line_1string

Örnek: Korablestroiteley st. 9 bld. 2

address_line_2string

Örnek: Korablestroiteley st. 9 bld. 2

address_streetstring

Örnek: Partizanskaya street

address_housestring

Örnek: 20

address_buildingstring

Örnek: 20

address_entrance_numberstring

Örnek: 20

address_entrance_codestring

Örnek: 1234

address_floorstring

Örnek: 10

address_apartmentstring

Örnek: 10

additional_changestring

Örnek: 100

additional_personsstring

Örnek: 2

additional_commentstring

Örnek: Test order, remove

additional_greeting_cardstring

Örnek: example

additional_discountstring

Örnek: example

tokenstring

Örnek: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) zorunlu

Teslimat yöntemi: no — yok, all — tümü, courier — kurye, pickup — mağazadan teslim alma

Değerler:noallcourierpickup

phone_settingsobject

mask_enableboolean

Örnek: true

formatboolean

Örnek: true

internationalboolean

Örnek: true

branch_namestring

Örnek: Green Basket | Main

chain_namestringzorunlu

Örnek: Green Basket

city_namestringzorunlu

Örnek: Voronezh

courier_namestring

Örnek: courier name

district_namestring

Örnek: Voronezh-Uh

district_idinteger

Örnek: 55329

application_uuidstring

Örnek: 03addc0d-1051-4534-9ba8-792b763a274b

paginationobject (PaginationCursor)

max_countintegerzorunlu

Sayfadaki öğe sayısı

Örnek: 30

cursorintegerzorunlunull olabilir

Geçerli sayfanın istenen kursörü; ilk sayfa için null

next_cursorintegerzorunlunull olabilir

Bu sayfadaki son satırın id değeri: ileri gitmek için bunu direction=next ile iletin; daha fazla veri yoksa null olur

Örnek: 84512

previous_cursorintegerzorunlunull olabilir

Bu sayfadaki ilk satırın id değeri: Geri gitmek için bunu direction=previous ile gönderin; daha önce başka bir şey yoksa null olur

Örnek: 84543

has_nextbooleanzorunlu

Sonraki sayfa var mı

Örnek: true

has_previousbooleanzorunlu

Önceki sayfa var mı

Örnek: false

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

Yanıt 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
    }
  }
}

İstekler foodsoul.pro adresine gönderiliyor — bu portalın ana bilgisayarıdır, başka birini seçmek mümkün değildir.