API

Obțineți fișa comenzii

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

Returnează coșul cu reduceri și modificatori recalculeazăți.

Autorizare

api-token + language + role

Parametri de interogare

idintegerobligatoriu

Răspunsuri

OK

object
statusstringobligatoriu

Valori:successerror

Exemplu: success

dataobject (OrderCard)

Card de comandă: coș cu reduceri și modificatori recalculeazăți, note și tranzacții

idintegerobligatoriu

Exemplu: 12863367

meta_authorized_clientboolean

Exemplu: true

meta_sitestring

Exemplu: shop.foodsoul.pro

meta_utm_sourcestring

Exemplu: shop.foodsoul.pro

meta_utm_mediumstring

Exemplu: shop.foodsoul.pro

meta_utm_campaignstring

Exemplu: shop.foodsoul.pro

meta_utm_contentstring

Exemplu: shop.foodsoul.pro

meta_utm_termstring

Exemplu: shop.foodsoul.pro

cart_bodyobject
delivery_feeinteger

Exemplu: 100

courier_feenumber

Exemplu: 100

service_feenumber

Exemplu: 100

itemsarray of objectobligatoriu
idintegerobligatoriu

Exemplu: 94060278

item_namestring

Exemplu: Item 100

item_parameter_measurestring

Exemplu: 1 pc

countintegerobligatoriu

Exemplu: 1

amountnumber

Exemplu: 1000

new_costnumber

Exemplu: 1000

category_namestring

Exemplu: Sushi rolls

imagestring

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

settingsobjectobligatoriu
discountboolean

Exemplu: true

free_deliveryboolean

Exemplu: true

minimum_sumboolean

Exemplu: true

modifiers_multiplierboolean

Exemplu: true

stock_balanceboolean

Exemplu: true

offersarray of object
idstringobligatoriu

Exemplu: 152366

namestringobligatoriu

Exemplu: 15%

typestring (TypeWorkOperatingMode) obligatoriu

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

Exemplu: free_delivery

promoobject
idintegerobligatoriu

Exemplu: 27642

codestringobligatoriu

Exemplu: DISCOUNT16

discountobject
amountinteger

Exemplu: 15

typestring

Exemplu: percent

countinteger

Exemplu: 1

use_in_old_costboolean

Exemplu: true

use_in_minimum_sumboolean

Exemplu: true

record_idstring

Exemplu: 1115346

modestring

Exemplu: percent_discount_on_all_order

modifiersarray of object
idintegerobligatoriu

Exemplu: 31369618

namestringobligatoriu

Exemplu: Modifier without a group

amountintegerobligatoriu

Exemplu: 0

new_costinteger

Exemplu: 0

sum_one_modifier_with_countnumber

Exemplu: 0

countintegerobligatoriu

Exemplu: 1

integerinteger

Exemplu: 1

item_contentarray of object
additional_modifiersarray of string
total_sum_modifiersstring

Exemplu: 5

total_sum_itemstring

Exemplu: 100 + 5 = 105

special_offerstring

Exemplu: -10% on pickup

discountstring

Exemplu: 10% (items: 4)

sum_one_itemnumber

Exemplu: 105

finish_sumnumber

Exemplu: 378

total_modifiersnumber

Exemplu: 100

sum_one_item_with_countnumber

Exemplu: 100

sum_one_item_with_modifiersnumber

Exemplu: 100

formulanumber

Exemplu: 100

has_modifiers_multiplierboolean

Exemplu: true

sum_discount_for_itemnumber

Exemplu: 100

sum_item_finish_mathnumber

Exemplu: 252.24

bonusesobject
accrualobject
sumnumber

Exemplu: 0.05

withdrawobject
sumnumber

Exemplu: 0.05

pickup_namestring

Exemplu: Voronezh-Center

pickup_addressstring

Exemplu: Voronezh

operator_phonestring

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

courier_service_enabledbooleanobligatoriu

Exemplu: true

courier_button_showedbooleanobligatoriu

Exemplu: true

payment_namestring

Exemplu: IOKassa: Visa / MasterCard / MIR

email_settingsobject
format_addressboolean

