API

Bestelldetails abrufen

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

Gibt den Warenkorb mit neu berechneten Rabatten und Modifikatoren zurück.

Autorisierung

api-token + language + role

Abfrageparameter

idintegererforderlich

Antworten

OK

object
statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject (OrderCard)

Bestellkarte: Warenkorb mit neu berechneten Rabatten und Modifikatoren, Anmerkungen und Transaktionen

idintegererforderlich

Beispiel: 12863367

meta_authorized_clientboolean

Beispiel: true

meta_sitestring

Beispiel: shop.foodsoul.pro

meta_utm_sourcestring

Beispiel: shop.foodsoul.pro

meta_utm_mediumstring

Beispiel: shop.foodsoul.pro

meta_utm_campaignstring

Beispiel: shop.foodsoul.pro

meta_utm_contentstring

Beispiel: shop.foodsoul.pro

meta_utm_termstring

Beispiel: shop.foodsoul.pro

cart_bodyobject
delivery_feeinteger

Beispiel: 100

courier_feenumber

Beispiel: 100

service_feenumber

Beispiel: 100

itemsarray of objecterforderlich
idintegererforderlich

Beispiel: 94060278

item_namestring

Beispiel: Item 100

item_parameter_measurestring

Beispiel: 1 pc

countintegererforderlich

Beispiel: 1

amountnumber

Beispiel: 1000

new_costnumber

Beispiel: 1000

category_namestring

Beispiel: Sushi rolls

imagestring

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

settingsobjecterforderlich
discountboolean

Beispiel: true

free_deliveryboolean

Beispiel: true

minimum_sumboolean

Beispiel: true

modifiers_multiplierboolean

Beispiel: true

stock_balanceboolean

Beispiel: true

offersarray of object
idstringerforderlich

Beispiel: 152366

namestringerforderlich

Beispiel: 15%

typestring (TypeWorkOperatingMode) erforderlich

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

Beispiel: free_delivery

promoobject
idintegererforderlich

Beispiel: 27642

codestringerforderlich

Beispiel: DISCOUNT16

discountobject
amountinteger

Beispiel: 15

typestring

Beispiel: percent

countinteger

Beispiel: 1

use_in_old_costboolean

Beispiel: true

use_in_minimum_sumboolean

Beispiel: true

record_idstring

Beispiel: 1115346

modestring

Beispiel: percent_discount_on_all_order

modifiersarray of object
idintegererforderlich

Beispiel: 31369618

namestringerforderlich

Beispiel: Modifier without a group

amountintegererforderlich

Beispiel: 0

new_costinteger

Beispiel: 0

sum_one_modifier_with_countnumber

Beispiel: 0

countintegererforderlich

Beispiel: 1

integerinteger

Beispiel: 1

item_contentarray of object
additional_modifiersarray of string
total_sum_modifiersstring

Beispiel: 5

total_sum_itemstring

Beispiel: 100 + 5 = 105

special_offerstring

Beispiel: -10% on pickup

discountstring

Beispiel: 10% (items: 4)

sum_one_itemnumber

Beispiel: 105

finish_sumnumber

Beispiel: 378

total_modifiersnumber

Beispiel: 100

sum_one_item_with_countnumber

Beispiel: 100

sum_one_item_with_modifiersnumber

Beispiel: 100

formulanumber

Beispiel: 100

has_modifiers_multiplierboolean

Beispiel: true

sum_discount_for_itemnumber

Beispiel: 100

sum_item_finish_mathnumber

Beispiel: 252.24

bonusesobject
accrualobject
sumnumber

Beispiel: 0.05

withdrawobject
sumnumber

Beispiel: 0.05

pickup_namestring

Beispiel: Voronezh-Center

pickup_addressstring

Beispiel: Voronezh

operator_phonestring

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

courier_service_enabledbooleanerforderlich

Beispiel: true

courier_button_showedbooleanerforderlich

Beispiel: true

payment_namestring

Beispiel: IOKassa: Visa / MasterCard / MIR

email_settingsobject
format_addressboolean

Beispiel: true

lite_versionboolean

Beispiel: true

