Get order details

GET/api/crm/v2/orders.editv2

operationId: orders.edit

Returns the cart with recalculated discounts and modifiers.

Authorization

api-token + language + role

Query parameters

idintegerrequired

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject (OrderCard)

Order card: cart with recalculated discounts and modifiers, notes, and transactions

idintegerrequired

Example: 12863367

meta_authorized_clientboolean

Example: true

meta_sitestring

Example: shop.foodsoul.pro

meta_utm_sourcestring

Example: shop.foodsoul.pro

meta_utm_mediumstring

Example: shop.foodsoul.pro

meta_utm_campaignstring

Example: shop.foodsoul.pro

meta_utm_contentstring

Example: shop.foodsoul.pro

meta_utm_termstring

Example: shop.foodsoul.pro

cart_bodyobject

delivery_feeinteger

Example: 100

courier_feenumber

Example: 100

service_feenumber

Example: 100

itemsarray of objectrequired

idintegerrequired

Example: 94060278

item_namestring

Example: Item 100

item_parameter_measurestring

Example: 1 pc

countintegerrequired

Example: 1

amountnumber

Example: 1000

new_costnumber

Example: 1000

category_namestring

Example: Sushi rolls

imagestring

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

settingsobjectrequired

discountboolean

Example: true

free_deliveryboolean

Example: true

minimum_sumboolean

Example: true

modifiers_multiplierboolean

Example: true

stock_balanceboolean

Example: true

offersarray of object

idstringrequired

Example: 152366

namestringrequired

Example: 15%

typestring (TypeWorkOperatingMode) required

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

Example: free_delivery

promoobject

idintegerrequired

Example: 27642

codestringrequired

Example: DISCOUNT16

discountobject

amountinteger

Example: 15

typestring

Example: percent

countinteger

Example: 1

use_in_old_costboolean

Example: true

use_in_minimum_sumboolean

Example: true

record_idstring

Example: 1115346

modestring

Example: percent_discount_on_all_order

modifiersarray of object

idintegerrequired

Example: 31369618

namestringrequired

Example: Modifier without a group

amountintegerrequired

Example: 0

new_costinteger

Example: 0

sum_one_modifier_with_countnumber

Example: 0

countintegerrequired

Example: 1

integerinteger

Example: 1

item_contentarray of object

additional_modifiersarray of string

total_sum_modifiersstring

Example: 5

total_sum_itemstring

Example: 100 + 5 = 105

special_offerstring

Example: -10% on pickup

discountstring

Example: 10% (items: 4)

sum_one_itemnumber

Example: 105

finish_sumnumber

Example: 378

total_modifiersnumber

Example: 100

sum_one_item_with_countnumber

Example: 100

sum_one_item_with_modifiersnumber

Example: 100

formulanumber

Example: 100

has_modifiers_multiplierboolean

Example: true

sum_discount_for_itemnumber

Example: 100

sum_item_finish_mathnumber

Example: 252.24

bonusesobject

accrualobject

sumnumber

Example: 0.05

withdrawobject

sumnumber

Example: 0.05

pickup_namestring

Example: Voronezh-Center

pickup_addressstring

Example: Voronezh

operator_phonestring

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

courier_service_enabledbooleanrequired

Example: true

courier_button_showedbooleanrequired

Example: true

payment_namestring

Example: IOKassa: Visa / MasterCard / MIR

email_settingsobject

format_addressboolean

Example: true

lite_versionboolean

Example: true

include_photoboolean

Example: true

permanent_clientboolean

Example: true

client_account_idinteger

Example: 4211394

client_branch_profile_idinteger

Example: 49000070

api_versioninteger

Example: 1

authorized_clientboolean

Example: true

synchronization_idstring

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

meta_user_agentstring

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

application_uuidstring

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

additional_contactless_serviceboolean

Example: true

additional_cutleryboolean

Example: true

additional_not_callbackboolean

Example: true

additional_expedited_deliveryboolean

Example: true

sum_in_cartnumber

Example: 100

notesarray of object

datestring (DataTimeFormatSQL)

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

textstring

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

transactionsarray of object

statusstring

Values:confirmedrefunded

Example: confirmed

datestring (DataTimeFormatSQL)

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

sumnumber

Example: 500

order_statusstring (OrderStatus) required

Order status: on the way, completed, assembling, in the kitchen, not processed, ready for dispatch, waiting to be sent to kitchen, waiting for remake, cancelled, confirmed, prepared

Values:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Example: confirmed

minutes_to_doneinteger

Example: 60

date_preorderstring (DataTimeFormatSQL)

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

timestamp_countdownintegerrequired

Example: 1718625496

branch_idintegerrequired

Example: 9054

sms_statusstring (OrderSmsStatus) required

SMS status

Values: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) required

Email status

Values:errorwaitingsuccessneed_email

cart_totalnumberrequired

Example: 100.55

order_numberinteger

Example: 1

date_creationstring (DataTimeFormatSQL) required

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

payment_statusstring (OrderPayment) required

Payment status: unpaid, pending, paid

Values:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Payment method

Values:cashonlinecard_upon_receipt

platformstring (Platform) required

Values:androidiosallmobile_appssitesocial_apps

Example: all

operator_phone_format_idinteger (PhoneFormatId)

Country code: 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)

Example: 1

operator_phone_numberstring

Example: 9114579423

operator_emailstring

Example: email@example.com

percent_rateintegerrequired

Example: 4

sender_namestring

Example: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Example: 1

sender_phone_numberstring

Example: 9114579423

sender_emailstring

Example: email@example.com

recipient_namestring

Example: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Example: 1

recipient_phone_numberstring

Example: 9114579423

address_zip_codestring

Example: 236039

address_line_1string

Example: Korablestroiteley st. 9 bld. 2

address_line_2string

Example: Korablestroiteley st. 9 bld. 2

address_streetstring

Example: Partizanskaya street

address_housestring

Example: 20

address_buildingstring

Example: 20

address_entrance_numberstring

Example: 20

address_entrance_codestring

Example: 1234

address_floorstring

Example: 10

address_apartmentstring

Example: 10

additional_changestring

Example: 100

additional_personsstring

Example: 2

additional_commentstring

Example: Test order, remove

additional_greeting_cardstring

Example: example

additional_discountstring

Example: example

tokenstring

Example: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) required

Delivery method: no — none, all — all, courier — courier, pickup — pickup

Values:noallcourierpickup

phone_settingsobject

mask_enableboolean

Example: true

formatboolean

Example: true

internationalboolean

Example: true

branch_namestring

Example: Green Basket | Main

chain_namestringrequired

Example: Green Basket

city_namestringrequired

Example: Voronezh

district_namestring

Example: Voronezh-Uh

district_idinteger

Example: 55329

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

<?php

$client = new \GuzzleHttp\Client();

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

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

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

import requests

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

Response 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
  }
}

Requests are sent to foodsoul.ru — the host of this portal; you cannot choose another one.