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.
/api/v1/vendor/mobile/ordersSellerLista resumida de pedidos
Cabeçalhos
AuthorizationstringobrigatórioBearer $TOKEN. Token de acesso de um usuário do painel do seller (lojista), obtido no login (veja Tokens).Parâmetros de consulta
statusstringFiltra 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: 1Página, a partir de 1.
per_pageintegerpadrão: 20Itens por página. Padrão 20, máximo 50 (valores maiores são reduzidos a 50).
Exemplo de requisição
Resposta
200Pedidos
Campos da resposta
ordersarrayPedidos da página.
orders[].iduuidId do pedido.
orders[].order_numberstringNúmero mostrado ao cliente.
orders[].statusstringLetra do status.
orders[].totalintegerTotal do pedido em centavos.
orders[].customer_namestringNome do cliente.
orders[].created_atstringRFC 3339.
totalintegerPedidos que atendem ao filtro, em todas as páginas.
pageintegerPágina devolvida.
per_pageintegerItens por página aplicado.
total_pagesintegerTotal de páginas.
Erros
| Status | Quando | Corpo |
|---|---|---|
| 401 | Sem token ou token inválido/expirado. | {"error":"missing authorization header"} / {"error":"invalid or expired token"} |
| 403 | O token não é de um usuário seller (por exemplo, é de um administrador da loja). | {"error":"insufficient permissions"} |
| 403 | O cadastro do seller ainda está em análise (só a tela de cadastro funciona até a aprovação). | {"error":"vendor_pending_review","message":"..."} |
| 403 | O usuário tem papel de seller, mas não está ligado a nenhum seller. | {"error":"no vendor account associated with this user"} |
| 500 | Falha 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.
/api/v1/vendor/mobile/orders/{id}SellerDetalhe de um pedido
Cabeçalhos
AuthorizationstringobrigatórioBearer $TOKEN. Token de acesso de um usuário do painel do seller (lojista), obtido no login (veja Tokens).Parâmetros de caminho
idstringobrigatórioId (UUID) ou número do pedido.
Exemplo de requisição
Resposta
200Pedido
Campos da resposta
iduuidId do pedido.
order_numberstringNúmero do pedido.
statusstringLetra do status.
subtotalintegerSoma dos itens, em centavos.
shipping_totalintegerFrete, em centavos.
tax_totalintegerImpostos, em centavos.
discount_totalintegerDescontos, em centavos.
totalintegerTotal, em centavos.
currencystringMoeda ISO 4217.
payment_methodstringCódigo da forma de pagamento.
payment_statusstringSituação do pagamento, por nome (por exemplo
pending, authorized, captured, refunded, failed).shipping_methodstringNome da forma de envio. Ausente se não houver.
tracking_numberstringCódigo de rastreio. Ausente se não houver.
customer_namestringNome do cliente.
customer_emailstringE-mail do cliente.
itemsarrayItens do pedido.
items[].product_iduuidId do produto.
items[].product_namestringNome no momento da compra.
items[].product_skustringSKU. Ausente se não houver.
items[].image_urlstringImagem. Ausente se não houver.
items[].unit_priceintegerPreço unitário, em centavos.
items[].quantitynumberQuantidade (aceita fração para produtos vendidos a peso).
items[].totalintegerTotal da linha, em centavos.
shipping_addressobjectEndereç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_atstringRFC 3339.
Erros
| Status | Quando | Corpo |
|---|---|---|
| 401 | Sem token ou token inválido/expirado. | {"error":"missing authorization header"} / {"error":"invalid or expired token"} |
| 403 | O token não é de um usuário seller (por exemplo, é de um administrador da loja). | {"error":"insufficient permissions"} |
| 403 | O cadastro do seller ainda está em análise (só a tela de cadastro funciona até a aprovação). | {"error":"vendor_pending_review","message":"..."} |
| 403 | O usuário tem papel de seller, mas não está ligado a nenhum seller. | {"error":"no vendor account associated with this user"} |
| 403 | O pedido existe e é de outro seller. | {"error":"you do not have access to this order"} |
| 404 | Pedido inexistente. | {"error":"order not found"} |
| 500 | Falha ao buscar (inclui um id que não é UUID nem número de pedido). | {"error":"failed to get order"} |