include_photoboolean

Beispiel: true

permanent_clientboolean

Beispiel: true

client_account_idinteger

Beispiel: 4211394

client_branch_profile_idinteger

Beispiel: 49000070

api_versioninteger

Beispiel: 1

authorized_clientboolean

Beispiel: true

synchronization_idstring

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

meta_user_agentstring

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

application_uuidstring

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

additional_contactless_serviceboolean

Beispiel: true

additional_cutleryboolean

Beispiel: true

additional_not_callbackboolean

Beispiel: true

additional_expedited_deliveryboolean

Beispiel: true

sum_in_cartnumber

Beispiel: 100

notesarray of object
datestring (DataTimeFormatSQL)

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

textstring

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

transactionsarray of object
statusstring

Werte:confirmedrefunded

Beispiel: confirmed

datestring (DataTimeFormatSQL)

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

sumnumber

Beispiel: 500

order_statusstring (OrderStatus) erforderlich

Bestellstatus: unterwegs, abgeschlossen, Zusammenstellung, in der Küche, nicht bearbeitet, versandbereit, wartet auf Versand in die Küche, wartet auf Nachbesserung, storniert, bestätigt, zubereitet

Werte:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Beispiel: confirmed

minutes_to_doneinteger

Beispiel: 60

date_preorderstring (DataTimeFormatSQL)

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

timestamp_countdownintegererforderlich

Beispiel: 1718625496

branch_idintegererforderlich

Beispiel: 9054

sms_statusstring (OrderSmsStatus) erforderlich

SMS-Status

Werte: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) erforderlich

E-Mail-Status

Werte:errorwaitingsuccessneed_email

cart_totalnumbererforderlich

Beispiel: 100.55

order_numberinteger

Beispiel: 1

date_creationstring (DataTimeFormatSQL) erforderlich

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

payment_statusstring (OrderPayment) erforderlich

Zahlungsstatus: nicht bezahlt, ausstehend, bezahlt

Werte:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Zahlungsmethode

Werte:cashonlinecard_upon_receipt

platformstring (Platform) erforderlich

Werte:androidiosallmobile_appssitesocial_apps

Beispiel: all

operator_phone_format_idinteger (PhoneFormatId)

Ländercode: 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)

Beispiel: 1

operator_phone_numberstring

Beispiel: 9114579423

operator_emailstring

Beispiel: email@example.com

percent_rateintegererforderlich

Beispiel: 4

sender_namestring

Beispiel: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Ländercode: 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)

Beispiel: 1

sender_phone_numberstring

Beispiel: 9114579423

sender_emailstring

Beispiel: email@example.com

recipient_namestring

Beispiel: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Ländercode: 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)

Beispiel: 1

recipient_phone_numberstring

Beispiel: 9114579423

address_zip_codestring

Beispiel: 236039

address_line_1string

Beispiel: Korablestroiteley st. 9 bld. 2

address_line_2string

Beispiel: Korablestroiteley st. 9 bld. 2

address_streetstring

Beispiel: Partizanskaya street

address_housestring

Beispiel: 20

address_buildingstring

Beispiel: 20

address_entrance_numberstring

Beispiel: 20

address_entrance_codestring

Beispiel: 1234

address_floorstring

Beispiel: 10

address_apartmentstring

Beispiel: 10

additional_changestring

Beispiel: 100

additional_personsstring

Beispiel: 2

additional_commentstring

Beispiel: Test order, remove

additional_greeting_cardstring

Beispiel: example

additional_discountstring

Beispiel: example

tokenstring

Beispiel: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) erforderlich

Liefermethode: no — keine, all — alle, courier — Kurier, pickup — Abholung

Werte:noallcourierpickup

phone_settingsobject
mask_enableboolean

Beispiel: true

formatboolean

Beispiel: true

internationalboolean

Beispiel: true

branch_namestring

Beispiel: Green Basket | Main

chain_namestringerforderlich

Beispiel: Green Basket

city_namestringerforderlich

Beispiel: Voronezh

district_namestring

Beispiel: Voronezh-Uh

district_idinteger

Beispiel: 55329