API

Sipariş kartını al

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

Sepet, yeniden hesaplanmış indirimler ve modifikatorlerle birlikte döndürülür.

Yetkilendirme

api-token + language + role

Sorgu parametreleri

idintegerzorunlu

Yanıtlar

OK

object
statusstringzorunlu

Değerler:successerror

Örnek: success

dataobject (OrderCard)

Sipariş kartı: yeniden hesaplanmış indirimler ve modifikatorlerle sepet, notlar ve işlemler

idintegerzorunlu

Örnek: 12863367

meta_authorized_clientboolean

Örnek: true

meta_sitestring

Örnek: shop.foodsoul.pro

meta_utm_sourcestring

Örnek: shop.foodsoul.pro

meta_utm_mediumstring

Örnek: shop.foodsoul.pro

meta_utm_campaignstring

Örnek: shop.foodsoul.pro

meta_utm_contentstring

Örnek: shop.foodsoul.pro

meta_utm_termstring

Örnek: shop.foodsoul.pro

cart_bodyobject
delivery_feeinteger

Örnek: 100

courier_feenumber

Örnek: 100

service_feenumber

Örnek: 100

itemsarray of objectzorunlu
idintegerzorunlu

Örnek: 94060278

item_namestring

Örnek: Item 100

item_parameter_measurestring

Örnek: 1 pc

countintegerzorunlu

Örnek: 1

amountnumber

Örnek: 1000

new_costnumber

Örnek: 1000

category_namestring

Örnek: Sushi rolls

imagestring

Örnek: https://cdn.crm.git.foodsoul.dev/zones/ru/branches/8920/images/items/medium/fda311c7e13e4abf049a271cb885c11e.jpg?v1735116559

settingsobjectzorunlu
discountboolean

Örnek: true

free_deliveryboolean

Örnek: true

minimum_sumboolean

Örnek: true

modifiers_multiplierboolean

Örnek: true

stock_balanceboolean

Örnek: true

offersarray of object
idstringzorunlu

Örnek: 152366

namestringzorunlu

Örnek: 15%

typestring (TypeWorkOperatingMode) zorunlu

Değerler: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

Örnek: free_delivery

promoobject
idintegerzorunlu

Örnek: 27642

codestringzorunlu

Örnek: DISCOUNT16

discountobject
amountinteger

Örnek: 15

typestring

Örnek: percent

countinteger

Örnek: 1

use_in_old_costboolean

Örnek: true

use_in_minimum_sumboolean

Örnek: true

record_idstring

Örnek: 1115346

modestring

Örnek: percent_discount_on_all_order

modifiersarray of object
idintegerzorunlu

Örnek: 31369618

namestringzorunlu

Örnek: Modifier without a group

amountintegerzorunlu

Örnek: 0

new_costinteger

Örnek: 0

sum_one_modifier_with_countnumber

Örnek: 0

countintegerzorunlu

Örnek: 1

integerinteger

Örnek: 1

item_contentarray of object
additional_modifiersarray of string
total_sum_modifiersstring

Örnek: 5

total_sum_itemstring

Örnek: 100 + 5 = 105

special_offerstring

Örnek: -10% on pickup

discountstring

Örnek: 10% (items: 4)

sum_one_itemnumber

Örnek: 105

finish_sumnumber

Örnek: 378

total_modifiersnumber

Örnek: 100

sum_one_item_with_countnumber

Örnek: 100

sum_one_item_with_modifiersnumber

Örnek: 100

formulanumber

Örnek: 100

has_modifiers_multiplierboolean

Örnek: true

sum_discount_for_itemnumber

Örnek: 100

sum_item_finish_mathnumber

Örnek: 252.24

bonusesobject
accrualobject
sumnumber

Örnek: 0.05

withdrawobject
sumnumber

Örnek: 0.05

pickup_namestring

Örnek: Voronezh-Center

pickup_addressstring

Örnek: Voronezh

operator_phonestring

Örnek: +7 (999) 999-95-95

courier_service_enabledbooleanzorunlu

Örnek: true

courier_button_showedbooleanzorunlu

Örnek: true

payment_namestring

Örnek: IOKassa: Visa / MasterCard / MIR

email_settingsobject
format_addressboolean

Örnek: true

lite_versionboolean

Örnek: true

include_photoboolean

Örnek: true

permanent_clientboolean

Örnek: true

client_account_idinteger

