Hangi tellimuste loendi

GET/api/crm/v2/ordersv2

operationId: orders.default

Autoriseerimine

api-token + language + role

Päringu parameetrid

cursorinteger

Lehekülje lugemise alguspositsioon: pagination.next_cursor — edasi, pagination.previous_cursor — tagasi; esimese lehe puhul ära edasta väärtust. See on võrdluspiir, mitte viide reale: väärtusele viidatud rida ei pruugi eksisteerida, seega aegunud viide avab siiski lehe samast kohast. Viga 346 tagastatakse ainult siis, kui väärtust ei saa tõlgendada positiivse täisarvuna.

Näide: 84512

directionstring

Lugemissuund kursorist alates; last avab loendi lõpu ja ignoreerib kursorit

Väärtused:nextpreviouslast

Vaikimisi: next

date_creation_fromstring

Näide: 25/04/2024

date_creation_tostring

Näide: 26/04/2024

chain_idinteger

branch_idinteger

phone_format_idinteger

phone_numberstring

emailstring

order_statusstring (OrderStatus)

Tellimuse olek: teel, täidetud, komplekteerimisel, köögis, töötlemata, valmis saatmiseks, ootab kööki saatmist, ootab ümbertegemist, tühistatud, kinnitatud, valmistatud

Väärtused:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Näide: confirmed

platformstring (OrderPlatform)

Tellimuse platvorm

Väärtused:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Tarneviis: kuller või ise järele tulemine

Väärtused:courierpickup

payment_statusstring (OrderPayment)

Makse staatus: maksmata, ootel, makstud

Väärtused:not_paidwaitingpaid

order_numberinteger

client_branch_profile_idinteger

client_account_idinteger

operator_idinteger

courier_idinteger

promo_codestring

Tellimuste filtreerimine promokoodi järgi (täpne vastavus tellimuse kampaaniatele rakendatud promokoodiga)

Näide: Promo1

hide_completed_ordersstring

Väärtused:true

Näide: true

downloadstring

Väärtused:yes

Näide: yes

Vastused

object

statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject

filtersobject

date_creation_fromobject (FilterDateFrom)

valuestringvõib olla null

Näide: 2026-08-01 00:00:00

typestringkohustuslik

Näide: date

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

date_creation_toobject (FilterDateTo)

valuestringvõib olla null

Näide: 2026-08-31 23:59:59

typestringkohustuslik

Näide: date

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

date_creation_rangeobject (FilterDateRange)

Valmis kuupäevafiltri perioodid; alumine piir arvutatakse kasutaja ajavööndi järgi. value — periood, millele vastavad praegused *_from ja *_to; null — suvaline periood. default — periood, mille server lisab päringusse ilma kuupäevadeta: seda kasutatakse ka jaotise esmasel laadimisel ning lähtestamisel. Perioodi ülemine piir on alati kasutaja tänane päev, seetõttu option seda ei sisalda: valmisperioodi puhul pole vaja *_to edastada, server määrab selle ise. Üle aasta pikkune periood kärbitakse uuema piiri poolt.

valuestring (DateRange) võib olla null

Valmis kuupäevafiltri periood. Sellel ei ole oma päringuparameetrit: alumine piir arvutatakse ette ja edastatakse option kaudu ning kasutatakse väljal *_from. Ülemist piiri ei edastata vastuses ega päringus — see on alati võrdne kasutaja jooksva kuupäevaga ja määratakse serveri poolt.

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

defaultstring (DateRange) kohustuslik

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

typestringkohustuslik

Näide: select

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

optionarray of objectkohustuslik

valuestring (DateRange) kohustuslik

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

date_fromstringkohustuslik

Näide: 25/08/2026

chain_idobject (FilterSelectInteger)

valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object

valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

branch_idobject (FilterSelectInteger)

valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object

valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

phone_format_idobject (FilterSelectInteger)

valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object

valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

phone_numberobject (FilterInput)

valuestring

Näide: example

typestringkohustuslik

Näide: integer or string

placeholderstring

Näide: string

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

emailobject (FilterInput)

valuestring

Näide: example

typestringkohustuslik

Näide: integer or string

placeholderstring

Näide: string

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

order_statusobject (FilterEnum)

Filtri enum — tasane loend enum väärtustest

valuestring

Näide: example

typestringkohustuslik

Näide: select

optionarray of string

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

platformobject (FilterEnum)

Filtri enum — tasane loend enum väärtustest

valuestring

Näide: example

typestringkohustuslik

Näide: select

optionarray of string

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

delivery_methodobject (FilterEnum)

Filtri enum — tasane loend enum väärtustest

valuestring

Näide: example

typestringkohustuslik

Näide: select

optionarray of string

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

payment_statusobject (FilterEnum)

Filtri enum — tasane loend enum väärtustest

valuestring

Näide: example

typestringkohustuslik

Näide: select

optionarray of string

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

order_numberobject (FilterId)

valueany

Näide: 0

typestringkohustuslik

Näide: integer

placeholderstring

Näide: integer

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

client_branch_profile_idobject (FilterId)

valueany

Näide: 0

typestringkohustuslik

