Sign in

v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB
Pedidos - Pedido

Criar pedido

Cria um pedido na loja (é necessário ter um cliente pré-cadastrado)

post/{alias}/orders

Path parameters

aliasstring required

Alias da loja

Request body

status'waiting_payment' | 'cancelled' | 'on_carriage' | 'delivered' | 'shipment_exception' | 'invoiced' | 'paid' | 'refused' | 'authorized' | 'created' | 'handling_products' | 'ready_for_shipping' | 'ready_for_pickup' required

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

marketplace_idinteger nullable

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

marketplace_account_idinteger nullable

Conta do marketplace (precisa pertencer à loja).

authorizedboolean nullable

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

numberinteger required

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

marketplace_sale_numberstring nullable

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

customer_idinteger required

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

value_totalnumber float required

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

value_productsnumber float required

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

value_discountnumber float required

Valor total de descontos aplicados ao pedido.

value_shipmentnumber float required

Valor do frete cobrado no pedido, em reais.

value_taxnumber float nullable

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

shipment_servicestring required

Alias Serviço de frete escolhido.

days_deliveryinteger required

Prazo estimado de entrega do pedido, em dias.

sent_to_antifraudboolean nullable

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

capture_datestring date nullable

Data em que o pagamento do pedido foi capturado.

authorized_atstring date-time nullable

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

captured_atstring date-time nullable

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

cancelled_atstring date-time nullable

Data e hora em que o pedido foi cancelado.

track_codestring nullable

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

track_urlstring nullable

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

cart_tokenstring uuid

Token do carrinho.

Example request

{
  "ip": "200.179.10.10",
  "transactions": [
    {
      "authorized_at": "2025-07-31 23:59:59",
      "captured_at": "2025-07-31 23:59:59"
    }
  ],
  "authorized_at": "2025-07-31 23:59:59",
  "captured_at": "2025-07-31 23:59:59",
  "cancelled_at": "2025-07-31 23:59:59"
}

Response

Pedido criado com sucesso

deliveredboolean

Indica se o pedido já foi entregue ao cliente.

track_urlstring

URL de rastreamento da entrega gerada pela transportadora.

track_codestring

Código de rastreamento da entrega gerado pela transportadora.

authorizedboolean

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

customer_idinteger

ID do cliente

promocode_idinteger

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

marketplace_idinteger

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

marketplace_account_idinteger

ID da conta do marketplace vinculada ao pedido.

has_recommboolean

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

numbernumber

Número do pedido

marketplace_partner_idinteger

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

marketplace_sale_numbernumber

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

value_totalnumber float

Valor total do pedido

value_productsnumber float

Valor dos produtos

value_discountnumber float

Valor do desconto

value_shipmentnumber float

Valor do frete

value_taxnumber float

Valor do imposto

shipment_servicestring

Método de entrega

shipment_quote_idinteger

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

days_deliveryinteger

Dias para entrega

utm_sourcestring

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

utm_campaignstring

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

utm_termstring

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

utm_contentstring

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

utm_mediumstring

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

ipstring ip

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

Example response

{
  "transactions": {
    "data": {
      "created_at": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "updated_at": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "capture_date": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "authorized_at": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "captured_at": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "cancelled_at": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "metadata": [
        {
          "key": "discount_highlight",
          "value": "pix"
        }
      ]
    }
  }
}