Obter a lista de pedidos

GET/api/crm/v2/ordersv2

operationId: orders.default

Autorização

api-token + language + role

Parâmetros de consulta

cursorinteger

Posição a partir da qual a página será lida: pagination.next_cursor — para frente, pagination.previous_cursor — para trás; para a primeira página, não envie este parâmetro. Este é um delimitador de comparação, não um link para uma linha: a linha apontada pelo valor pode não existir, portanto, um cursor desatualizado ainda abrirá a página a partir do mesmo ponto. O erro 346 é retornado apenas se o valor não puder ser interpretado como um número inteiro positivo.

Exemplo: 84512

directionstring

Direção de leitura a partir do cursor; last abre o final da lista e ignora o cursor

Valores:nextpreviouslast

Por padrão: next

date_creation_fromstring

Exemplo: 25/04/2024

date_creation_tostring

Exemplo: 26/04/2024

chain_idinteger

branch_idinteger

phone_format_idinteger

phone_numberstring

emailstring

order_statusstring (OrderStatus)

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

platformstring (OrderPlatform)

Plataforma de pedido

Valores:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Método de entrega: courier ou retirada

Valores:courierpickup

payment_statusstring (OrderPayment)

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

Valores:not_paidwaitingpaid

order_numberinteger

client_branch_profile_idinteger

client_account_idinteger

operator_idinteger

courier_idinteger

promo_codestring

Filtro de pedidos por código promocional (correspondência exata com o código promocional aplicado às promoções do pedido)

Exemplo: Promo1

hide_completed_ordersstring

Valores:true

Exemplo: true

downloadstring

Valores:yes

Exemplo: yes

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

filtersobject

date_creation_fromobject (FilterDateFrom)

valuestringpode ser nulo

Exemplo: 2026-08-01 00:00:00

typestringobrigatório

Exemplo: date

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

date_creation_toobject (FilterDateTo)

valuestringpode ser nulo

Exemplo: 2026-08-31 23:59:59

typestringobrigatório

Exemplo: date

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

date_creation_rangeobject (FilterDateRange)

Períodos prontos para filtro de data; o limite inferior é calculado no fuso horário do usuário. value — período correspondente aos atuais *_from e *_to; null — período personalizado. default — período que o servidor insere na requisição sem datas: também é aplicado no primeiro carregamento da seção e ao redefinir o filtro. O limite superior do período é sempre igual ao dia atual do usuário, por isso option não o inclui: não é necessário enviar *_to para um período pronto, o servidor define automaticamente. Períodos com duração superior a um ano são cortados no limite mais recente.

valuestring (DateRange) pode ser nulo

Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

defaultstring (DateRange) obrigatório

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

typestringobrigatório

Exemplo: select

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

optionarray of objectobrigatório

valuestring (DateRange) obrigatório

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

date_fromstringobrigatório

Exemplo: 25/08/2026

chain_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

branch_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

phone_format_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

phone_numberobject (FilterInput)

valuestring

Exemplo: example

typestringobrigatório

Exemplo: integer or string

placeholderstring

Exemplo: string

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

emailobject (FilterInput)

valuestring

Exemplo: example

typestringobrigatório

Exemplo: integer or string

placeholderstring

Exemplo: string

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

order_statusobject (FilterEnum)

Filtro de enumeração — lista plana de valores de enum

valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of string

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

platformobject (FilterEnum)

Filtro de enumeração — lista plana de valores de enum

valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of string

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

delivery_methodobject (FilterEnum)

Filtro de enumeração — lista plana de valores de enum

valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of string

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

payment_statusobject (FilterEnum)

Filtro de enumeração — lista plana de valores de enum

valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of string

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

order_numberobject (FilterId)

valueany

Exemplo: 0

typestringobrigatório

Exemplo: integer

placeholderstring

Exemplo: integer

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

client_branch_profile_idobject (FilterId)

valueany

Exemplo: 0

typestringobrigatório

Exemplo: integer

placeholderstring

Exemplo: integer

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

client_account_idobject (FilterId)

valueany

Exemplo: 0

typestringobrigatório

Exemplo: integer

placeholderstring

Exemplo: integer

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

operator_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

courier_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

promo_codeobject (FilterInput)

valuestring

Exemplo: example

typestringobrigatório

Exemplo: integer or string

placeholderstring

Exemplo: string

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

hide_completed_ordersobject (FilterBooleanCheckbox)

valueboolean

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

Exemplo: false

typestringobrigatório

Exemplo: checkbox

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

downloadobject (FilterButtonDownloadCsv)

Botão de download da seleção: ao clicar, envie download=yes

valuestring

Exemplo: Download

typestringobrigatório

Exemplo: button_download_csv

listarray of object

idintegerobrigatório

Exemplo: 12863367

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

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

cart_totalnumberobrigatório

Exemplo: 100.55

order_numberinteger

Exemplo: 1

date_creationstring (DataTimeFormatSQL) obrigatório

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

date_preorderstring (DataTimeFormatSQL)

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

timestamp_countdownintegerobrigatório

Exemplo: 1718625496

time_preorderinteger

Exemplo: 7160

seconds_for_timerinteger

Exemplo: -14500

last_order_doneboolean

Exemplo: true

minutes_to_doneinteger

Exemplo: 60

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

courier_namestring

Exemplo: courier name

district_namestring

Exemplo: Voronezh-Uh

district_idinteger

Exemplo: 55329

application_uuidstring

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

paginationobject (PaginationCursor)

max_countintegerobrigatório

Número de itens por página

Exemplo: 30

cursorintegerobrigatóriopode ser nulo

Cursor com o qual a página atual foi solicitada; null — para a primeira página

next_cursorintegerobrigatóriopode ser nulo

id da última linha nesta página: envie-o com direction=next para avançar; null — se não houver mais nada adiante

Exemplo: 84512

previous_cursorintegerobrigatóriopode ser nulo

O id da primeira linha nesta página: envie-o com direction=previous para voltar; null — se não houver nada antes

Exemplo: 84543

has_nextbooleanobrigatório

Existe uma próxima página

Exemplo: true

has_previousbooleanobrigatório

Existe uma página anterior

Exemplo: false

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

<?php

$client = new \GuzzleHttp\Client();

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

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/orders", {
    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.pro/api/crm/v2/orders",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
    },
)
data = response.json()

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

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