Näide: integer

placeholderstring

Näide: integer

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

client_account_idobject (FilterId)

valueany

Näide: 0

typestringkohustuslik

Näide: integer

placeholderstring

Näide: integer

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

operator_idobject (FilterSelectInteger)

valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object

valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

courier_idobject (FilterSelectInteger)

valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object

valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

promo_codeobject (FilterInput)

valuestring

Näide: example

typestringkohustuslik

Näide: integer or string

placeholderstring

Näide: string

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

hide_completed_ordersobject (FilterBooleanCheckbox)

valueboolean

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

Näide: false

typestringkohustuslik

Näide: checkbox

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

downloadobject (FilterButtonDownloadCsv)

Allalaadimisnupp: vajutamisel edastage download=yes

valuestring

Näide: Download

typestringkohustuslik

Näide: button_download_csv

listarray of object

idintegerkohustuslik

Näide: 12863367

branch_idintegerkohustuslik

Näide: 9054

sms_statusstring (OrderSmsStatus) kohustuslik

SMS-i olek

Väärtused: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) kohustuslik

Emaili staatus

Väärtused:errorwaitingsuccessneed_email

order_statusstring (OrderStatus) kohustuslik

Tellimuse olek: teel, täidetud, komplekteerimisel, köögis, töötlemata, valmis saatmiseks, ootab kööki saatmist, ootab ümbertegemist, tühistatud, kinnitatud, valmistatud

Väärtused:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Näide: confirmed

cart_totalnumberkohustuslik

Näide: 100.55

order_numberinteger

Näide: 1

date_creationstring (DataTimeFormatSQL) kohustuslik

Näide: 2024-05-02 08:31:16

date_preorderstring (DataTimeFormatSQL)

Näide: 2024-05-02 08:31:16

timestamp_countdownintegerkohustuslik

Näide: 1718625496

time_preorderinteger

Näide: 7160

seconds_for_timerinteger

Näide: -14500

last_order_doneboolean

Näide: true

minutes_to_doneinteger

Näide: 60

payment_statusstring (OrderPayment) kohustuslik

Makse staatus: maksmata, ootel, makstud

Väärtused:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Makseviis

Väärtused:cashonlinecard_upon_receipt

platformstring (Platform) kohustuslik

Väärtused:androidiosallmobile_appssitesocial_apps

Näide: all

operator_phone_format_idinteger (PhoneFormatId)

Riigikood: 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äide: 1

operator_phone_numberstring

Näide: 9114579423

operator_emailstring

Näide: email@example.com

percent_rateintegerkohustuslik

Näide: 4

sender_namestring

Näide: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Näide: 1

sender_phone_numberstring

Näide: 9114579423

sender_emailstring

Näide: email@example.com

recipient_namestring

Näide: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Näide: 1

recipient_phone_numberstring

Näide: 9114579423

address_zip_codestring

Näide: 236039

address_line_1string

Näide: Korablestroiteley st. 9 bld. 2

address_line_2string

Näide: Korablestroiteley st. 9 bld. 2

address_streetstring

Näide: Partizanskaya street

address_housestring

Näide: 20

address_buildingstring

Näide: 20

address_entrance_numberstring

Näide: 20

address_entrance_codestring

Näide: 1234

address_floorstring

Näide: 10

address_apartmentstring

Näide: 10

additional_changestring

Näide: 100

additional_personsstring

Näide: 2

additional_commentstring

Näide: Test order, remove

additional_greeting_cardstring

Näide: example

additional_discountstring

Näide: example

tokenstring

Näide: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) kohustuslik

Tarneviis: no — puudub, all — kõik, courier — kuller, pickup — ise järele

Väärtused:noallcourierpickup

phone_settingsobject

mask_enableboolean

Näide: true

formatboolean

Näide: true

internationalboolean

Näide: true

branch_namestring

Näide: Green Basket | Main

chain_namestringkohustuslik

Näide: Green Basket

city_namestringkohustuslik

Näide: Voronezh

courier_namestring

Näide: courier name

district_namestring

Näide: Voronezh-Uh

district_idinteger

Näide: 55329

application_uuidstring

Näide: 03addc0d-1051-4534-9ba8-792b763a274b

paginationobject (PaginationCursor)

max_countintegerkohustuslik

Elementide arv lehel

Näide: 30

cursorintegerkohustuslikvõib olla null

Kursor, millega praegune leht on päringus; null — esimese lehe jaoks

next_cursorintegerkohustuslikvõib olla null

Selle lehe viimase rea id: edasiliikumiseks edastage see koos direction=next; kui rohkem andmeid pole, on väärtus null

Näide: 84512

previous_cursorintegerkohustuslikvõib olla null

Selle lehe esimese rea id: edasta see koos direction=previous, et liikuda tagasi; null — kui varem pole midagi

Näide: 84543

has_nextbooleankohustuslik

Kas on järgmine lehekülg

Näide: true

has_previousbooleankohustuslik

Kas eelmine lehekülg on olemas

Näide: false

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

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

Päringud saadetakse aadressile foodsoul.pro — see on selle portaali host, teist valida ei saa.