Skip to main content
POST
Criar pedido

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

Body

application/json

Detalhes do pedido

Requisição para criação de pedidos

status
enum<string>
required

Alias do status (Veja GET {alias}/checkout/statuses para mais informações).

Available options:
waiting_payment,
cancelled,
on_carriage,
delivered,
shipment_exception,
invoiced,
paid,
refused,
authorized,
created,
handling_products,
ready_for_shipping,
ready_for_pickup
number
integer<int64>
required

Número único do pedido por loja. Obrigatório, exceto quando usar marketplace_sale_number.

customer_id
integer
required

ID do cliente pertencente à loja (e, se aplicável, ao mesmo marketplace).

value_total
number<float>
required

Valor total do pedido, resultado da soma dos produtos e do frete menos os descontos aplicados.

value_products
number<float>
required

Valor total dos produtos do pedido, sem frete nem descontos.

Required range: x >= 0
value_discount
number<float>
required

Valor total de descontos aplicados ao pedido.

Required range: x >= 0
value_shipment
number<float>
required

Valor do frete cobrado no pedido, em reais.

Required range: x >= 0
shipment_service
string
required

Alias Serviço de frete escolhido.

days_delivery
integer
required

Prazo estimado de entrega do pedido, em dias.

Required range: x >= 0
items
object[]
required

Lista de produtos incluídos no pedido.

Minimum array length: 1
address
object[]
required

Endereço de entrega.

Required array length: 1 element
marketplace_id
integer | null

Obrigatório se o comprador vier de um marketplace específico.

marketplace_account_id
integer | null

Conta do marketplace (precisa pertencer à loja).

authorized
boolean | null

Define se o pedido inicia autorizado; pode ser inferido pelo status da conta do marketplace.

marketplace_sale_number
string | null

Número único do pedido no marketplace (por loja/conta). Quando presente, substitui a necessidade de 'number'.

value_tax
number<float> | null

Valor de juros do gateway de pagamento cobrado no pedido, quando aplicável.

Required range: x >= 0
ip

IP do comprador, pode ser IPv4 ou IPv6.

Example:

"200.179.10.10"

transactions
object[] | null

Transação do pedido.

sent_to_antifraud
boolean | null

Indica se o pedido foi enviado para análise de antifraude, disponível apenas quando a loja tem um provedor de antifraude cadastrado.

capture_date
string<date> | null

Data em que o pagamento do pedido foi capturado.

authorized_at
string<date-time> | null

Data e hora em que o pagamento do pedido foi autorizado.

Example:

"2025-07-31 23:59:59"

captured_at
string<date-time> | null

Data e hora em que o pagamento do pedido foi capturado.

Example:

"2025-07-31 23:59:59"

cancelled_at
string<date-time> | null

Data e hora em que o pedido foi cancelado.

Example:

"2025-07-31 23:59:59"

track_code
string | null

Código de rastreio do envio. O valor é sanitizado e normalizado automaticamente.

track_url
string | null

URL de rastreio do envio. O valor é sanitizado e normalizado automaticamente.

Response

Pedido criado com sucesso

Representa um pedido

delivered
boolean

Indica se o pedido já foi entregue ao cliente.

track_url
string

URL de rastreamento da entrega gerada pela transportadora.

track_code
string

Código de rastreamento da entrega gerado pela transportadora.

authorized
boolean

Indica se o pagamento do pedido foi autorizado pela adquirente/gateway.

customer_id
integer

ID do cliente

promocode_id
integer

ID do cupom de desconto aplicado ao pedido, quando houver.

marketplace_id
integer

ID do marketplace de origem do pedido, quando a venda vem de um marketplace.

marketplace_account_id
integer

ID da conta do marketplace vinculada ao pedido.

has_recomm
boolean

Indica se o pedido teve origem no clique em um produto sugerido pelo e-mail de recomendação.

number
number

Número do pedido

marketplace_partner_id
integer

ID do parceiro/afiliado do marketplace associado ao pedido, quando aplicável.

marketplace_sale_number
number

Número único da venda no marketplace de origem (usado quando não há number local do pedido).

value_total
number<float>

Valor total do pedido

value_products
number<float>

Valor dos produtos

value_discount
number<float>

Valor do desconto

value_shipment
number<float>

Valor do frete

value_tax
number<float>

Valor do imposto

shipment_service
string

Método de entrega

shipment_quote_id
integer

ID da cotação de frete utilizada no pedido.

days_delivery
integer

Dias para entrega

utm_source
string

Origem da campanha de marketing (parâmetro UTM utm_source) que originou o pedido.

utm_campaign
string

Nome da campanha de marketing (parâmetro UTM utm_campaign) que originou o pedido.

utm_term
string

Termo de busca (parâmetro UTM utm_term) que originou o pedido.

utm_content
string

Conteúdo do anúncio/link (parâmetro UTM utm_content) que originou o pedido.

utm_medium
string

Meio/canal de marketing (parâmetro UTM utm_medium) que originou o pedido.

ip
string<ip>
read-only

Endereço IP do comprador no momento da criação do pedido.

items
object[]

Itens do pedido

address
Endereço do pedido · object[]

Endereço de entrega

transactions
object

Transações de pagamento associadas ao pedido.