Gauti užsakymų sąrašą

GET/api/crm/v2/ordersv2

operationId: orders.default

Autorizacija

api-token + language + role

Užklausos parametrai

cursorinteger

Pozicija, nuo kurios skaityti puslapį: pagination.next_cursor — į priekį, pagination.previous_cursor — atgal; pirmam puslapiui nesiųskite. Tai yra palyginimo riba, o ne nuoroda į eilutę: eilutė, į kurią rodo reikšmė, gali neegzistuoti, todėl pasenusi nuoroda vis tiek atidarys puslapį nuo tos pačios vietos. Klaida 346 grąžinama tik tuo atveju, jei reikšmės nepavyksta interpretuoti kaip teigiamo sveikojo skaičiaus.

Pavyzdys: 84512

directionstring

Skaitymo kryptis nuo žymeklio; last atveria sąrašo pabaigą ir ignoruoja žymeklį

Reikšmės:nextpreviouslast

Numatytasis: next

date_creation_fromstring

Pavyzdys: 25/04/2024

date_creation_tostring

Pavyzdys: 26/04/2024

chain_idinteger

branch_idinteger

phone_format_idinteger

phone_numberstring

emailstring

order_statusstring (OrderStatus)

Užsakymo būsena: pakeliui, įvykdytas, komplektuojamas, virtuvėje, neapdorotas, paruoštas išsiuntimui, laukia išsiuntimo į virtuvę, laukia perdarymo, atšauktas, patvirtintas, pagamintas

Reikšmės:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Pavyzdys: confirmed

platformstring (OrderPlatform)

Užsakymo platforma

Reikšmės:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Pristatymo būdas: kurjeris arba atsiėmimas

Reikšmės:courierpickup

payment_statusstring (OrderPayment)

Mokėjimo būsena: neapmokėta, laukiama, apmokėta

Reikšmės:not_paidwaitingpaid

order_numberinteger

client_branch_profile_idinteger

client_account_idinteger

operator_idinteger

courier_idinteger

promo_codestring

Užsakymų filtravimas pagal nuolaidos kodą (tikslus atitikimas su užsakyme pritaikytu nuolaidos kodu)

Pavyzdys: Promo1

hide_completed_ordersstring

Reikšmės:true

Pavyzdys: true

downloadstring

Reikšmės:yes

Pavyzdys: yes

Atsakymai

object

statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject

filtersobject

date_creation_fromobject (FilterDateFrom)

valuestringgali būti null

Pavyzdys: 2026-08-01 00:00:00

typestringprivalomas

Pavyzdys: date

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

date_creation_toobject (FilterDateTo)

valuestringgali būti null

Pavyzdys: 2026-08-31 23:59:59

typestringprivalomas

Pavyzdys: date

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

date_creation_rangeobject (FilterDateRange)

Paruošti datos filtro laikotarpiai; apatinė riba apskaičiuojama pagal naudotojo laiko juostą. value — laikotarpis, kuriam atitinka dabartiniai *_from ir *_to; null — pasirinktinis laikotarpis. default — laikotarpis, kurį serveris naudoja užklausoje be datų: jis taip pat taikomas pirmą kartą įkėlus skyrių ir grąžinamas atstatant nustatymus. Viršutinė laikotarpio riba visada lygi dabartinei naudotojo dienai, todėl option jos neturi: perduoti *_to paruoštam laikotarpiui nereikia, serveris ją nustato automatiškai. Laikotarpis, ilgesnis nei metai, nukerpamas nuo naujesnės ribos.

valuestring (DateRange) gali būti null

Paruoštas datos filtro laikotarpis. Neturi atskiro užklausos parametro: apatinė riba jau apskaičiuota ir perduodama per option, įrašoma į *_from. Viršutinė riba neperduodama nei atsakyme, nei užklausoje — ji visada lygi dabartinei naudotojo dienai ir nustatoma serverio.

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

defaultstring (DateRange) privalomas

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

typestringprivalomas

Pavyzdys: select

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

optionarray of objectprivalomas

valuestring (DateRange) privalomas

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

date_fromstringprivalomas

Pavyzdys: 25/08/2026

chain_idobject (FilterSelectInteger)

valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object

valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

branch_idobject (FilterSelectInteger)

valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object

valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

phone_format_idobject (FilterSelectInteger)

valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object

valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

phone_numberobject (FilterInput)

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: integer or string

placeholderstring

Pavyzdys: string

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

emailobject (FilterInput)

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: integer or string

placeholderstring

Pavyzdys: string

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

order_statusobject (FilterEnum)

Filtras-enumeracija — plokščias enumeracijos reikšmių sąrašas

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: select

optionarray of string

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

platformobject (FilterEnum)

Filtras-enumeracija — plokščias enumeracijos reikšmių sąrašas

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: select

optionarray of string

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

delivery_methodobject (FilterEnum)

Filtras-enumeracija — plokščias enumeracijos reikšmių sąrašas

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: select

optionarray of string

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

payment_statusobject (FilterEnum)

Filtras-enumeracija — plokščias enumeracijos reikšmių sąrašas

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: select

optionarray of string

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

order_numberobject (FilterId)

valueany

Pavyzdys: 0

typestringprivalomas

Pavyzdys: integer

placeholderstring

Pavyzdys: integer

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

client_branch_profile_idobject (FilterId)

valueany

Pavyzdys: 0

typestringprivalomas

Pavyzdys: integer

placeholderstring

Pavyzdys: integer

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

client_account_idobject (FilterId)

valueany

Pavyzdys: 0

