API de Pedidos

Consulte pedidos, atualize status e gerencie envios.

Endpoints

GET

/orders

orders:read

Obtenha uma lista paginada de pedidos. Suporta filtragem por status e intervalo de datas.

GET

/orders/:id

orders:read

Obtenha um pedido com todos os itens e detalhes de envio.

PUT

/orders/:id/status

orders:write

Atualize o status de um pedido (ex. marcar como enviado).

POST

/orders/:id/shipment

orders:write

Anexe informacoes de rastreamento de envio a um pedido.

Referencia de Campos

Campo	Tipo	Obrigatorio	Descricao
id	string	Nao	Identificador unico do pedido (somente leitura)
orderNumber	string	Nao	Numero do pedido legivel (somente leitura)
customerId	string	Nao	ID do cliente (ausente para pedidos de convidados)
status	string	Nao	PENDING, CONFIRMED, PROCESSING, SHIPPED, DELIVERED, CANCELLED, REFUNDED
paymentStatus	string	Nao	pending, paid, refunded, failed
paymentMethod	string	Nao	Método de pagamento utilizado (ex: stripe, cod)
total	integer	Nao	Total em centavos (somente leitura)
items	OrderLine[]	Nao	Array de itens (somente leitura)
shippingAddress	Address	Nao	Objeto de endereco de envio
fulfillmentType	string	Nao	shipping, pickup, delivery ou digital
createdAt	datetime	Nao	Timestamp ISO 8601 (somente leitura)
updatedAt	datetime	Nao	Carimbo de data/hora ISO 8601 (somente leitura)

Parametros de Consulta (Lista)

Campo	Tipo	Obrigatorio	Descricao
page	integer	Nao	Numero da pagina (padrao: 1)
limit	integer	Nao	Itens por pagina (padrao: 20, max: 100)

Exemplo

Listar pedidos recentes

bash

curl "https://api.mercozy.com/api/v1/external/orders?page=1&limit=10" \
  -H "X-API-Key: mk_live_your_key_here"

Atualizar status do pedido

bash

curl -X PUT "https://api.mercozy.com/api/v1/external/orders/ord_abc123/status" \
  -H "X-API-Key: mk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "shipped"
  }'

Criar rastreamento de envio

bash

curl -X POST "https://api.mercozy.com/api/v1/external/orders/ord_abc123/shipment" \
  -H "X-API-Key: mk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "carrier": "fedex",
    "trackingNumber": "7489236401",
    "trackingUrl": "https://www.fedex.com/track?id=7489236401"
  }'