Obter o cartão do pedido

GET/api/crm/v2/orders.editv2

operationId: orders.edit

Retorna o carrinho com descontos e modificadores recalculados.

Autorização

api-token + language + role

Parâmetros de consulta

idintegerobrigatório

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject (OrderCard)

Cartão de pedido: carrinho com descontos e modificadores recalculados, observações e transações

idintegerobrigatório

Exemplo: 12863367

meta_authorized_clientboolean

Exemplo: true

meta_sitestring

Exemplo: shop.foodsoul.pro

meta_utm_sourcestring

Exemplo: shop.foodsoul.pro

meta_utm_mediumstring

Exemplo: shop.foodsoul.pro

meta_utm_campaignstring

Exemplo: shop.foodsoul.pro

meta_utm_contentstring

Exemplo: shop.foodsoul.pro

meta_utm_termstring

Exemplo: shop.foodsoul.pro

cart_bodyobject

delivery_feeinteger

Exemplo: 100

courier_feenumber

Exemplo: 100

service_feenumber

Exemplo: 100

itemsarray of objectobrigatório

idintegerobrigatório

Exemplo: 94060278

item_namestring

Exemplo: Item 100

item_parameter_measurestring

Exemplo: 1 pc

countintegerobrigatório

Exemplo: 1

amountnumber

Exemplo: 1000

new_costnumber

Exemplo: 1000

category_namestring

Exemplo: Sushi rolls

imagestring

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

settingsobjectobrigatório

discountboolean

Exemplo: true

free_deliveryboolean

Exemplo: true

minimum_sumboolean

Exemplo: true

modifiers_multiplierboolean

Exemplo: true

stock_balanceboolean

Exemplo: true

offersarray of object

idstringobrigatório

Exemplo: 152366

namestringobrigatório

Exemplo: 15%

typestring (TypeWorkOperatingMode) obrigatório

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

Exemplo: free_delivery

promoobject

idintegerobrigatório

Exemplo: 27642

codestringobrigatório

Exemplo: DISCOUNT16

discountobject

amountinteger

Exemplo: 15

typestring

Exemplo: percent

countinteger

Exemplo: 1

use_in_old_costboolean

Exemplo: true

use_in_minimum_sumboolean

Exemplo: true

record_idstring

Exemplo: 1115346

modestring

Exemplo: percent_discount_on_all_order

modifiersarray of object

idintegerobrigatório

Exemplo: 31369618

namestringobrigatório

Exemplo: Modifier without a group

amountintegerobrigatório

Exemplo: 0

new_costinteger

Exemplo: 0

sum_one_modifier_with_countnumber

Exemplo: 0

countintegerobrigatório

Exemplo: 1

integerinteger

Exemplo: 1

item_contentarray of object

additional_modifiersarray of string

total_sum_modifiersstring

Exemplo: 5

total_sum_itemstring

Exemplo: 100 + 5 = 105

special_offerstring

Exemplo: -10% on pickup

discountstring

Exemplo: 10% (items: 4)

sum_one_itemnumber

Exemplo: 105

finish_sumnumber

Exemplo: 378

total_modifiersnumber

Exemplo: 100

sum_one_item_with_countnumber

Exemplo: 100

sum_one_item_with_modifiersnumber

Exemplo: 100

formulanumber

Exemplo: 100

has_modifiers_multiplierboolean

Exemplo: true

sum_discount_for_itemnumber

Exemplo: 100

sum_item_finish_mathnumber

Exemplo: 252.24

bonusesobject

accrualobject

sumnumber

Exemplo: 0.05

withdrawobject

sumnumber

Exemplo: 0.05

pickup_namestring

Exemplo: Voronezh-Center

pickup_addressstring

Exemplo: Voronezh

operator_phonestring

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

courier_service_enabledbooleanobrigatório

Exemplo: true

courier_button_showedbooleanobrigatório

Exemplo: true

payment_namestring

Exemplo: IOKassa: Visa / MasterCard / MIR

email_settingsobject

format_addressboolean

Exemplo: true

lite_versionboolean

