Obtener la lista de pedidos

GET/api/crm/v2/ordersv2

operationId: orders.default

Autorización

api-token + language + role

Parámetros de consulta

cursorinteger

Posición desde la que leer la página: pagination.next_cursor — adelante, pagination.previous_cursor — atrás; para la primera página no envíe este parámetro. Es un límite de comparación, no un enlace a una fila: la fila a la que apunta el valor puede no existir, por lo que un enlace obsoleto igualmente abrirá la página desde el mismo lugar. El error 346 se devuelve solo si el valor no puede analizarse como un número entero positivo.

Ejemplo: 84512

directionstring

Dirección de lectura desde el cursor; last abre el final de la lista e ignora el cursor

Valores:nextpreviouslast

Por defecto: next

date_creation_fromstring

Ejemplo: 25/04/2024

date_creation_tostring

Ejemplo: 26/04/2024

chain_idinteger

branch_idinteger

phone_format_idinteger

phone_numberstring

emailstring

order_statusstring (OrderStatus)

Estado del pedido: en camino, completado, en preparación, en cocina, no procesado, listo para enviar, esperando envío a cocina, esperando rehacer, cancelado, confirmado, preparado

Valores:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Ejemplo: confirmed

platformstring (OrderPlatform)

Plataforma de pedido

Valores:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Método de entrega: courier o pickup

Valores:courierpickup

payment_statusstring (OrderPayment)

Estado de pago: no pagado, pendiente, pagado

Valores:not_paidwaitingpaid

order_numberinteger

client_branch_profile_idinteger

client_account_idinteger

operator_idinteger

courier_idinteger

promo_codestring

Filtrar pedidos por código promocional (coincidencia exacta con el código promocional aplicado a las promociones del pedido)

Ejemplo: Promo1

hide_completed_ordersstring

Valores:true

Ejemplo: true

downloadstring

Valores:yes

Ejemplo: yes

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

filtersobject

date_creation_fromobject (FilterDateFrom)

valuestringpuede ser nulo

Ejemplo: 2026-08-01 00:00:00

typestringobligatorio

Ejemplo: date

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

date_creation_toobject (FilterDateTo)

valuestringpuede ser nulo

Ejemplo: 2026-08-31 23:59:59

typestringobligatorio

Ejemplo: date

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

date_creation_rangeobject (FilterDateRange)

Períodos predefinidos para el filtro de fecha; el límite inferior se calcula según la zona horaria del usuario. value — período correspondiente a los valores actuales de *_from y *_to; null — período personalizado. default — período que el servidor utiliza en la solicitud si no se especifican fechas: también se aplica al cargar la sección por primera vez y al restablecer el filtro. El límite superior del período siempre corresponde al día actual del usuario, por lo que option no lo incluye: no es necesario enviar *_to para un período predefinido, el servidor lo establece automáticamente. Si el período es mayor a un año, se recorta por el límite más reciente.

valuestring (DateRange) puede ser nulo

Período de filtro de fecha predefinido. No tiene su propio parámetro de consulta: el límite inferior ya viene calculado en option y se utiliza en *_from. El límite superior no se envía ni en la respuesta ni en la solicitud: siempre corresponde al día actual del usuario y lo define el servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

defaultstring (DateRange) obligatorio

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

typestringobligatorio

Ejemplo: select

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

optionarray of objectobligatorio

valuestring (DateRange) obligatorio

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

date_fromstringobligatorio

Ejemplo: 25/08/2026

chain_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

branch_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

phone_format_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

phone_numberobject (FilterInput)

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: integer or string

placeholderstring

Ejemplo: string

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

emailobject (FilterInput)

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: integer or string

placeholderstring

Ejemplo: string

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

order_statusobject (FilterEnum)

Filtro-enumeración: una lista plana de valores de enumeración

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

platformobject (FilterEnum)

Filtro-enumeración: una lista plana de valores de enumeración

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

delivery_methodobject (FilterEnum)

Filtro-enumeración: una lista plana de valores de enumeración

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

payment_statusobject (FilterEnum)

Filtro-enumeración: una lista plana de valores de enumeración

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

order_numberobject (FilterId)

valueany

Ejemplo: 0

typestringobligatorio

Ejemplo: integer

placeholderstring

Ejemplo: integer

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

client_branch_profile_idobject (FilterId)

valueany

Ejemplo: 0

typestringobligatorio

Ejemplo: integer

placeholderstring

Ejemplo: integer

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

client_account_idobject (FilterId)

valueany

Ejemplo: 0

typestringobligatorio

Ejemplo: integer