typestringprivalomas

Pavyzdys: integer

placeholderstring

Pavyzdys: integer

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

operator_idobject (FilterSelectInteger)

valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object

valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

courier_idobject (FilterSelectInteger)

valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object

valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

promo_codeobject (FilterInput)

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: integer or string

placeholderstring

Pavyzdys: string

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

hide_completed_ordersobject (FilterBooleanCheckbox)

valueboolean

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

Pavyzdys: false

typestringprivalomas

Pavyzdys: checkbox

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

downloadobject (FilterButtonDownloadCsv)

Atsisiuntimo mygtukas: paspaudus perduokite download=yes

valuestring

Pavyzdys: Download

typestringprivalomas

Pavyzdys: button_download_csv

listarray of object

idintegerprivalomas

Pavyzdys: 12863367

branch_idintegerprivalomas

Pavyzdys: 9054

sms_statusstring (OrderSmsStatus) privalomas

SMS būsena

Reikšmės: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) privalomas

El. pašto būsena

Reikšmės:errorwaitingsuccessneed_email

order_statusstring (OrderStatus) privalomas

Užsakymo būsena: pakeliui, įvykdytas, komplektuojamas, virtuvėje, neapdorotas, paruoštas išsiuntimui, laukia išsiuntimo į virtuvę, laukia perdarymo, atšauktas, patvirtintas, pagamintas

Reikšmės:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Pavyzdys: confirmed

cart_totalnumberprivalomas

Pavyzdys: 100.55

order_numberinteger

Pavyzdys: 1

date_creationstring (DataTimeFormatSQL) privalomas

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

date_preorderstring (DataTimeFormatSQL)

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

timestamp_countdownintegerprivalomas

Pavyzdys: 1718625496

time_preorderinteger

Pavyzdys: 7160

seconds_for_timerinteger

Pavyzdys: -14500

last_order_doneboolean

Pavyzdys: true

minutes_to_doneinteger

Pavyzdys: 60

payment_statusstring (OrderPayment) privalomas

Mokėjimo būsena: neapmokėta, laukiama, apmokėta

Reikšmės:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Apmokėjimo būdas

Reikšmės:cashonlinecard_upon_receipt

platformstring (Platform) privalomas

Reikšmės:androidiosallmobile_appssitesocial_apps

Pavyzdys: all

operator_phone_format_idinteger (PhoneFormatId)

Šalies kodas: 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)

Pavyzdys: 1

operator_phone_numberstring

Pavyzdys: 9114579423

operator_emailstring

Pavyzdys: email@example.com

percent_rateintegerprivalomas

Pavyzdys: 4

sender_namestring

Pavyzdys: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Pavyzdys: 1

sender_phone_numberstring

Pavyzdys: 9114579423

sender_emailstring

Pavyzdys: email@example.com

recipient_namestring

Pavyzdys: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Pavyzdys: 1

recipient_phone_numberstring

Pavyzdys: 9114579423

address_zip_codestring

Pavyzdys: 236039

address_line_1string

Pavyzdys: Korablestroiteley st. 9 bld. 2

address_line_2string

Pavyzdys: Korablestroiteley st. 9 bld. 2

address_streetstring

Pavyzdys: Partizanskaya street

address_housestring

Pavyzdys: 20

address_buildingstring

Pavyzdys: 20

address_entrance_numberstring

Pavyzdys: 20

address_entrance_codestring

Pavyzdys: 1234

address_floorstring

Pavyzdys: 10

address_apartmentstring

Pavyzdys: 10

additional_changestring

Pavyzdys: 100

additional_personsstring

Pavyzdys: 2

additional_commentstring

Pavyzdys: Test order, remove

additional_greeting_cardstring

Pavyzdys: example

additional_discountstring

Pavyzdys: example

tokenstring

Pavyzdys: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) privalomas

Pristatymo būdas: no — nėra, all — visi, courier — kurjeris, pickup — atsiėmimas

Reikšmės:noallcourierpickup

phone_settingsobject

mask_enableboolean

Pavyzdys: true

formatboolean

Pavyzdys: true

internationalboolean

Pavyzdys: true

branch_namestring

Pavyzdys: Green Basket | Main

chain_namestringprivalomas

Pavyzdys: Green Basket

city_namestringprivalomas

Pavyzdys: Voronezh

courier_namestring

Pavyzdys: courier name

district_namestring

Pavyzdys: Voronezh-Uh

district_idinteger

Pavyzdys: 55329

application_uuidstring

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

paginationobject (PaginationCursor)

max_countintegerprivalomas

Elementų skaičius puslapyje

Pavyzdys: 30

cursorintegerprivalomasgali būti null

Kursorius, su kuriuo užklaustas dabartinis puslapis; null — pirmajam puslapiui

next_cursorintegerprivalomasgali būti null

Paskutinės eilutės id šiame puslapyje: perduokite jį su direction=next, kad pereitumėte toliau; null — jei daugiau įrašų nėra

Pavyzdys: 84512

previous_cursorintegerprivalomasgali būti null

Pirmos eilutės id šiame puslapyje: perduokite jį su direction=previous, kad grįžtumėte atgal; null — jei anksčiau nieko nėra

Pavyzdys: 84543

has_nextbooleanprivalomas

Ar yra kitas puslapis

Pavyzdys: true

has_previousbooleanprivalomas

Ar yra ankstesnis puslapis

Pavyzdys: false

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

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

Užklausos siunčiamos į foodsoul.pro — tai šio portalo priegloba, kitos pasirinkti negalima.