Skip to main content
GET
List Order

Autorizações

Authorization
string
header
obrigatório

Token de API gerado no painel da CentralCart.

Parâmetros de consulta

page_cursor
string

Cursor da próxima página: o internal_id do último pedido da página anterior, devolvido em next_cursor. Envie vazio (?page_cursor=) na primeira chamada. Ordena por data, mais recentes primeiro.

page_size
number

Itens por página (máximo: 200, padrão: 50).

from
string

Data inicial para filtrar pedidos (formato: YYYY-MM-DD). Deve ser usado junto com to

to
string

Data final para filtrar pedidos (formato: YYYY-MM-DD). Deve ser usado junto com from

status

Status do pedido: APPROVED, REJECTED, CANCELED, REFUNDED, CHARGEDBACK. Pode ser um array para filtrar múltiplos status

Opções disponíveis:
APPROVED,
REJECTED,
CANCELED,
REFUNDED,
CHARGEDBACK
email
string

Filtrar pedidos por email do cliente (busca parcial)

client_id
string

Filtrar pedidos por ID do cliente

user_id
string

Filtrar pedidos por ID do usuário (alias para client_id)

pay_id
string

Filtrar pedidos por ID externo do gateway de pagamento

package

Filtrar pedidos por ID(s) do(s) pacote(s)

discount

Filtrar pedidos por ID(s) do(s) desconto(s)

variables

Filtrar pedidos por nome(s) da(s) variável(is)

gateways

Filtrar pedidos por gateway(s) de pagamento

affiliates

Filtrar pedidos por ID(s) do(s) afiliado(s)

Resposta

200 - application/json

OK

data
object[]

Lista de pedidos

next_cursor
string | null

Cursor da próxima página: o internal_id do último pedido. Reenvie em page_cursor. Vem null na última página.