placeholderstring

Ejemplo: integer

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

operator_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

courier_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

promo_codeobject (FilterInput)

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: integer or string

placeholderstring

Ejemplo: string

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

hide_completed_ordersobject (FilterBooleanCheckbox)

valueboolean

Для true передайте 1 в запросе, для false ничего не передавайте

Ejemplo: false

typestringobligatorio

Ejemplo: checkbox

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

downloadobject (FilterButtonDownloadCsv)

Botón para descargar la selección: al hacer clic, envíe download=yes

valuestring

Ejemplo: Download

typestringobligatorio

Ejemplo: button_download_csv

listarray of object

idintegerobligatorio

Ejemplo: 12863367

branch_idintegerobligatorio

Ejemplo: 9054

sms_statusstring (OrderSmsStatus) obligatorio

Estado del 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) obligatorio

Estado del email

Valores:errorwaitingsuccessneed_email

order_statusstring (OrderStatus) obligatorio

Estado del pedido: en camino, completado, en preparación, en cocina, no procesado, listo para enviar, esperando envío a cocina, esperando rehacer, cancelado, confirmado, preparado

Valores:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Ejemplo: confirmed

cart_totalnumberobligatorio

Ejemplo: 100.55

order_numberinteger

Ejemplo: 1

date_creationstring (DataTimeFormatSQL) obligatorio

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

date_preorderstring (DataTimeFormatSQL)

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

timestamp_countdownintegerobligatorio

Ejemplo: 1718625496

time_preorderinteger

Ejemplo: 7160

seconds_for_timerinteger

Ejemplo: -14500

last_order_doneboolean

Ejemplo: true

minutes_to_doneinteger

Ejemplo: 60

payment_statusstring (OrderPayment) obligatorio

Estado de pago: no pagado, pendiente, pagado

Valores:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Método de pago

Valores:cashonlinecard_upon_receipt

platformstring (Platform) obligatorio

Valores:androidiosallmobile_appssitesocial_apps

Ejemplo: all

operator_phone_format_idinteger (PhoneFormatId)

Código de 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)

Ejemplo: 1

operator_phone_numberstring

Ejemplo: 9114579423

operator_emailstring

Ejemplo: email@example.com

percent_rateintegerobligatorio

Ejemplo: 4

sender_namestring

Ejemplo: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Ejemplo: 1

sender_phone_numberstring

Ejemplo: 9114579423

sender_emailstring

Ejemplo: email@example.com

recipient_namestring

Ejemplo: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Ejemplo: 1

recipient_phone_numberstring

Ejemplo: 9114579423

address_zip_codestring

Ejemplo: 236039

address_line_1string

Ejemplo: Korablestroiteley st. 9 bld. 2

address_line_2string

Ejemplo: Korablestroiteley st. 9 bld. 2

address_streetstring

Ejemplo: Partizanskaya street

address_housestring

Ejemplo: 20

address_buildingstring

Ejemplo: 20

address_entrance_numberstring

Ejemplo: 20

address_entrance_codestring

Ejemplo: 1234

address_floorstring

Ejemplo: 10

address_apartmentstring

Ejemplo: 10

additional_changestring

Ejemplo: 100

additional_personsstring

Ejemplo: 2

additional_commentstring

Ejemplo: Test order, remove

additional_greeting_cardstring

Ejemplo: example

additional_discountstring

Ejemplo: example

tokenstring

Ejemplo: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) obligatorio

Método de entrega: no — ninguno, all — todos, courier — mensajero, pickup — recogida

Valores:noallcourierpickup

phone_settingsobject

mask_enableboolean

Ejemplo: true

formatboolean

Ejemplo: true

internationalboolean

Ejemplo: true

branch_namestring

Ejemplo: Green Basket | Main

chain_namestringobligatorio

Ejemplo: Green Basket

city_namestringobligatorio

Ejemplo: Voronezh

courier_namestring

Ejemplo: courier name

district_namestring

Ejemplo: Voronezh-Uh

district_idinteger

Ejemplo: 55329

application_uuidstring

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

paginationobject (PaginationCursor)

max_countintegerobligatorio

Cantidad de elementos por página

Ejemplo: 30

cursorintegerobligatoriopuede ser nulo

Cursor con el que se solicita la página actual; null — para la primera página

next_cursorintegerobligatoriopuede ser nulo

id de la última fila en esta página: páselo con direction=next para avanzar; null si no hay más datos

Ejemplo: 84512

previous_cursorintegerobligatoriopuede ser nulo

El id de la primera fila en esta página: páselo con direction=previous para retroceder; null si no hay nada antes

