Obtenir la fiche de commande

GET/api/crm/v2/orders.editv2

operationId: orders.edit

Retourne le panier avec les remises et modificateurs recalculés.

Autorisation

api-token + language + role

Paramètres de requête

idintegerobligatoire

Réponses

object

statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject (OrderCard)

Carte de commande : panier avec remises et modificateurs recalculés, remarques et transactions

idintegerobligatoire

Exemple: 12863367

meta_authorized_clientboolean

Exemple: true

meta_sitestring

Exemple: shop.foodsoul.pro

meta_utm_sourcestring

Exemple: shop.foodsoul.pro

meta_utm_mediumstring

Exemple: shop.foodsoul.pro

meta_utm_campaignstring

Exemple: shop.foodsoul.pro

meta_utm_contentstring

Exemple: shop.foodsoul.pro

meta_utm_termstring

Exemple: shop.foodsoul.pro

cart_bodyobject

delivery_feeinteger

Exemple: 100

courier_feenumber

Exemple: 100

service_feenumber

Exemple: 100

itemsarray of objectobligatoire

idintegerobligatoire

Exemple: 94060278

item_namestring

Exemple: Item 100

item_parameter_measurestring

Exemple: 1 pc

countintegerobligatoire

Exemple: 1

amountnumber

Exemple: 1000

new_costnumber

Exemple: 1000

category_namestring

Exemple: Sushi rolls

imagestring

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

settingsobjectobligatoire

discountboolean

Exemple: true

free_deliveryboolean

Exemple: true

minimum_sumboolean

Exemple: true

modifiers_multiplierboolean

Exemple: true

stock_balanceboolean

Exemple: true

offersarray of object

idstringobligatoire

Exemple: 152366

namestringobligatoire

Exemple: 15%

typestring (TypeWorkOperatingMode) obligatoire

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

Exemple: free_delivery

promoobject

idintegerobligatoire

Exemple: 27642

codestringobligatoire

Exemple: DISCOUNT16

discountobject

amountinteger

Exemple: 15

typestring

Exemple: percent

countinteger

Exemple: 1

use_in_old_costboolean

Exemple: true

use_in_minimum_sumboolean

Exemple: true

record_idstring

Exemple: 1115346

modestring

Exemple: percent_discount_on_all_order

modifiersarray of object

idintegerobligatoire

Exemple: 31369618

namestringobligatoire

Exemple: Modifier without a group

amountintegerobligatoire

Exemple: 0

new_costinteger

Exemple: 0

sum_one_modifier_with_countnumber

Exemple: 0

countintegerobligatoire

Exemple: 1

integerinteger

Exemple: 1

item_contentarray of object

additional_modifiersarray of string

total_sum_modifiersstring

Exemple: 5

total_sum_itemstring

Exemple: 100 + 5 = 105

special_offerstring

Exemple: -10% on pickup

discountstring

Exemple: 10% (items: 4)

sum_one_itemnumber

Exemple: 105

finish_sumnumber

Exemple: 378

total_modifiersnumber

Exemple: 100

sum_one_item_with_countnumber

Exemple: 100

sum_one_item_with_modifiersnumber

Exemple: 100

formulanumber

Exemple: 100

has_modifiers_multiplierboolean

Exemple: true

sum_discount_for_itemnumber

Exemple: 100

sum_item_finish_mathnumber

Exemple: 252.24

bonusesobject

accrualobject

sumnumber

Exemple: 0.05

withdrawobject

sumnumber

Exemple: 0.05

pickup_namestring

Exemple: Voronezh-Center

pickup_addressstring

Exemple: Voronezh

operator_phonestring

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

courier_service_enabledbooleanobligatoire

Exemple: true

courier_button_showedbooleanobligatoire

Exemple: true

payment_namestring

Exemple: IOKassa: Visa / MasterCard / MIR

email_settingsobject

format_addressboolean

Exemple: true

lite_versionboolean

Exemple: true

include_photoboolean

Exemple: true

permanent_clientboolean

Exemple: true

client_account_idinteger

Exemple: 4211394

client_branch_profile_idinteger

