Отримати картку замовлення

GET/api/crm/v2/orders.editv2

operationId: orders.edit

Повертає кошик з перерахованими знижками та модифікаторами.

Авторизація

api-token + language + role

Параметри запиту

idintegerобов’язковий

Відповіді

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) обов’язковий

Статус email

Значення: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

sender_phone_numberstring

Приклад: 9114579423

sender_emailstring

Приклад: email@example.com

recipient_namestring

Приклад: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Приклад: 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

curl -X GET 'https://foodsoul.pro/api/crm/v2/orders.edit?id=0' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: uk' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/orders.edit?id=0', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'uk',
        'role' => 'partner',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/orders.edit?id=0", {
    method: "GET",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "uk",
        "role": "partner"
    },
})
const data = await response.json()

import requests

response = requests.request(
    "GET",
    "https://foodsoul.pro/api/crm/v2/orders.edit?id=0",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "uk",
        "role": "partner",
    },
)
data = response.json()

Відповідь 200

{
  "status": "success",
  "data": {
    "id": 12863367,
    "meta_authorized_client": true,
    "meta_site": "shop.foodsoul.pro",
    "meta_utm_source": "shop.foodsoul.pro",
    "meta_utm_medium": "shop.foodsoul.pro",
    "meta_utm_campaign": "shop.foodsoul.pro",
    "meta_utm_content": "shop.foodsoul.pro",
    "meta_utm_term": "shop.foodsoul.pro",
    "cart_body": {
      "delivery_fee": 100,
      "courier_fee": 100,
      "service_fee": 100,
      "items": [
        {
          "id": 94060278,
          "item_name": "Item 100",
          "item_parameter_measure": "1 pc",
          "count": 1,
          "amount": 1000,
          "new_cost": 1000,
          "category_name": "Sushi rolls",
          "image": "https://cdn.crm.git.foodsoul.dev/zones/ru/branches/8920/images/items/medium/fda311c7e13e4abf049a271cb885c11e.jpg?v1735116559",
          "settings": {
            "discount": true,
            "free_delivery": true,
            "minimum_sum": true,
            "modifiers_multiplier": true,
            "stock_balance": true
          },
          "offers": [
            {}
          ],
          "modifiers": [
            {}
          ],
          "item_content": [
            {}
          ],
          "sum_one_item": 105,
          "finish_sum": 378,
          "total_modifiers": 100,
          "sum_one_item_with_count": 100,
          "sum_one_item_with_modifiers": 100,
          "formula": 100,
          "has_modifiers_multiplier": true,
          "sum_discount_for_item": 100,
          "sum_item_finish_math": 252.24
        }
      ],
      "bonuses": {
        "accrual": {
          "sum": 0.05
        },
        "withdraw": {
          "sum": 0.05
        }
      }
    },
    "pickup_name": "Voronezh-Center",
    "pickup_address": "Voronezh",
    "operator_phone": "+7 (999) 999-95-95",
    "courier_service_enabled": true,
    "courier_button_showed": true,
    "payment_name": "IOKassa: Visa / MasterCard / MIR",
    "email_settings": {
      "format_address": true,
      "lite_version": true,
      "include_photo": true,
      "permanent_client": true
    },
    "client_account_id": 4211394,
    "client_branch_profile_id": 49000070,
    "api_version": 1,
    "authorized_client": true,
    "synchronization_id": "f6bb7673-ad2d-4b46-9545-2b0a8b37fd29",
    "meta_user_agent": "FSShop v8.1.2, iOS v18.5, Device: iPad8,6",
    "application_uuid": "03addc0d-1051-4534-9ba8-792b763a274b",
    "additional_contactless_service": true,
    "additional_cutlery": true,
    "additional_not_callback": true,
    "additional_expedited_delivery": true,
    "sum_in_cart": 100,
    "notes": [
      {
        "date": "2024-05-02 08:31:16",
        "text": "Status set to confirmed by the automatic order confirmation system"
      }
    ],
    "transactions": [
      {
        "status": "confirmed",
        "date": "2024-05-02 08:31:16",
        "sum": 500
      }
    ],
    "order_status": "confirmed",
    "minutes_to_done": 60,
    "date_preorder": "2024-05-02 08:31:16",
    "timestamp_countdown": 1718625496,
    "branch_id": 9054,
    "sms_status": "error",
    "email_status": "error",
    "cart_total": 100.55,
    "order_number": 1,
    "date_creation": "2024-05-02 08:31:16",
    "payment_status": "not_paid",
    "payment_method": "cash",
    "platform": "all",
    "operator_phone_format_id": 1,
    "operator_phone_number": "9114579423",
    "operator_email": "email@example.com",
    "percent_rate": 4,
    "sender_name": "John Doe",
    "sender_phone_format_id": 1,
    "sender_phone_number": "9114579423",
    "sender_email": "email@example.com",
    "recipient_name": "John Doe",
    "recipient_phone_format_id": 1,
    "recipient_phone_number": "9114579423",
    "address_zip_code": "236039",
    "address_line_1": "Korablestroiteley st. 9 bld. 2",
    "address_line_2": "Korablestroiteley st. 9 bld. 2",
    "address_street": "Partizanskaya street",
    "address_house": "20",
    "address_building": "20",
    "address_entrance_number": "20",
    "address_entrance_code": "1234",
    "address_floor": "10",
    "address_apartment": "10",
    "additional_change": "100",
    "additional_persons": "2",
    "additional_comment": "Test order, remove",
    "additional_greeting_card": "example",
    "additional_discount": "example",
    "token": "72901fbe661d3e142ea9af5248856f20",
    "delivery_method": "no",
    "phone_settings": {
      "mask_enable": true,
      "format": true,
      "international": true
    },
    "branch_name": "Green Basket | Main",
    "chain_name": "Green Basket",
    "city_name": "Voronezh",
    "district_name": "Voronezh-Uh",
    "district_id": 55329
  }
}

Запити надсилаються на foodsoul.pro — це хост цього порталу, інший обрати неможливо.