Exemplu: true

lite_versionboolean

Exemplu: true

include_photoboolean

Exemplu: true

permanent_clientboolean

Exemplu: true

client_account_idinteger

Exemplu: 4211394

client_branch_profile_idinteger

Exemplu: 49000070

api_versioninteger

Exemplu: 1

authorized_clientboolean

Exemplu: true

synchronization_idstring

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

meta_user_agentstring

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

application_uuidstring

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

additional_contactless_serviceboolean

Exemplu: true

additional_cutleryboolean

Exemplu: true

additional_not_callbackboolean

Exemplu: true

additional_expedited_deliveryboolean

Exemplu: true

sum_in_cartnumber

Exemplu: 100

notesarray of object
datestring (DataTimeFormatSQL)

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

textstring

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

transactionsarray of object
statusstring

Valori:confirmedrefunded

Exemplu: confirmed

datestring (DataTimeFormatSQL)

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

sumnumber

Exemplu: 500

order_statusstring (OrderStatus) obligatoriu

Stare comandă: în drum, finalizat, în asamblare, la bucătărie, neprocesat, gata de expediere, așteaptă trimiterea la bucătărie, așteaptă refacere, anulat, confirmat, pregătit

Valori:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Exemplu: confirmed

minutes_to_doneinteger

Exemplu: 60

date_preorderstring (DataTimeFormatSQL)

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

timestamp_countdownintegerobligatoriu

Exemplu: 1718625496

branch_idintegerobligatoriu

Exemplu: 9054

sms_statusstring (OrderSmsStatus) obligatoriu

Stare SMS

Valori: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) obligatoriu

Stare email

Valori:errorwaitingsuccessneed_email

cart_totalnumberobligatoriu

Exemplu: 100.55

order_numberinteger

Exemplu: 1

date_creationstring (DataTimeFormatSQL) obligatoriu

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

payment_statusstring (OrderPayment) obligatoriu

Stare plată: neplătit, în așteptare, plătit

Valori:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Metoda de plată

Valori:cashonlinecard_upon_receipt

platformstring (Platform) obligatoriu

Valori:androidiosallmobile_appssitesocial_apps

Exemplu: all

operator_phone_format_idinteger (PhoneFormatId)

Codul țării: 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)

Exemplu: 1

operator_phone_numberstring

Exemplu: 9114579423

operator_emailstring

Exemplu: email@example.com

percent_rateintegerobligatoriu

Exemplu: 4

sender_namestring

Exemplu: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Codul țării: 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)

Exemplu: 1

sender_phone_numberstring

Exemplu: 9114579423

sender_emailstring

Exemplu: email@example.com

recipient_namestring

Exemplu: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Codul țării: 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)

Exemplu: 1

recipient_phone_numberstring

Exemplu: 9114579423

address_zip_codestring

Exemplu: 236039

address_line_1string

Exemplu: Korablestroiteley st. 9 bld. 2

address_line_2string

Exemplu: Korablestroiteley st. 9 bld. 2

address_streetstring

Exemplu: Partizanskaya street

address_housestring

Exemplu: 20

address_buildingstring

Exemplu: 20

address_entrance_numberstring

Exemplu: 20

address_entrance_codestring

Exemplu: 1234

address_floorstring

Exemplu: 10

address_apartmentstring

Exemplu: 10

additional_changestring

Exemplu: 100

additional_personsstring

Exemplu: 2

additional_commentstring

Exemplu: Test order, remove

additional_greeting_cardstring

Exemplu: example

additional_discountstring

Exemplu: example

tokenstring

Exemplu: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) obligatoriu

Metoda de livrare: no — nu, all — toate, courier — curier, pickup — ridicare personală

Valori:noallcourierpickup

phone_settingsobject
mask_enableboolean

Exemplu: true

formatboolean

Exemplu: true

internationalboolean

Exemplu: true

branch_namestring

Exemplu: Green Basket | Main

chain_namestringobligatoriu

Exemplu: Green Basket

city_namestringobligatoriu

Exemplu: Voronezh

district_namestring

Exemplu: Voronezh-Uh

district_idinteger

Exemplu: 55329