API

შეკვეთის ბარათის მიღება

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

აბრუნებს კალათას გადათვლილი ფასდაკლებებით და მოდიფიკატორებით.

ავტორიზაცია

api-token + language + role

მოთხოვნის პარამეტრები

idintegerსავალდებულო

პასუხები

OK

object
statusstringსავალდებულო

მნიშვნელობები:successerror

მაგალითი: success

dataobject (OrderCard)

შეკვეთის ბარათი: კალათა გადათვლილი ფასდაკლებებით და მოდიფიკატორებით, შენიშვნები და ტრანზაქციები

idintegerსავალდებულო

მაგალითი: 12863367

meta_authorized_clientboolean

მაგალითი: true

meta_sitestring

მაგალითი: shop.foodsoul.pro

meta_utm_sourcestring

მაგალითი: shop.foodsoul.pro

meta_utm_mediumstring

მაგალითი: shop.foodsoul.pro

meta_utm_campaignstring

მაგალითი: shop.foodsoul.pro

meta_utm_contentstring

მაგალითი: shop.foodsoul.pro

meta_utm_termstring

მაგალითი: shop.foodsoul.pro

cart_bodyobject
delivery_feeinteger

მაგალითი: 100

courier_feenumber

მაგალითი: 100

service_feenumber

მაგალითი: 100

itemsarray of objectსავალდებულო
idintegerსავალდებულო

მაგალითი: 94060278

item_namestring

მაგალითი: Item 100

item_parameter_measurestring

მაგალითი: 1 pc

countintegerსავალდებულო

მაგალითი: 1

amountnumber

მაგალითი: 1000

new_costnumber

მაგალითი: 1000

category_namestring

მაგალითი: Sushi rolls

imagestring

მაგალითი: https://cdn.crm.git.foodsoul.dev/zones/ru/branches/8920/images/items/medium/fda311c7e13e4abf049a271cb885c11e.jpg?v1735116559

settingsobjectსავალდებულო
discountboolean

მაგალითი: true

free_deliveryboolean

მაგალითი: true

minimum_sumboolean

მაგალითი: true

modifiers_multiplierboolean

მაგალითი: true

stock_balanceboolean

მაგალითი: true

offersarray of object
idstringსავალდებულო

მაგალითი: 152366

namestringსავალდებულო

მაგალითი: 15%

typestring (TypeWorkOperatingMode) სავალდებულო

მნიშვნელობები: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

მაგალითი: free_delivery

promoobject
idintegerსავალდებულო

მაგალითი: 27642

codestringსავალდებულო

მაგალითი: DISCOUNT16

discountobject
amountinteger

მაგალითი: 15

typestring

მაგალითი: percent

countinteger

მაგალითი: 1

use_in_old_costboolean

მაგალითი: true

use_in_minimum_sumboolean

მაგალითი: true

record_idstring

მაგალითი: 1115346

modestring

მაგალითი: percent_discount_on_all_order

modifiersarray of object
idintegerსავალდებულო

მაგალითი: 31369618

namestringსავალდებულო

მაგალითი: Modifier without a group

amountintegerსავალდებულო

მაგალითი: 0

new_costinteger

მაგალითი: 0

sum_one_modifier_with_countnumber

მაგალითი: 0

countintegerსავალდებულო

მაგალითი: 1

integerinteger

მაგალითი: 1

item_contentarray of object
additional_modifiersarray of string
total_sum_modifiersstring

მაგალითი: 5

total_sum_itemstring

მაგალითი: 100 + 5 = 105

special_offerstring

მაგალითი: -10% on pickup

discountstring

მაგალითი: 10% (items: 4)

sum_one_itemnumber

მაგალითი: 105

finish_sumnumber

მაგალითი: 378

total_modifiersnumber

მაგალითი: 100

sum_one_item_with_countnumber

მაგალითი: 100

sum_one_item_with_modifiersnumber

მაგალითი: 100

formulanumber

მაგალითი: 100

has_modifiers_multiplierboolean

მაგალითი: true

sum_discount_for_itemnumber

მაგალითი: 100

sum_item_finish_mathnumber

მაგალითი: 252.24

bonusesobject
accrualobject
sumnumber

მაგალითი: 0.05

withdrawobject
sumnumber

მაგალითი: 0.05

pickup_namestring

მაგალითი: Voronezh-Center

pickup_addressstring

მაგალითი: Voronezh

operator_phonestring

მაგალითი: +7 (999) 999-95-95

courier_service_enabledbooleanსავალდებულო

მაგალითი: true

courier_button_showedbooleanსავალდებულო

მაგალითი: true

payment_namestring

მაგალითი: IOKassa: Visa / MasterCard / MIR

email_settingsobject
format_addressboolean

მაგალითი: true

lite_versionboolean

მაგალითი: true

include_photoboolean

მაგალითი: true

permanent_clientboolean

მაგალითი: true

client_account_idinteger

მაგალითი: 4211394

client_branch_profile_idinteger

მაგალითი: 49000070

