API legada/Referência completa/Pedidos (REST)

Listar pedidos

Retorna até 10 pedidos da loja por requisição, com os dados principais de cada pedido e as informações de paginação.

Este endpoint retorna uma lista de pedidos da sua loja Venddor. Cada requisição devolve os detalhes de até 10 pedidos; use os parâmetros de paginação para obter mais resultados. Chame-o para alimentar um sistema externo, montar relatórios ou construir a sua própria tela de gestão de pedidos.

A lista traz o resumo de cada pedido. Para ver os produtos e os dados de entrega de um pedido, use Obter um pedido.

GET/api/ordersAdmin

Listar todos os pedidos

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/orders/"

Resposta

200Pedidos retornados

json

{
  "orders": [
    {
      "order_id": "12345",
      "status": "P",
      "timestamp": "1712345678",
      "firstname": "John",
      "lastname": "Doe",
      "email": "john.doe@example.com",
      "phone": "+1 234 567 8901",
      "total": "159.97",
      "subtotal": "149.97",
      "tax_subtotal": "0.00",
      "shipping_cost": "10.00",
      "discount": "0.00",
      "payment_id": "credit_card",
      "payment_method": "Credit Card",
      "need_shipping": "Y",
      "shipping_method": "Standard Shipping",
      "items_count": 3
    },
    {
      "order_id": "12346",
      "status": "C",
      "timestamp": "1712244678",
      "firstname": "Jane",
      "lastname": "Smith",
      "email": "jane.smith@example.com",
      "phone": "+1 987 654 3210",
      "total": "49.99",
      "subtotal": "49.99",
      "tax_subtotal": "0.00",
      "shipping_cost": "0.00",
      "discount": "0.00",
      "payment_id": "paypal",
      "payment_method": "PayPal",
      "need_shipping": "N",
      "shipping_method": "",
      "items_count": 1
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": 10,
    "total_items": 2
  }
}

Campos da resposta

ordersarray

Array de objetos de pedido.

order_idstring

Identificador único do pedido.

statusstring

OPCFDBIY

Status do pedido. O é Aberto (Open), P é Em processamento (Processing), C é Concluído (Complete), F é Falhou (Failed), D é Recusado (Declined), B é Em espera por estoque (Backordered), I é Cancelado (Canceled) e Y é Aguardando ligação (Awaiting call).

timestampstring

Timestamp UNIX do momento em que o pedido foi feito.

firstnamestring

Nome do cliente.

lastnamestring

Sobrenome do cliente.

emailstring

E-mail do cliente.

phonestring

Telefone do cliente.

totalstring

Valor total do pedido.

subtotalstring

Valor do pedido antes do frete e dos impostos.

tax_subtotalstring

Valor dos impostos.

shipping_coststring

Custo do frete.

discountstring

Valor do desconto aplicado ao pedido.

payment_idstring

Identificador da forma de pagamento.

payment_methodstring

Nome da forma de pagamento.

need_shippingstring

YN

Indica se o pedido precisa de entrega. Y significa sim e N significa não (produtos digitais).

shipping_methodstring

Nome da forma de envio escolhida.

items_countinteger

Quantidade de itens do pedido.

Parâmetros de paginação na resposta

A API devolve informações básicas de paginação no objeto params.

Campo	Tipo	Descrição
`page`	integer	Número da página atual
`items_per_page`	integer	Quantidade de itens exibidos por página
`total_items`	integer	Total de pedidos que atendem aos critérios do filtro

Casos de uso comuns

Integrar os dados de pedidos com sistemas externos (CRM, contabilidade etc.)
Criar relatórios e análises personalizados de pedidos
Construir telas próprias de gestão de pedidos
Sincronizar os dados de pedidos entre várias plataformas

Veja também