Iegūt pasūtījumu sarakstu

GET/api/crm/v2/ordersv2

operationId: orders.default

Autorizācija

api-token + language + role

Vaicājuma parametri

cursorinteger

Pozīcija, no kuras lasīt lapu: pagination.next_cursor — uz priekšu, pagination.previous_cursor — atpakaļ; pirmajai lapai nepārsūtiet. Tā ir salīdzināšanas robeža, nevis atsauce uz rindu: rinda, uz kuru norāda vērtība, var neeksistēt, tāpēc novecojusi atsauce joprojām atver lapu no tās pašas vietas. Kļūda 346 tiek atgriezta tikai tad, ja vērtību nevar parsēt kā pozitīvu veselu skaitli.

Piemērs: 84512

directionstring

Lasīšanas virziens no kursora; last atver saraksta beigas un ignorē kursora pozīciju

Vērtības:nextpreviouslast

Pēc noklusējuma: next

date_creation_fromstring

Piemērs: 25/04/2024

date_creation_tostring

Piemērs: 26/04/2024

chain_idinteger

branch_idinteger

phone_format_idinteger

phone_numberstring

emailstring

order_statusstring (OrderStatus)

Pasūtījuma statuss: ceļā, izpildīts, komplektēšana, virtuvē, neapstrādāts, gatavs nosūtīšanai, gaida nosūtīšanu uz virtuvi, gaida pārstrādi, atcelts, apstiprināts, pagatavots

Vērtības:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Piemērs: confirmed

platformstring (OrderPlatform)

Pasūtījumu platforma

Vērtības:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Piegādes veids: kurjers vai pašizņemšana

Vērtības:courierpickup

payment_statusstring (OrderPayment)

Apmaksas statuss: nav apmaksāts, gaida, apmaksāts

Vērtības:not_paidwaitingpaid

order_numberinteger

client_branch_profile_idinteger

client_account_idinteger

operator_idinteger

courier_idinteger

promo_codestring

Pasūtījumu filtrs pēc promo koda (precīza atbilstība promo kodam, kas piemērots pasūtījuma akcijām)

Piemērs: Promo1

hide_completed_ordersstring

Vērtības:true

Piemērs: true

downloadstring

Vērtības:yes

Piemērs: yes

Atbildes

object

statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject

filtersobject

date_creation_fromobject (FilterDateFrom)

valuestringvar būt null

Piemērs: 2026-08-01 00:00:00

typestringobligāts

Piemērs: date

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

date_creation_toobject (FilterDateTo)

valuestringvar būt null

Piemērs: 2026-08-31 23:59:59

typestringobligāts

Piemērs: date

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

date_creation_rangeobject (FilterDateRange)

Gatavi datuma filtra periodi; apakšējā robeža tiek aprēķināta lietotāja laika joslā. value — periods, kuram atbilst pašreizējie *_from un *_to; null — patvaļīgs periods. default — periods, kuru serveris izmanto pieprasījumā bez datumiem: tas tiek piemērots arī sadaļas pirmajā ielādē un pie atiestatīšanas. Perioda augšējā robeža vienmēr ir vienāda ar lietotāja pašreizējo dienu, tāpēc option to nesatur: gatavam periodam nav jānosūta *_to, serveris to iestata pats. Periods, kas ir garāks par gadu, tiek apgriezts no svaigākās robežas puses.

valuestring (DateRange) var būt null

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

defaultstring (DateRange) obligāts

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

typestringobligāts

Piemērs: select

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

optionarray of objectobligāts

valuestring (DateRange) obligāts

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

date_fromstringobligāts

Piemērs: 25/08/2026

chain_idobject (FilterSelectInteger)

valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object

valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

branch_idobject (FilterSelectInteger)

valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object

valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

phone_format_idobject (FilterSelectInteger)

valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object

valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

phone_numberobject (FilterInput)

valuestring

Piemērs: example

typestringobligāts

Piemērs: integer or string

placeholderstring

Piemērs: string

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

emailobject (FilterInput)

valuestring

Piemērs: example

typestringobligāts

Piemērs: integer or string

placeholderstring

Piemērs: string

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

order_statusobject (FilterEnum)

Filtrs-enums — plakans uzskaitījuma vērtību saraksts

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of string

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

platformobject (FilterEnum)

Filtrs-enums — plakans uzskaitījuma vērtību saraksts

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of string

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

delivery_methodobject (FilterEnum)

Filtrs-enums — plakans uzskaitījuma vērtību saraksts

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of string

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

payment_statusobject (FilterEnum)

Filtrs-enums — plakans uzskaitījuma vērtību saraksts

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of string

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

order_numberobject (FilterId)

valueany

Piemērs: 0

typestringobligāts

Piemērs: integer

placeholderstring

Piemērs: integer

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

client_branch_profile_idobject (FilterId)

valueany

Piemērs: 0

typestringobligāts

Piemērs: integer

placeholderstring

Piemērs: integer

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

client_account_idobject (FilterId)

valueany

Piemērs: 0

typestringobligāts

Piemērs: integer

placeholderstring

Piemērs: integer

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

operator_idobject (FilterSelectInteger)

valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object

valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

courier_idobject (FilterSelectInteger)

valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object

valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

promo_codeobject (FilterInput)

valuestring

Piemērs: example

typestringobligāts

Piemērs: integer or string

placeholderstring

Piemērs: string

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

hide_completed_ordersobject (FilterBooleanCheckbox)

valueboolean

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

Piemērs: false

typestringobligāts

Piemērs: checkbox

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

downloadobject (FilterButtonDownloadCsv)

Lejupielādes poga: nospiežot, pārsūtiet download=yes

valuestring

Piemērs: Download

typestringobligāts

Piemērs: button_download_csv

listarray of object

idintegerobligāts

Piemērs: 12863367

branch_idintegerobligāts

Piemērs: 9054

sms_statusstring (OrderSmsStatus) obligāts

SMS statuss

Vērtības: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) obligāts

E-pasta statuss

Vērtības:errorwaitingsuccessneed_email

order_statusstring (OrderStatus) obligāts

Pasūtījuma statuss: ceļā, izpildīts, komplektēšana, virtuvē, neapstrādāts, gatavs nosūtīšanai, gaida nosūtīšanu uz virtuvi, gaida pārstrādi, atcelts, apstiprināts, pagatavots

Vērtības:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Piemērs: confirmed

cart_totalnumberobligāts

Piemērs: 100.55

order_numberinteger

Piemērs: 1

date_creationstring (DataTimeFormatSQL) obligāts

Piemērs: 2024-05-02 08:31:16

date_preorderstring (DataTimeFormatSQL)

Piemērs: 2024-05-02 08:31:16

timestamp_countdownintegerobligāts

Piemērs: 1718625496

time_preorderinteger

Piemērs: 7160

seconds_for_timerinteger

Piemērs: -14500

last_order_doneboolean

Piemērs: true

minutes_to_doneinteger

Piemērs: 60

payment_statusstring (OrderPayment) obligāts

Apmaksas statuss: nav apmaksāts, gaida, apmaksāts

Vērtības:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Apmaksas veids

Vērtības:cashonlinecard_upon_receipt

platformstring (Platform) obligāts

Vērtības:androidiosallmobile_appssitesocial_apps

Piemērs: all

operator_phone_format_idinteger (PhoneFormatId)

Valsts kods: 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)

Piemērs: 1

operator_phone_numberstring

Piemērs: 9114579423

operator_emailstring

Piemērs: email@example.com

percent_rateintegerobligāts

Piemērs: 4

sender_namestring

Piemērs: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Piemērs: 1

sender_phone_numberstring

Piemērs: 9114579423

sender_emailstring

Piemērs: email@example.com

recipient_namestring

Piemērs: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Piemērs: 1

recipient_phone_numberstring

Piemērs: 9114579423

address_zip_codestring

Piemērs: 236039

address_line_1string

Piemērs: Korablestroiteley st. 9 bld. 2

address_line_2string

Piemērs: Korablestroiteley st. 9 bld. 2

address_streetstring

Piemērs: Partizanskaya street

address_housestring

Piemērs: 20

address_buildingstring

Piemērs: 20

address_entrance_numberstring

Piemērs: 20

address_entrance_codestring

Piemērs: 1234

address_floorstring

Piemērs: 10

address_apartmentstring

Piemērs: 10

additional_changestring

Piemērs: 100

additional_personsstring

Piemērs: 2

additional_commentstring

Piemērs: Test order, remove

additional_greeting_cardstring

Piemērs: example

additional_discountstring

Piemērs: example

tokenstring

Piemērs: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) obligāts

Piegādes veids: no — nav, all — visi, courier — kurjers, pickup — izņemšana

Vērtības:noallcourierpickup

phone_settingsobject

mask_enableboolean

Piemērs: true

formatboolean

Piemērs: true

internationalboolean

Piemērs: true

branch_namestring

Piemērs: Green Basket | Main

chain_namestringobligāts

Piemērs: Green Basket

city_namestringobligāts

Piemērs: Voronezh

courier_namestring

Piemērs: courier name

district_namestring

Piemērs: Voronezh-Uh

district_idinteger

Piemērs: 55329

application_uuidstring

Piemērs: 03addc0d-1051-4534-9ba8-792b763a274b

paginationobject (PaginationCursor)

max_countintegerobligāts

Elementu skaits lapā

Piemērs: 30

cursorintegerobligātsvar būt null

Kursors, ar kuru pieprasīta pašreizējā lapa; null — pirmajai lapai

next_cursorintegerobligātsvar būt null

Šīs lapas pēdējās rindas id: nododiet to ar direction=next, lai pārietu uz priekšu; null — ja tālāk nav datu

Piemērs: 84512

previous_cursorintegerobligātsvar būt null

Pirmās rindas id šajā lapā: nododiet to ar direction=previous, lai pārietu atpakaļ; null — ja iepriekš nav neviena ieraksta

Piemērs: 84543

has_nextbooleanobligāts

Vai ir nākamā lapa

Piemērs: true

has_previousbooleanobligāts

Vai ir iepriekšējā lapa

Piemērs: false

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

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

Pieprasījumi tiek nosūtīti uz foodsoul.ru — šī portāla resursdatoru, citu izvēlēties nav iespējams.