Z

Zoppy Partners API

Pedidos

/orders

Gerencie os pedidos da sua loja. Pedidos podem conter itens, cupons, informações de loja e vendedor.

Modelo

Propriedade	Tipo		Descrição
`id`	string	Obrigatório	ID único do pedido (UUID)
`externalId`	string	Opcional	ID do pedido no seu sistema/provedor
`status`	string	Obrigatório	Status do pedido (completed, canceled, on-hold, processing). Um POST com processing volta aqui como on-hold.
`subtotal`	number	Obrigatório	Valor antes do desconto, com frete (total + discount + shipping)
`total`	number	Obrigatório	Valor dos produtos com desconto, sem frete (subtotal - discount - shipping)
`discount`	number	Opcional	Valor total do desconto
`shipping`	number	Opcional	Custo do frete
`couponCode`	string	Opcional	Código do cupom utilizado
`completedAt`	Date	Opcional	Data de conclusão do pedido
`provider`	string	Opcional	Identificador do provedor de integração
`customerId`	string	Obrigatório	ID do cliente
`storeId`	string	Opcional	ID da loja
`userId`	string	Opcional	ID do usuário vendedor
`customer`	CustomerResponse	Obrigatório	Dados completos do cliente
`lineItems`	LineItemResponse[]	Opcional	Itens do pedido com o produto incluso. product traz o cadastro atual do produto (preço de hoje, mesmo que inactive). Quando dois produtos do pedido não têm externalId, ou têm o mesmo, product pode mostrar o outro produto: use lineItems[].productId como referência e mande externalId único em todo produto
`couponCreated`	CouponResponse	Opcional	Cupom criado por este pedido
`couponUsed`	CouponResponse	Opcional	Cupom utilizado neste pedido
`createdAt`	Date	Obrigatório	Data de criação
`updatedAt`	Date	Obrigatório	Data de atualização

Endpoints