Ստանալ պատվերների ցանկը

GET/api/crm/v2/ordersv2

operationId: orders.default

Հավաստագրում

api-token + language + role

Հարցման պարամետրեր

cursorinteger

Էջը կարդալու մեկնարկային դիրքը՝ pagination.next_cursor՝ առաջ, pagination.previous_cursor՝ հետ; առաջին էջի համար մի փոխանցեք։ Սա համեմատության սահման է, ոչ թե տողի հղում․ այն տողը, որին ցույց է տալիս արժեքը, կարող է գոյություն չունենալ, ուստի հնացած հղումը նույնպես բացում է էջը նույն տեղից։ Սխալ 346 վերադարձվում է միայն այն դեպքում, եթե արժեքը հնարավոր չէ վերծանել որպես դրական ամբողջ թիվ։.

Օրինակ: 84512

directionstring

Կարդալու ուղղությունը ցուցիչից; last-ը բացում է ցուցակի վերջը և անտեսում է ցուցիչը

Արժեքներ:nextpreviouslast

Լռելյայն: next

date_creation_fromstring

Օրինակ: 25/04/2024

date_creation_tostring

Օրինակ: 26/04/2024

chain_idinteger

branch_idinteger

phone_format_idinteger

phone_numberstring

emailstring

order_statusstring (OrderStatus)

Պատվերի կարգավիճակ՝ ճանապարհին, ավարտված, հավաքում, խոհանոցում, չմշակված, պատրաստ առաքման, սպասում է խոհանոց ուղարկմանը, սպասում է վերամշակման, չեղարկված, հաստատված, պատրաստված

Արժեքներ:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Օրինակ: confirmed

platformstring (OrderPlatform)

Պատվերի հարթակ

Արժեքներ:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Առաքման եղանակը՝ սուրհանդակ կամ ինքնաբերում

Արժեքներ:courierpickup

payment_statusstring (OrderPayment)

Վճարման կարգավիճակ՝ չվճարված, սպասում է, վճարված

Արժեքներ:not_paidwaitingpaid

order_numberinteger

client_branch_profile_idinteger

client_account_idinteger

operator_idinteger

courier_idinteger

promo_codestring

Պատվերների ֆիլտրացում ըստ պրոմոկոդի (ճշգրիտ համընկնում պատվերի ակցիաներին կիրառված պրոմոկոդի հետ)

Օրինակ: Promo1

hide_completed_ordersstring

Արժեքներ:true

Օրինակ: true

downloadstring

Արժեքներ:yes

Օրինակ: yes

Պատասխաններ

object

statusstringպարտադիր

Արժեքներ:successerror

Օրինակ: success

dataobject

filtersobject

date_creation_fromobject (FilterDateFrom)

valuestringկարող է լինել null

Օրինակ: 2026-08-01 00:00:00

typestringպարտադիր

Օրինակ: date

modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

date_creation_toobject (FilterDateTo)

valuestringկարող է լինել null

Օրինակ: 2026-08-31 23:59:59

typestringպարտադիր

Օրինակ: date

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

date_creation_rangeobject (FilterDateRange)

Պատրաստի ամսաթվային ֆիլտրի ժամանակահատվածներ; ստորին սահմանը հաշվարկվում է օգտագործողի ժամային գոտու հիման վրա։ value — ժամանակահատված, որին համապատասխանում են ընթացիկ *_from և *_to; null — կամայական ժամանակահատված։ default — ժամանակահատված, որը սերվերը օգտագործում է առանց ամսաթվերի հարցման դեպքում. նույնը կիրառվում է բաժնի առաջին բեռնումից և վերականգնման ժամանակ։ Ժամանակահատվածի վերին սահմանը միշտ համընկնում է օգտագործողի ընթացիկ օրվա հետ, ուստի option-ը այն չի պարունակում. պատրաստի ժամանակահատվածի համար անհրաժեշտ չէ փոխանցել *_to, սերվերը այն սահմանում է ինքնուրույն։ Տարեկանից երկար ժամանակահատվածը կրճատվում է թարմ սահմանից։.

valuestring (DateRange) կարող է լինել null

Պատրաստի ամսաթվային ֆիլտրի ժամանակահատված։ Այն չունի սեփական հարցման պարամետր․ ստորին սահմանը արդեն հաշվարկված է գալիս option-ում և օգտագործվում է որպես *_from։ Վերին սահմանը չի փոխանցվում ոչ պատասխանով, ոչ հարցմամբ՝ այն միշտ հավասար է օգտագործողի ընթացիկ օրվան և սահմանվում է սերվերի կողմից։.

