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
value_products
number<float>
required
Required range: x >= 0
value_discount
number<float>
required
Required range: x >= 0
value_shipment
number<float>
required
Required range: x >= 0
shipment_service
string
required

Alias Serviço de frete escolhido.

days_delivery
integer
required
Required range: x >= 0
items
object[]
required
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
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
capture_date
string<date> | null
authorized_at
string<date-time> | null
Example:

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

captured_at
string<date-time> | null
Example:

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

cancelled_at
string<date-time> | null
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
track_url
string
track_code
string
authorized
boolean
customer_id
integer

ID do cliente

promocode_id
integer
marketplace_id
integer
marketplace_account_id
integer
has_recomm
boolean
number
number

Número do pedido

marketplace_partner_id
integer
marketplace_sale_number
number
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
days_delivery
integer

Dias para entrega

utm_source
string
utm_campaign
string
utm_term
string
utm_content
string
utm_medium
string
ip
string<ip>
read-only
items
object[]

Itens do pedido

address
Endereço do pedido · object[]

Endereço de entrega

transactions
object