API

Sifariş kartını əldə et

GET/api/crm/v2/orders.editv2
operationId: orders.edit

Sifariş səbətini yenidən hesablanmış endirimlər və modifikatorlarla qaytarır.

Avtorizasiya

api-token + language + role

Sorğu parametrləri

idintegermütləq

Cavablar

OK

object
statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject (OrderCard)

Sifariş kartı: endirimlər və modifikatorlar yenidən hesablanmış səbət, qeydlər və tranzaksiyalar

idintegermütləq

Nümunə: 12863367

meta_authorized_clientboolean

Nümunə: true

meta_sitestring

Nümunə: shop.foodsoul.pro

meta_utm_sourcestring

Nümunə: shop.foodsoul.pro

meta_utm_mediumstring

Nümunə: shop.foodsoul.pro

meta_utm_campaignstring

Nümunə: shop.foodsoul.pro

meta_utm_contentstring

Nümunə: shop.foodsoul.pro

meta_utm_termstring

Nümunə: shop.foodsoul.pro

cart_bodyobject
delivery_feeinteger

Nümunə: 100

courier_feenumber

Nümunə: 100

service_feenumber

Nümunə: 100

itemsarray of objectmütləq
idintegermütləq

Nümunə: 94060278

item_namestring

Nümunə: Item 100

item_parameter_measurestring

Nümunə: 1 pc

countintegermütləq

Nümunə: 1

amountnumber

Nümunə: 1000

new_costnumber

Nümunə: 1000

category_namestring

Nümunə: Sushi rolls

imagestring

Nümunə: https://cdn.crm.git.foodsoul.dev/zones/ru/branches/8920/images/items/medium/fda311c7e13e4abf049a271cb885c11e.jpg?v1735116559

settingsobjectmütləq
discountboolean

Nümunə: true

free_deliveryboolean

Nümunə: true

minimum_sumboolean

Nümunə: true

modifiers_multiplierboolean

Nümunə: true

stock_balanceboolean

Nümunə: true

offersarray of object
idstringmütləq

Nümunə: 152366

namestringmütləq

Nümunə: 15%

typestring (TypeWorkOperatingMode) mütləq

Dəyərlər:fixed_discount_on_all_orderpercent_discount_on_all_orderfixed_discount_on_items_from_categoriespercent_discount_on_items_from_categoriesfixed_discount_on_itemspercent_discount_on_itemsfree_item_to_choose_if_buy_itemsfree_item_to_choose_if_buy_items_from_categoriesfixed_discount_on_next_itempercent_discount_on_next_itemfixed_discount_on_next_item_from_categoriespercent_discount_on_next_item_from_categoriesfree_item_to_choosepercent_discount_on_item_with_minimum_cost_in_cartfixed_discount_on_item_with_minimum_cost_in_cartpercent_discount_on_item_with_minimum_cost_from_itemsfixed_discount_on_item_with_minimum_cost_from_itemspercent_discount_on_item_with_minimum_cost_from_categoriesfixed_discount_on_item_with_minimum_cost_from_categoriesbonusesfree_delivery

Nümunə: free_delivery

promoobject
idintegermütləq

Nümunə: 27642

codestringmütləq

Nümunə: DISCOUNT16

discountobject
amountinteger

Nümunə: 15

typestring

Nümunə: percent

countinteger

Nümunə: 1

use_in_old_costboolean

Nümunə: true

use_in_minimum_sumboolean

Nümunə: true

record_idstring

Nümunə: 1115346

modestring

Nümunə: percent_discount_on_all_order

modifiersarray of object
idintegermütləq

Nümunə: 31369618

namestringmütləq

Nümunə: Modifier without a group

amountintegermütləq

Nümunə: 0

new_costinteger

Nümunə: 0

sum_one_modifier_with_countnumber

Nümunə: 0

countintegermütləq

Nümunə: 1

integerinteger

Nümunə: 1

item_contentarray of object
additional_modifiersarray of string
total_sum_modifiersstring

Nümunə: 5

total_sum_itemstring

Nümunə: 100 + 5 = 105

special_offerstring

Nümunə: -10% on pickup

discountstring

Nümunə: 10% (items: 4)

sum_one_itemnumber

Nümunə: 105

finish_sumnumber

Nümunə: 378

total_modifiersnumber

Nümunə: 100

sum_one_item_with_countnumber

Nümunə: 100

sum_one_item_with_modifiersnumber

Nümunə: 100

formulanumber

Nümunə: 100

has_modifiers_multiplierboolean

Nümunə: true

sum_discount_for_itemnumber

Nümunə: 100

sum_item_finish_mathnumber

Nümunə: 252.24

bonusesobject
accrualobject
sumnumber

Nümunə: 0.05

withdrawobject
sumnumber

Nümunə: 0.05

pickup_namestring

Nümunə: Voronezh-Center

pickup_addressstring

Nümunə: Voronezh

operator_phonestring

Nümunə: +7 (999) 999-95-95