Örnek: 4211394

client_branch_profile_idinteger

Örnek: 49000070

api_versioninteger

Örnek: 1

authorized_clientboolean

Örnek: true

synchronization_idstring

Örnek: f6bb7673-ad2d-4b46-9545-2b0a8b37fd29

meta_user_agentstring

Örnek: FSShop v8.1.2, iOS v18.5, Device: iPad8,6

application_uuidstring

Örnek: 03addc0d-1051-4534-9ba8-792b763a274b

additional_contactless_serviceboolean

Örnek: true

additional_cutleryboolean

Örnek: true

additional_not_callbackboolean

Örnek: true

additional_expedited_deliveryboolean

Örnek: true

sum_in_cartnumber

Örnek: 100

notesarray of object
datestring (DataTimeFormatSQL)

Örnek: 2024-05-02 08:31:16

textstring

Örnek: Status set to confirmed by the automatic order confirmation system

transactionsarray of object
statusstring

Değerler:confirmedrefunded

Örnek: confirmed

datestring (DataTimeFormatSQL)

Örnek: 2024-05-02 08:31:16

sumnumber

Örnek: 500

order_statusstring (OrderStatus) zorunlu

Sipariş durumu: yolda, tamamlandı, hazırlanıyor, mutfakta, işlenmedi, gönderime hazır, mutfağa gönderilmeyi bekliyor, yeniden yapılmayı bekliyor, iptal edildi, onaylandı, hazırlandı

Değerler:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Örnek: confirmed

minutes_to_doneinteger

Örnek: 60

date_preorderstring (DataTimeFormatSQL)

Örnek: 2024-05-02 08:31:16

timestamp_countdownintegerzorunlu

Örnek: 1718625496

branch_idintegerzorunlu

Örnek: 9054

sms_statusstring (OrderSmsStatus) zorunlu

SMS durumu

Değerler: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) zorunlu

E-posta durumu

Değerler:errorwaitingsuccessneed_email

cart_totalnumberzorunlu

Örnek: 100.55

order_numberinteger

Örnek: 1

date_creationstring (DataTimeFormatSQL) zorunlu

Örnek: 2024-05-02 08:31:16

payment_statusstring (OrderPayment) zorunlu

Ödeme durumu: ödenmedi, beklemede, ödendi

Değerler:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Ödeme yöntemi

Değerler:cashonlinecard_upon_receipt

platformstring (Platform) zorunlu

Değerler:androidiosallmobile_appssitesocial_apps

Örnek: all

operator_phone_format_idinteger (PhoneFormatId)

Ülke 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)

Örnek: 1

operator_phone_numberstring

Örnek: 9114579423

operator_emailstring

Örnek: email@example.com

percent_rateintegerzorunlu

Örnek: 4

sender_namestring

Örnek: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Ülke 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)

Örnek: 1

sender_phone_numberstring

Örnek: 9114579423

sender_emailstring

Örnek: email@example.com

recipient_namestring

Örnek: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Ülke 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)

Örnek: 1

recipient_phone_numberstring

Örnek: 9114579423

address_zip_codestring

Örnek: 236039

address_line_1string

Örnek: Korablestroiteley st. 9 bld. 2

address_line_2string

Örnek: Korablestroiteley st. 9 bld. 2

address_streetstring

Örnek: Partizanskaya street

address_housestring

Örnek: 20

address_buildingstring

Örnek: 20

address_entrance_numberstring

Örnek: 20

address_entrance_codestring

Örnek: 1234

address_floorstring

Örnek: 10

address_apartmentstring

Örnek: 10

additional_changestring

Örnek: 100

additional_personsstring

Örnek: 2

additional_commentstring

Örnek: Test order, remove

additional_greeting_cardstring

Örnek: example

additional_discountstring

Örnek: example

tokenstring

Örnek: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) zorunlu

Teslimat yöntemi: no — yok, all — tümü, courier — kurye, pickup — mağazadan teslim alma

Değerler:noallcourierpickup

phone_settingsobject
mask_enableboolean

Örnek: true

formatboolean

Örnek: true

internationalboolean

Örnek: true

branch_namestring

Örnek: Green Basket | Main

chain_namestringzorunlu

Örnek: Green Basket

city_namestringzorunlu

Örnek: Voronezh

district_namestring

Örnek: Voronezh-Uh

district_idinteger

Örnek: 55329