Արժեքներ:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Օրինակ: today

defaultstring (DateRange) պարտադիր

Արժեքներ:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Օրինակ: today

typestringպարտադիր

Օրինակ: select

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

optionarray of objectպարտադիր

valuestring (DateRange) պարտադիր

Արժեքներ:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Օրինակ: today

date_fromstringպարտադիր

Օրինակ: 25/08/2026

chain_idobject (FilterSelectInteger)

valueinteger

Օրինակ: 8920

typestringպարտադիր

Օրինակ: select

optionarray of object

valueintegerպարտադիր

Օրինակ: 8920

namestringպարտադիր

Օրինակ: Green Basket | Kaliningrad

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

branch_idobject (FilterSelectInteger)

valueinteger

Օրինակ: 8920

typestringպարտադիր

Օրինակ: select

optionarray of object

valueintegerպարտադիր

Օրինակ: 8920

namestringպարտադիր

Օրինակ: Green Basket | Kaliningrad

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

phone_format_idobject (FilterSelectInteger)

valueinteger

Օրինակ: 8920

typestringպարտադիր

Օրինակ: select

optionarray of object

valueintegerպարտադիր

Օրինակ: 8920

namestringպարտադիր

Օրինակ: Green Basket | Kaliningrad

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

phone_numberobject (FilterInput)

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: integer or string

placeholderstring

Օրինակ: string

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

emailobject (FilterInput)

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: integer or string

placeholderstring

Օրինակ: string

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

order_statusobject (FilterEnum)

Զտիչ-թվարկում — թվարկման արժեքների հարթ ցուցակ

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: select

optionarray of string

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

platformobject (FilterEnum)

Զտիչ-թվարկում — թվարկման արժեքների հարթ ցուցակ

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: select

optionarray of string

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

delivery_methodobject (FilterEnum)

Զտիչ-թվարկում — թվարկման արժեքների հարթ ցուցակ

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: select

optionarray of string

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

payment_statusobject (FilterEnum)

Զտիչ-թվարկում — թվարկման արժեքների հարթ ցուցակ

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: select

optionarray of string

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

order_numberobject (FilterId)

valueany

Օրինակ: 0

typestringպարտադիր

Օրինակ: integer

placeholderstring

Օրինակ: integer

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

client_branch_profile_idobject (FilterId)

valueany

Օրինակ: 0

typestringպարտադիր

Օրինակ: integer

placeholderstring

Օրինակ: integer

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

client_account_idobject (FilterId)

valueany

Օրինակ: 0

typestringպարտադիր

Օրինակ: integer

placeholderstring

Օրինակ: integer

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

operator_idobject (FilterSelectInteger)

valueinteger

Օրինակ: 8920

typestringպարտադիր

Օրինակ: select

optionarray of object

valueintegerպարտադիր

Օրինակ: 8920

namestringպարտադիր

Օրինակ: Green Basket | Kaliningrad

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

courier_idobject (FilterSelectInteger)

valueinteger

Օրինակ: 8920

typestringպարտադիր

Օրինակ: select

optionarray of object

valueintegerպարտադիր

Օրինակ: 8920

namestringպարտադիր

Օրինակ: Green Basket | Kaliningrad

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

promo_codeobject (FilterInput)

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: integer or string

placeholderstring

Օրինակ: string

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

hide_completed_ordersobject (FilterBooleanCheckbox)

valueboolean

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

Օրինակ: false

typestringպարտադիր

Օրինակ: checkbox

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

downloadobject (FilterButtonDownloadCsv)

Նմուշի ներբեռնման կոճակ՝ սեղմելիս փոխանցեք download=yes

valuestring

Օրինակ: Download

typestringպարտադիր

Օրինակ: button_download_csv

listarray of object

idintegerպարտադիր

Օրինակ: 12863367

branch_idintegerպարտադիր

Օրինակ: 9054

sms_statusstring (OrderSmsStatus) պարտադիր

SMS-ի կարգավիճակ

Արժեքներ: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) պարտադիր

Էլ․ փոստի կարգավիճակ

Արժեքներ:errorwaitingsuccessneed_email

order_statusstring (OrderStatus) պարտադիր

Արժեքներ:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Օրինակ: confirmed

cart_totalnumberպարտադիր