Exemplo: true

include_photoboolean

Exemplo: true

permanent_clientboolean

Exemplo: true

client_account_idinteger

Exemplo: 4211394

client_branch_profile_idinteger

Exemplo: 49000070

api_versioninteger

Exemplo: 1

authorized_clientboolean

Exemplo: true

synchronization_idstring

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

meta_user_agentstring

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

application_uuidstring

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

additional_contactless_serviceboolean

Exemplo: true

additional_cutleryboolean

Exemplo: true

additional_not_callbackboolean

Exemplo: true

additional_expedited_deliveryboolean

Exemplo: true

sum_in_cartnumber

Exemplo: 100

notesarray of object

datestring (DataTimeFormatSQL)

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

textstring

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

transactionsarray of object

statusstring

Valores:confirmedrefunded

Exemplo: confirmed

datestring (DataTimeFormatSQL)

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

sumnumber

Exemplo: 500

order_statusstring (OrderStatus) obrigatório

Status do pedido: em trânsito, concluído, em montagem, na cozinha, não processado, pronto para envio, aguardando envio para a cozinha, aguardando refação, cancelado, confirmado, preparado

Valores:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Exemplo: confirmed

minutes_to_doneinteger

Exemplo: 60

date_preorderstring (DataTimeFormatSQL)

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

timestamp_countdownintegerobrigatório

Exemplo: 1718625496

branch_idintegerobrigatório

Exemplo: 9054

sms_statusstring (OrderSmsStatus) obrigatório

Status do SMS

Valores: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) obrigatório

Status do email

Valores:errorwaitingsuccessneed_email

cart_totalnumberobrigatório

Exemplo: 100.55

order_numberinteger

Exemplo: 1

date_creationstring (DataTimeFormatSQL) obrigatório

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

payment_statusstring (OrderPayment) obrigatório

Status do pagamento: não pago, pendente, pago

Valores:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Método de pagamento

Valores:cashonlinecard_upon_receipt

platformstring (Platform) obrigatório

Valores:androidiosallmobile_appssitesocial_apps

Exemplo: all

operator_phone_format_idinteger (PhoneFormatId)

Código do país: 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)

Exemplo: 1

operator_phone_numberstring

Exemplo: 9114579423

operator_emailstring

Exemplo: email@example.com

percent_rateintegerobrigatório

Exemplo: 4

sender_namestring

Exemplo: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Exemplo: 1

sender_phone_numberstring

Exemplo: 9114579423

sender_emailstring

Exemplo: email@example.com

recipient_namestring

Exemplo: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Exemplo: 1

recipient_phone_numberstring

Exemplo: 9114579423

address_zip_codestring

Exemplo: 236039

address_line_1string

Exemplo: Korablestroiteley st. 9 bld. 2

address_line_2string

Exemplo: Korablestroiteley st. 9 bld. 2

address_streetstring

Exemplo: Partizanskaya street

address_housestring

Exemplo: 20

address_buildingstring

Exemplo: 20

address_entrance_numberstring

Exemplo: 20

address_entrance_codestring

Exemplo: 1234

address_floorstring

Exemplo: 10

address_apartmentstring

Exemplo: 10

additional_changestring

Exemplo: 100

additional_personsstring

Exemplo: 2

additional_commentstring

Exemplo: Test order, remove

additional_greeting_cardstring

Exemplo: example

additional_discountstring

Exemplo: example

tokenstring

Exemplo: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) obrigatório

Método de entrega: no — não, all — todos, courier — courier, pickup — retirada

Valores:noallcourierpickup

phone_settingsobject

mask_enableboolean

Exemplo: true

formatboolean

Exemplo: true

internationalboolean

Exemplo: true

branch_namestring

Exemplo: Green Basket | Main

chain_namestringobrigatório

Exemplo: Green Basket

city_namestringobrigatório

Exemplo: Voronezh

district_namestring

Exemplo: Voronezh-Uh

district_idinteger

Exemplo: 55329

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

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

As solicitações são enviadas para foodsoul.ru — o host deste portal, não é possível escolher outro.