API

Dapatkan kartu pesanan

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

Mengembalikan keranjang dengan diskon dan modifikator yang telah dihitung ulang.

Otorisasi

api-token + language + role

Parameter permintaan

idintegerwajib

Tanggapan

OK

object
statusstringwajib

Nilai:successerror

Contoh: success

dataobject (OrderCard)

Kartu pesanan: keranjang dengan diskon dan modifikator yang telah dihitung ulang, catatan, dan transaksi

idintegerwajib

Contoh: 12863367

meta_authorized_clientboolean

Contoh: true

meta_sitestring

Contoh: shop.foodsoul.pro

meta_utm_sourcestring

Contoh: shop.foodsoul.pro

meta_utm_mediumstring

Contoh: shop.foodsoul.pro

meta_utm_campaignstring

Contoh: shop.foodsoul.pro

meta_utm_contentstring

Contoh: shop.foodsoul.pro

meta_utm_termstring

Contoh: shop.foodsoul.pro

cart_bodyobject
delivery_feeinteger

Contoh: 100

courier_feenumber

Contoh: 100

service_feenumber

Contoh: 100

itemsarray of objectwajib
idintegerwajib

Contoh: 94060278

item_namestring

Contoh: Item 100

item_parameter_measurestring

Contoh: 1 pc

countintegerwajib

Contoh: 1

amountnumber

Contoh: 1000

new_costnumber

Contoh: 1000

category_namestring

Contoh: Sushi rolls

imagestring

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

settingsobjectwajib
discountboolean

Contoh: true

free_deliveryboolean

Contoh: true

minimum_sumboolean

Contoh: true

modifiers_multiplierboolean

Contoh: true

stock_balanceboolean

Contoh: true

offersarray of object
idstringwajib

Contoh: 152366

namestringwajib

Contoh: 15%

typestring (TypeWorkOperatingMode) wajib

Nilai: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

Contoh: free_delivery

promoobject
idintegerwajib

Contoh: 27642

codestringwajib

Contoh: DISCOUNT16

discountobject
amountinteger

Contoh: 15

typestring

Contoh: percent

countinteger

Contoh: 1

use_in_old_costboolean

Contoh: true

use_in_minimum_sumboolean

Contoh: true

record_idstring

Contoh: 1115346

modestring

Contoh: percent_discount_on_all_order

modifiersarray of object
idintegerwajib

Contoh: 31369618

namestringwajib

Contoh: Modifier without a group

amountintegerwajib

Contoh: 0

new_costinteger

Contoh: 0

sum_one_modifier_with_countnumber

Contoh: 0

countintegerwajib

Contoh: 1

integerinteger

Contoh: 1

item_contentarray of object
additional_modifiersarray of string
total_sum_modifiersstring

Contoh: 5

total_sum_itemstring

Contoh: 100 + 5 = 105

special_offerstring

Contoh: -10% on pickup

discountstring

Contoh: 10% (items: 4)

sum_one_itemnumber

Contoh: 105

finish_sumnumber

Contoh: 378

total_modifiersnumber

Contoh: 100

sum_one_item_with_countnumber

Contoh: 100

sum_one_item_with_modifiersnumber

Contoh: 100

formulanumber

Contoh: 100

has_modifiers_multiplierboolean

Contoh: true

sum_discount_for_itemnumber

Contoh: 100

sum_item_finish_mathnumber

Contoh: 252.24

bonusesobject
accrualobject
sumnumber

Contoh: 0.05

withdrawobject
sumnumber

Contoh: 0.05

pickup_namestring

Contoh: Voronezh-Center

pickup_addressstring

Contoh: Voronezh

operator_phonestring

Contoh: +7 (999) 999-95-95

courier_service_enabledbooleanwajib

Contoh: true

courier_button_showedbooleanwajib

Contoh: true

payment_namestring

Contoh: IOKassa: Visa / MasterCard / MIR

email_settingsobject
format_addressboolean

Contoh: true

lite_versionboolean

Contoh: true

include_photoboolean