Ejemplo: 84543

has_nextbooleanobligatorio

¿Hay una página siguiente?

Ejemplo: true

has_previousbooleanobligatorio

¿Hay una página anterior?

Ejemplo: false

curl -X GET 'https://foodsoul.ru/api/crm/v2/orders' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: es' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

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

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

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

import requests

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

Respuesta 200

{
  "status": "success",
  "data": {
    "filters": {
      "date_creation_from": {
        "value": "2026-08-01 00:00:00",
        "type": "date",
        "mode": "value_required"
      },
      "date_creation_to": {
        "value": "2026-08-31 23:59:59",
        "type": "date",
        "mode": "value_required"
      },
      "date_creation_range": {
        "value": "today",
        "default": "today",
        "type": "select",
        "mode": "value_required",
        "option": [
          {
            "value": "today",
            "date_from": "25/08/2026"
          }
        ]
      },
      "chain_id": {
        "value": 8920,
        "type": "select",
        "option": [
          {
            "value": 8920,
            "name": "Green Basket | Kaliningrad"
          }
        ],
        "mode": "value_required"
      },
      "branch_id": {
        "value": 8920,
        "type": "select",
        "option": [
          {
            "value": 8920,
            "name": "Green Basket | Kaliningrad"
          }
        ],
        "mode": "value_required"
      },
      "phone_format_id": {
        "value": 8920,
        "type": "select",
        "option": [
          {
            "value": 8920,
            "name": "Green Basket | Kaliningrad"
          }
        ],
        "mode": "value_required"
      },
      "phone_number": {
        "value": "example",
        "type": "integer or string",
        "placeholder": "string",
        "mode": "value_required"
      },
      "email": {
        "value": "example",
        "type": "integer or string",
        "placeholder": "string",
        "mode": "value_required"
      },
      "order_status": {
        "value": "example",
        "type": "select",
        "option": [
          "string"
        ],
        "mode": "value_required"
      },
      "platform": {
        "value": "example",
        "type": "select",
        "option": [
          "string"
        ],
        "mode": "value_required"
      },
      "delivery_method": {
        "value": "example",
        "type": "select",
        "option": [
          "string"
        ],
        "mode": "value_required"
      },
      "payment_status": {
        "value": "example",
        "type": "select",
        "option": [
          "string"
        ],
        "mode": "value_required"
      },
      "order_number": {
        "value": 0,
        "type": "integer",
        "placeholder": "integer",
        "mode": "value_required"
      },
      "client_branch_profile_id": {
        "value": 0,
        "type": "integer",
        "placeholder": "integer",
        "mode": "value_required"
      },
      "client_account_id": {
        "value": 0,
        "type": "integer",
        "placeholder": "integer",
        "mode": "value_required"
      },
      "operator_id": {
        "value": 8920,
        "type": "select",
        "option": [
          {
            "value": 8920,
            "name": "Green Basket | Kaliningrad"
          }
        ],
        "mode": "value_required"
      },
      "courier_id": {
        "value": 8920,
        "type": "select",
        "option": [
          {
            "value": 8920,
            "name": "Green Basket | Kaliningrad"
          }
        ],
        "mode": "value_required"
      },
      "promo_code": {
        "value": "example",
        "type": "integer or string",
        "placeholder": "string",
        "mode": "value_required"
      },
      "hide_completed_orders": {
        "value": false,
        "type": "checkbox",
        "mode": "value_required"
      },
      "download": {
        "value": "Download",
        "type": "button_download_csv"
      }
    },
    "list": [
      {
        "id": 12863367,
        "branch_id": 9054,
        "sms_status": "error",
        "email_status": "error",
        "order_status": "confirmed",
        "cart_total": 100.55,
        "order_number": 1,
        "date_creation": "2024-05-02 08:31:16",
        "date_preorder": "2024-05-02 08:31:16",
        "timestamp_countdown": 1718625496,
        "time_preorder": 7160,
        "seconds_for_timer": -14500,
        "last_order_done": true,
        "minutes_to_done": 60,
        "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",
        "courier_name": "courier name",
        "district_name": "Voronezh-Uh",
        "district_id": 55329,
        "application_uuid": "03addc0d-1051-4534-9ba8-792b763a274b"
      }
    ],
    "pagination": {
      "max_count": 30,
      "cursor": 0,
      "next_cursor": 84512,
      "previous_cursor": 84543,
      "has_next": true,
      "has_previous": false
    }
  }
}

Las solicitudes se envían a foodsoul.ru, que es el host de este portal; no se puede elegir otro.