api_versioninteger

მაგალითი: 1

authorized_clientboolean

მაგალითი: true

synchronization_idstring

მაგალითი: f6bb7673-ad2d-4b46-9545-2b0a8b37fd29

meta_user_agentstring

მაგალითი: FSShop v8.1.2, iOS v18.5, Device: iPad8,6

application_uuidstring

მაგალითი: 03addc0d-1051-4534-9ba8-792b763a274b

additional_contactless_serviceboolean

მაგალითი: true

additional_cutleryboolean

მაგალითი: true

additional_not_callbackboolean

მაგალითი: true

additional_expedited_deliveryboolean

მაგალითი: true

sum_in_cartnumber

მაგალითი: 100

notesarray of object
datestring (DataTimeFormatSQL)

მაგალითი: 2024-05-02 08:31:16

textstring

მაგალითი: Status set to confirmed by the automatic order confirmation system

transactionsarray of object
statusstring

მნიშვნელობები:confirmedrefunded

მაგალითი: confirmed

datestring (DataTimeFormatSQL)

მაგალითი: 2024-05-02 08:31:16

sumnumber

მაგალითი: 500

order_statusstring (OrderStatus) სავალდებულო

შეკვეთის სტატუსი: გზაშია, შესრულებულია, შეკრება, სამზარეულოშია, არ დამუშავებულა, გაგზავნისთვის მზადაა, სამზარეულოში გაგზავნის მოლოდინშია, გადაკეთების მოლოდინშია, გაუქმებულია, დადასტურებულია, მომზადებულია

მნიშვნელობები:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

მაგალითი: confirmed

minutes_to_doneinteger

მაგალითი: 60

date_preorderstring (DataTimeFormatSQL)

მაგალითი: 2024-05-02 08:31:16

timestamp_countdownintegerსავალდებულო

მაგალითი: 1718625496

branch_idintegerსავალდებულო

მაგალითი: 9054

sms_statusstring (OrderSmsStatus) სავალდებულო

SMS-ის სტატუსი

მნიშვნელობები: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) სავალდებულო

ელფოსტის სტატუსი

მნიშვნელობები:errorwaitingsuccessneed_email

cart_totalnumberსავალდებულო

მაგალითი: 100.55

order_numberinteger

მაგალითი: 1

date_creationstring (DataTimeFormatSQL) სავალდებულო

მაგალითი: 2024-05-02 08:31:16

payment_statusstring (OrderPayment) სავალდებულო

გადახდის სტატუსი: არ გადახდილია, მოლოდინშია, გადახდილია

მნიშვნელობები:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

გადახდის მეთოდი

მნიშვნელობები:cashonlinecard_upon_receipt

platformstring (Platform) სავალდებულო

მნიშვნელობები:androidiosallmobile_appssitesocial_apps

მაგალითი: all

operator_phone_format_idinteger (PhoneFormatId)

ქვეყნის კოდი: 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)

მაგალითი: 1

operator_phone_numberstring

მაგალითი: 9114579423

operator_emailstring

მაგალითი: email@example.com

percent_rateintegerსავალდებულო

მაგალითი: 4

sender_namestring

მაგალითი: John Doe

sender_phone_format_idinteger (PhoneFormatId)

ქვეყნის კოდი: 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)

მაგალითი: 1

sender_phone_numberstring

მაგალითი: 9114579423

sender_emailstring

მაგალითი: email@example.com

recipient_namestring

მაგალითი: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

ქვეყნის კოდი: 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)

მაგალითი: 1

recipient_phone_numberstring

მაგალითი: 9114579423

address_zip_codestring

მაგალითი: 236039

address_line_1string

მაგალითი: Korablestroiteley st. 9 bld. 2

address_line_2string

მაგალითი: Korablestroiteley st. 9 bld. 2

address_streetstring

მაგალითი: Partizanskaya street

address_housestring

მაგალითი: 20

address_buildingstring

მაგალითი: 20

address_entrance_numberstring

მაგალითი: 20

address_entrance_codestring

მაგალითი: 1234

address_floorstring

მაგალითი: 10

address_apartmentstring

მაგალითი: 10

additional_changestring

მაგალითი: 100

additional_personsstring

მაგალითი: 2

additional_commentstring

მაგალითი: Test order, remove

additional_greeting_cardstring

მაგალითი: example

additional_discountstring

მაგალითი: example

tokenstring

მაგალითი: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) სავალდებულო

მიწოდების მეთოდი: no — არაა, all — ყველა, courier — კურიერი, pickup — თვითგატანა

მნიშვნელობები:noallcourierpickup

phone_settingsobject
mask_enableboolean

მაგალითი: true

formatboolean

მაგალითი: true

internationalboolean

მაგალითი: true

branch_namestring

მაგალითი: Green Basket | Main

chain_namestringსავალდებულო

მაგალითი: Green Basket

city_namestringსავალდებულო

მაგალითი: Voronezh

district_namestring

მაგალითი: Voronezh-Uh

district_idinteger

მაგალითი: 55329