Exemple: 49000070

api_versioninteger

Exemple: 1

authorized_clientboolean

Exemple: true

synchronization_idstring

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

meta_user_agentstring

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

application_uuidstring

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

additional_contactless_serviceboolean

Exemple: true

additional_cutleryboolean

Exemple: true

additional_not_callbackboolean

Exemple: true

additional_expedited_deliveryboolean

Exemple: true

sum_in_cartnumber

Exemple: 100

notesarray of object

datestring (DataTimeFormatSQL)

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

textstring

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

transactionsarray of object

statusstring

Valeurs:confirmedrefunded

Exemple: confirmed

datestring (DataTimeFormatSQL)

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

sumnumber

Exemple: 500

order_statusstring (OrderStatus) obligatoire

Statut de la commande : en cours de livraison, terminé, en préparation, en cuisine, non traité, prêt à être expédié, en attente d'envoi en cuisine, en attente de reprise, annulé, confirmé, préparé

Valeurs:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Exemple: confirmed

minutes_to_doneinteger

Exemple: 60

date_preorderstring (DataTimeFormatSQL)

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

timestamp_countdownintegerobligatoire

Exemple: 1718625496

branch_idintegerobligatoire

Exemple: 9054

sms_statusstring (OrderSmsStatus) obligatoire

Statut SMS

Valeurs: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) obligatoire

Statut de l'email

Valeurs:errorwaitingsuccessneed_email

cart_totalnumberobligatoire

Exemple: 100.55

order_numberinteger

Exemple: 1

date_creationstring (DataTimeFormatSQL) obligatoire

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

payment_statusstring (OrderPayment) obligatoire

Statut du paiement : non payé, en attente, payé

Valeurs:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Méthode de paiement

Valeurs:cashonlinecard_upon_receipt

platformstring (Platform) obligatoire

Valeurs:androidiosallmobile_appssitesocial_apps

Exemple: all

operator_phone_format_idinteger (PhoneFormatId)

Code du pays : 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)

Exemple: 1

operator_phone_numberstring

Exemple: 9114579423

operator_emailstring

Exemple: email@example.com

percent_rateintegerobligatoire

Exemple: 4

sender_namestring

Exemple: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Exemple: 1

sender_phone_numberstring

Exemple: 9114579423

sender_emailstring

Exemple: email@example.com

recipient_namestring

Exemple: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Exemple: 1

recipient_phone_numberstring

Exemple: 9114579423

address_zip_codestring

Exemple: 236039

address_line_1string

Exemple: Korablestroiteley st. 9 bld. 2

address_line_2string

Exemple: Korablestroiteley st. 9 bld. 2

address_streetstring

Exemple: Partizanskaya street

address_housestring

Exemple: 20

address_buildingstring

Exemple: 20

address_entrance_numberstring

Exemple: 20

address_entrance_codestring

Exemple: 1234

address_floorstring

Exemple: 10

address_apartmentstring

Exemple: 10

additional_changestring

Exemple: 100

additional_personsstring

Exemple: 2

additional_commentstring

Exemple: Test order, remove

additional_greeting_cardstring

Exemple: example

additional_discountstring

Exemple: example

tokenstring

Exemple: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) obligatoire

Méthode de livraison : no — non, all — tous, courier — coursier, pickup — retrait

Valeurs:noallcourierpickup

phone_settingsobject

mask_enableboolean

Exemple: true

formatboolean

Exemple: true

internationalboolean

Exemple: true

branch_namestring

Exemple: Green Basket | Main

chain_namestringobligatoire

Exemple: Green Basket

city_namestringobligatoire

Exemple: Voronezh

district_namestring

Exemple: Voronezh-Uh

district_idinteger

Exemple: 55329

curl -X GET 'https://foodsoul.pro/api/crm/v2/orders.edit?id=0' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: fr' \
  -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' => 'fr',
        '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": "fr",
        "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": "fr",
        "role": "partner",
    },
)
data = response.json()

Réponse 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
  }
}

Les requêtes sont envoyées à foodsoul.pro — l’hôte de ce portail, il n’est pas possible d’en choisir un autre.