Contoh: true

permanent_clientboolean

Contoh: true

client_account_idinteger

Contoh: 4211394

client_branch_profile_idinteger

Contoh: 49000070

api_versioninteger

Contoh: 1

authorized_clientboolean

Contoh: true

synchronization_idstring

Contoh: f6bb7673-ad2d-4b46-9545-2b0a8b37fd29

meta_user_agentstring

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

application_uuidstring

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

additional_contactless_serviceboolean

Contoh: true

additional_cutleryboolean

Contoh: true

additional_not_callbackboolean

Contoh: true

additional_expedited_deliveryboolean

Contoh: true

sum_in_cartnumber

Contoh: 100

notesarray of object
datestring (DataTimeFormatSQL)

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

textstring

Contoh: Status set to confirmed by the automatic order confirmation system

transactionsarray of object
statusstring

Nilai:confirmedrefunded

Contoh: confirmed

datestring (DataTimeFormatSQL)

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

sumnumber

Contoh: 500

order_statusstring (OrderStatus) wajib

Status pesanan: dalam perjalanan, selesai, dalam perakitan, di dapur, belum diproses, siap dikirim, menunggu dikirim ke dapur, menunggu perbaikan, dibatalkan, dikonfirmasi, sudah dimasak

Nilai:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Contoh: confirmed

minutes_to_doneinteger

Contoh: 60

date_preorderstring (DataTimeFormatSQL)

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

timestamp_countdownintegerwajib

Contoh: 1718625496

branch_idintegerwajib

Contoh: 9054

sms_statusstring (OrderSmsStatus) wajib

Status SMS

Nilai: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) wajib

Status email

Nilai:errorwaitingsuccessneed_email

cart_totalnumberwajib

Contoh: 100.55

order_numberinteger

Contoh: 1

date_creationstring (DataTimeFormatSQL) wajib

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

payment_statusstring (OrderPayment) wajib

Status pembayaran: belum dibayar, menunggu, dibayar

Nilai:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Metode pembayaran

Nilai:cashonlinecard_upon_receipt

platformstring (Platform) wajib

Nilai:androidiosallmobile_appssitesocial_apps

Contoh: all

operator_phone_format_idinteger (PhoneFormatId)

Kode negara: 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)

Contoh: 1

operator_phone_numberstring

Contoh: 9114579423

operator_emailstring

Contoh: email@example.com

percent_rateintegerwajib

Contoh: 4

sender_namestring

Contoh: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Kode negara: 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)

Contoh: 1

sender_phone_numberstring

Contoh: 9114579423

sender_emailstring

Contoh: email@example.com

recipient_namestring

Contoh: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Kode negara: 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)

Contoh: 1

recipient_phone_numberstring

Contoh: 9114579423

address_zip_codestring

Contoh: 236039

address_line_1string

Contoh: Korablestroiteley st. 9 bld. 2

address_line_2string

Contoh: Korablestroiteley st. 9 bld. 2

address_streetstring

Contoh: Partizanskaya street

address_housestring

Contoh: 20

address_buildingstring

Contoh: 20

address_entrance_numberstring

Contoh: 20

address_entrance_codestring

Contoh: 1234

address_floorstring

Contoh: 10

address_apartmentstring

Contoh: 10

additional_changestring

Contoh: 100

additional_personsstring

Contoh: 2

additional_commentstring

Contoh: Test order, remove

additional_greeting_cardstring

Contoh: example

additional_discountstring

Contoh: example

tokenstring

Contoh: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) wajib

Metode pengiriman: no — tidak ada, all — semua, courier — kurir, pickup — ambil sendiri

Nilai:noallcourierpickup

phone_settingsobject
mask_enableboolean

Contoh: true

formatboolean

Contoh: true

internationalboolean

Contoh: true

branch_namestring

Contoh: Green Basket | Main

chain_namestringwajib

Contoh: Green Basket

city_namestringwajib

Contoh: Voronezh

district_namestring

Contoh: Voronezh-Uh

district_idinteger

Contoh: 55329