🧩 Campos e Estrutura

Entidade order

Fluxograma dos pedidos

---

Campos

Abaixo, segue a descrição dos possíveis campos e seus valores nas requisições desta entidade.

Campo	Campo Pai	Tipo	Descrição
entity_id	-	int	Identificador único do pedido
increment_id	-	string	ID Incremental do pedido. Ex.: #100000001
state	-	string	State atual do pedido. Confira a lista de states disponíveis
created_at	-	datetime	Data e hora da criação do pedido Formato: yyyy-MM-ddTHH:mm:ss
updated_at	-	datetime	Data e hora da última atualização do pedido Formato: yyyy-MM-ddTHH:mm:ss
subtotal	-	float	Subtotal do pedido (sem frete e descontos gerais)
total	-	float	Total final do pedido, somando todos os valores e atribuindo todos os descontos (caso hajam)
shipping	-	shipping_object	Dados referentes a entrega do pedido
payment	-	payment_object	Dados referentes ao pagamento do pedido
customer	-	customer_object	Dados referentes ao cliente que realizou o pedido
items	-	array de item_object	Itens (produtos) que compõe o pedido em questão

shipping_object

Dados referentes a entrega do pedido.

Campo	Campo Pai	Tipo	Descrição
price	shipping	float	Preço da entrega
method	shipping	string	Método/transportadora utilizado para entrega
address	shipping	address_object	ID do endereço de entrega. Saiba mais em: Clientes - Endereços

payment_object

Dados referentes ao pagamento do pedido.

Campo	Campo Pai	Tipo	Descrição
total_discount	payment	float	Valor total de desconto aplicado ao pedido
method	payment	string	Código do método de pagamento. Saiba mais em: 🧩 Métodos de Pagamento
type	payment	string	Tipo da forma de pagamento pix - PIX billet - Boleto credit_card - Cartão de Crédito other - Tipos adicionais
installments	payment	int|false	Número de parcelas (ou´false quando não aplicável)
address	payment	address_object	ID do endereço de cobrança. Saiba mais em: Clientes - Endereços

customer_object

Campo	Campo Pai	Tipo	Descrição
entity_id	customer	int|false	ID do cliente. false em caso do pedido ter sido realizado por um visitante * Mesmo que o ID esteja presente neste campo, é possível que o cliente não exista mais na loja
firstname	customer	string	Primeiro nome do cliente
lastname	customer	string	Sobrenome do cliente
email	customer	string	E-mail do cliente
document	customer	string	CPF/CNPJ do cliente (apenas números)
telephone	customer	string	Telefone (apenas dígitos) do cliente. Caso não exista, retornará null

item_object

Dados referentes ao cliente que realizou o pedido.

Campo	Campo Pai	Tipo	Descrição
item_id	items	int	ID do item de pedido
product_id	items	int	ID do produto em si * Mesmo que o ID esteja presente neste campo, é possível que o produto não exista mais na loja
sku	items	string	SKU do produto
price	items	float	Preço do item, no contexto do pedido
qty	items	int	Quantidade adquirida do item de pedido