Օրինակ: 100.55

order_numberinteger

Օրինակ: 1

date_creationstring (DataTimeFormatSQL) պարտադիր

Օրինակ: 2024-05-02 08:31:16

date_preorderstring (DataTimeFormatSQL)

Օրինակ: 2024-05-02 08:31:16

timestamp_countdownintegerպարտադիր

Օրինակ: 1718625496

time_preorderinteger

Օրինակ: 7160

seconds_for_timerinteger

Օրինակ: -14500

last_order_doneboolean

Օրինակ: true

minutes_to_doneinteger

Օրինակ: 60

payment_statusstring (OrderPayment) պարտադիր

Վճարման կարգավիճակ՝ չվճարված, սպասում է, վճարված

Արժեքներ:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Վճարման եղանակ

Արժեքներ:cashonlinecard_upon_receipt

platformstring (Platform) պարտադիր

Արժեքներ:androidiosallmobile_appssitesocial_apps

Օրինակ: all

operator_phone_format_idinteger (PhoneFormatId)

Երկրի կոդ՝ 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)

Օրինակ: 1

operator_phone_numberstring

Օրինակ: 9114579423

operator_emailstring

Օրինակ: email@example.com

percent_rateintegerպարտադիր

Օրինակ: 4

sender_namestring

Օրինակ: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Օրինակ: 1

sender_phone_numberstring

Օրինակ: 9114579423

sender_emailstring

Օրինակ: email@example.com

recipient_namestring

Օրինակ: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Օրինակ: 1

recipient_phone_numberstring

Օրինակ: 9114579423

address_zip_codestring

Օրինակ: 236039

address_line_1string

Օրինակ: Korablestroiteley st. 9 bld. 2

address_line_2string

Օրինակ: Korablestroiteley st. 9 bld. 2

address_streetstring

Օրինակ: Partizanskaya street

address_housestring

Օրինակ: 20

address_buildingstring

Օրինակ: 20

address_entrance_numberstring

Օրինակ: 20

address_entrance_codestring

Օրինակ: 1234

address_floorstring

Օրինակ: 10

address_apartmentstring

Օրինակ: 10

additional_changestring

Օրինակ: 100

additional_personsstring

Օրինակ: 2

additional_commentstring

Օրինակ: Test order, remove

additional_greeting_cardstring

Օրինակ: example

additional_discountstring

Օրինակ: example

tokenstring

Օրինակ: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) պարտադիր

Առաքման եղանակը՝ no — ոչ, all — բոլորը, courier — սուրհանդակ, pickup — ինքնաբերում

Արժեքներ:noallcourierpickup

phone_settingsobject

mask_enableboolean

Օրինակ: true

formatboolean

Օրինակ: true

internationalboolean

Օրինակ: true

branch_namestring

Օրինակ: Green Basket | Main

chain_namestringպարտադիր

Օրինակ: Green Basket

city_namestringպարտադիր

Օրինակ: Voronezh

courier_namestring

Օրինակ: courier name

district_namestring

Օրինակ: Voronezh-Uh

district_idinteger

Օրինակ: 55329

application_uuidstring

Օրինակ: 03addc0d-1051-4534-9ba8-792b763a274b

paginationobject (PaginationCursor)

max_countintegerպարտադիր

Էջի տարրերի քանակը

Օրինակ: 30

cursorintegerպարտադիրկարող է լինել null

Այն կուրսորը, որով հարցվել է ընթացիկ էջը; null՝ առաջին էջի համար

next_cursorintegerպարտադիրկարող է լինել null

Այս էջի վերջին տողի id-ն. Փոխանցեք այն direction=next-ով՝ առաջ անցնելու համար; եթե այլևս ոչինչ չկա՝ null։

Օրինակ: 84512

previous_cursorintegerպարտադիրկարող է լինել null

Այս էջի առաջին տողի id-ն՝ փոխանցեք այն direction=previous-ով՝ հետ գնալու համար; null — եթե ավելի վաղ ոչինչ չկա

Օրինակ: 84543

has_nextbooleanպարտադիր

Հաջորդ էջը առկա է

Օրինակ: true

has_previousbooleanպարտադիր

Կա արդյոք նախորդ էջ

Օրինակ: false

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

Պատասխան 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
    }
  }
}

Հարցումները ուղարկվում են foodsoul.pro՝ այս պորտալի հոստը, այլ ընտրություն հնարավոր չէ։.