courier_service_enabledbooleanmütləq

Nümunə: true

courier_button_showedbooleanmütləq

Nümunə: true

payment_namestring

Nümunə: IOKassa: Visa / MasterCard / MIR

email_settingsobject
format_addressboolean

Nümunə: true

lite_versionboolean

Nümunə: true

include_photoboolean

Nümunə: true

permanent_clientboolean

Nümunə: true

client_account_idinteger

Nümunə: 4211394

client_branch_profile_idinteger

Nümunə: 49000070

api_versioninteger

Nümunə: 1

authorized_clientboolean

Nümunə: true

synchronization_idstring

Nümunə: f6bb7673-ad2d-4b46-9545-2b0a8b37fd29

meta_user_agentstring

Nümunə: FSShop v8.1.2, iOS v18.5, Device: iPad8,6

application_uuidstring

Nümunə: 03addc0d-1051-4534-9ba8-792b763a274b

additional_contactless_serviceboolean

Nümunə: true

additional_cutleryboolean

Nümunə: true

additional_not_callbackboolean

Nümunə: true

additional_expedited_deliveryboolean

Nümunə: true

sum_in_cartnumber

Nümunə: 100

notesarray of object
datestring (DataTimeFormatSQL)

Nümunə: 2024-05-02 08:31:16

textstring

Nümunə: Status set to confirmed by the automatic order confirmation system

transactionsarray of object
statusstring

Dəyərlər:confirmedrefunded

Nümunə: confirmed

datestring (DataTimeFormatSQL)

Nümunə: 2024-05-02 08:31:16

sumnumber

Nümunə: 500

order_statusstring (OrderStatus) mütləq

Sifariş statusu: yoldadır, tamamlandı, yığılır, mətbəxdədir, işlənməyib, göndərilməyə hazırdır, mətbəxə göndərilməyi gözləyir, yenidən hazırlanmanı gözləyir, ləğv edilib, təsdiqlənib, hazırlanıb

Dəyərlər:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Nümunə: confirmed

minutes_to_doneinteger

Nümunə: 60

date_preorderstring (DataTimeFormatSQL)

Nümunə: 2024-05-02 08:31:16

timestamp_countdownintegermütləq

Nümunə: 1718625496

branch_idintegermütləq

Nümunə: 9054

sms_statusstring (OrderSmsStatus) mütləq

SMS status

Dəyərlər: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) mütləq

Email status

Dəyərlər:errorwaitingsuccessneed_email

cart_totalnumbermütləq

Nümunə: 100.55

order_numberinteger

Nümunə: 1

date_creationstring (DataTimeFormatSQL) mütləq

Nümunə: 2024-05-02 08:31:16

payment_statusstring (OrderPayment) mütləq

Ödəniş statusu: ödənilməyib, gözləyir, ödənilib

Dəyərlər:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Ödəniş üsulu

Dəyərlər:cashonlinecard_upon_receipt

platformstring (Platform) mütləq

Dəyərlər:androidiosallmobile_appssitesocial_apps

Nümunə: all

operator_phone_format_idinteger (PhoneFormatId)

Ölkə 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)

Nümunə: 1

operator_phone_numberstring

Nümunə: 9114579423

operator_emailstring

Nümunə: email@example.com

percent_rateintegermütləq

Nümunə: 4

sender_namestring

Nümunə: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Ölkə 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)

Nümunə: 1

sender_phone_numberstring

Nümunə: 9114579423

sender_emailstring

Nümunə: email@example.com

recipient_namestring

Nümunə: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Ölkə 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)

Nümunə: 1

recipient_phone_numberstring

Nümunə: 9114579423

address_zip_codestring

Nümunə: 236039

address_line_1string

Nümunə: Korablestroiteley st. 9 bld. 2

address_line_2string

Nümunə: Korablestroiteley st. 9 bld. 2

address_streetstring

Nümunə: Partizanskaya street

address_housestring

Nümunə: 20

address_buildingstring

Nümunə: 20

address_entrance_numberstring

Nümunə: 20

address_entrance_codestring

Nümunə: 1234

address_floorstring

Nümunə: 10

address_apartmentstring

Nümunə: 10

additional_changestring

Nümunə: 100

additional_personsstring

Nümunə: 2

additional_commentstring

Nümunə: Test order, remove

additional_greeting_cardstring

Nümunə: example

additional_discountstring

Nümunə: example

tokenstring

Nümunə: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) mütləq

Çatdırılma üsulu: no — yoxdur, all — hamısı, courier — kuryer, pickup — özün götür

Dəyərlər:noallcourierpickup

phone_settingsobject
mask_enableboolean

Nümunə: true

formatboolean

Nümunə: true

internationalboolean

Nümunə: true

branch_namestring

Nümunə: Green Basket | Main

chain_namestringmütləq

Nümunə: Green Basket

city_namestringmütləq

Nümunə: Voronezh

district_namestring

Nümunə: Voronezh-Uh

district_idinteger

Nümunə: 55329