VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/App do vendedor (mobile)

Pedidos

Lista resumida e detalhe de um pedido do seller, sem os campos administrativos.

Listar pedidos

Pedidos do seu seller, do mais novo para o mais antigo. Cada item traz só o necessário para uma linha de lista. Um pedido de marketplace com vários sellers aparece para cada seller pela sua parte.

GET/api/v1/vendor/mobile/ordersSeller

Lista resumida de pedidos

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso de um usuário do painel do seller (lojista), obtido no login (veja Tokens).

Parâmetros de consulta

statusstring
Filtra pelo status do pedido: a letra (O, P, C...) ou o código (pending, processing...). Veja Status de pedido. Status desconhecido devolve lista vazia.
pageintegerpadrão: 1
Página, a partir de 1.
per_pageintegerpadrão: 20
Itens por página. Padrão 20, máximo 50 (valores maiores são reduzidos a 50).

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/vendor/mobile/orders?status=O&per_page=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Pedidos
json
{
  "orders": [
    {
      "id": "6af86ed3-d949-474d-8e04-513c6e83bfe4",
      "order_number": "PEDIDO-20261010-0004",
      "status": "P",
      "total": 22500,
      "customer_name": "Maria Souza",
      "created_at": "2026-10-10T14:22:05.558277Z"
    }
  ],
  "total": 312,
  "page": 1,
  "per_page": 20,
  "total_pages": 16
}

Campos da resposta

ordersarray
Pedidos da página.
orders[].iduuid
Id do pedido.
orders[].order_numberstring
Número mostrado ao cliente.
orders[].statusstring
Letra do status.
orders[].totalinteger
Total do pedido em centavos.
orders[].customer_namestring
Nome do cliente.
orders[].created_atstring
RFC 3339.
totalinteger
Pedidos que atendem ao filtro, em todas as páginas.
pageinteger
Página devolvida.
per_pageinteger
Itens por página aplicado.
total_pagesinteger
Total de páginas.

Erros

StatusQuandoCorpo
401Sem token ou token inválido/expirado.{"error":"missing authorization header"} / {"error":"invalid or expired token"}
403O token não é de um usuário seller (por exemplo, é de um administrador da loja).{"error":"insufficient permissions"}
403O cadastro do seller ainda está em análise (só a tela de cadastro funciona até a aprovação).{"error":"vendor_pending_review","message":"..."}
403O usuário tem papel de seller, mas não está ligado a nenhum seller.{"error":"no vendor account associated with this user"}
500Falha ao listar.{"error":"failed to list orders"}

Detalhe do pedido

Um pedido com itens e endereço de entrega, sem notas internas, IP, navegador nem comissões. O endereço de cobrança não é devolvido.

GET/api/v1/vendor/mobile/orders/{id}Seller

Detalhe de um pedido

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso de um usuário do painel do seller (lojista), obtido no login (veja Tokens).

Parâmetros de caminho

idstringobrigatório
Id (UUID) ou número do pedido.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/vendor/mobile/orders/$ORDER_ID" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Pedido
json
{
  "id": "6af86ed3-d949-474d-8e04-513c6e83bfe4",
  "order_number": "PEDIDO-20261010-0004",
  "status": "P",
  "subtotal": 30000,
  "shipping_total": 0,
  "tax_total": 0,
  "discount_total": 7500,
  "total": 22500,
  "currency": "BRL",
  "payment_method": "pix",
  "payment_status": "captured",
  "shipping_method": "Frete Grátis acima de R$199",
  "tracking_number": null,
  "customer_name": "Maria Souza",
  "customer_email": "maria.souza@example.com",
  "items": [
    {
      "product_id": "d8a6c5e7-8e44-4055-a0e2-49014f5d17f6",
      "product_name": "Cafeteira Moderno Branco",
      "product_sku": "sd-001426",
      "image_url": null,
      "unit_price": 15000,
      "quantity": 2,
      "total": 30000
    }
  ],
  "shipping_address": {
    "first_name": "Maria",
    "last_name": "Souza",
    "address_line1": "Av. Paulista, 1000",
    "city": "São Paulo",
    "state": "SP",
    "postal_code": "01310-100",
    "phone": "+5511987654321"
  },
  "created_at": "2026-10-10T14:22:05.558277Z"
}

Campos da resposta

iduuid
Id do pedido.
order_numberstring
Número do pedido.
statusstring
Letra do status.
subtotalinteger
Soma dos itens, em centavos.
shipping_totalinteger
Frete, em centavos.
tax_totalinteger
Impostos, em centavos.
discount_totalinteger
Descontos, em centavos.
totalinteger
Total, em centavos.
currencystring
Moeda ISO 4217.
payment_methodstring
Código da forma de pagamento.
payment_statusstring
Situação do pagamento, por nome (por exemplo pending, authorized, captured, refunded, failed).
shipping_methodstring
Nome da forma de envio. Ausente se não houver.
tracking_numberstring
Código de rastreio. Ausente se não houver.
customer_namestring
Nome do cliente.
customer_emailstring
E-mail do cliente.
itemsarray
Itens do pedido.
items[].product_iduuid
Id do produto.
items[].product_namestring
Nome no momento da compra.
items[].product_skustring
SKU. Ausente se não houver.
items[].image_urlstring
Imagem. Ausente se não houver.
items[].unit_priceinteger
Preço unitário, em centavos.
items[].quantitynumber
Quantidade (aceita fração para produtos vendidos a peso).
items[].totalinteger
Total da linha, em centavos.
shipping_addressobject
Endereço de entrega: first_name, last_name, address_line1, city, state, postal_code e phone (opcional). Ausente se o pedido não tem endereço de entrega.
created_atstring
RFC 3339.

Erros

StatusQuandoCorpo
401Sem token ou token inválido/expirado.{"error":"missing authorization header"} / {"error":"invalid or expired token"}
403O token não é de um usuário seller (por exemplo, é de um administrador da loja).{"error":"insufficient permissions"}
403O cadastro do seller ainda está em análise (só a tela de cadastro funciona até a aprovação).{"error":"vendor_pending_review","message":"..."}
403O usuário tem papel de seller, mas não está ligado a nenhum seller.{"error":"no vendor account associated with this user"}
403O pedido existe e é de outro seller.{"error":"you do not have access to this order"}
404Pedido inexistente.{"error":"order not found"}
500Falha ao buscar (inclui um id que não é UUID nem número de pedido).{"error":"failed to get order"}
Pedido pai de marketplace

A checagem de dono compara o seller do pedido. Em compras com vários sellers, use o id do sub-pedido do seu seller (veja Sub-pedidos); o pedido pai não tem seller e responde 403.

Anterior
Painel e gráfico
Próxima
Produtos e estoque
Nesta página
  • Listar pedidos
  • Exemplo de requisição
  • Resposta
  • Erros
  • Detalhe do pedido
  • Exemplo de requisição
  • Resposta
  • Erros