---
title: "Criar pedido"
method: POST
path: "/{alias}/orders"
tags: ["Pedidos - Pedido"]
---

# Criar pedido

`POST /{alias}/orders`

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

## Path parameters

- `alias` string, required

## Request body

- OrderRequest — Requisição para criação de pedidos
  - `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_id` integer, nullable — Obrigatório se o comprador vier de um marketplace específico.
  - `marketplace_account_id` integer, nullable — Conta do marketplace (precisa pertencer à loja).
  - `authorized` boolean, nullable — Define se o pedido inicia autorizado; pode ser inferido pelo status da conta do marketplace.
  - `number` integer, required — Número único do pedido por loja. Obrigatório, exceto quando usar marketplace_sale_number.
  - `marketplace_sale_number` string, nullable — Número único do pedido no marketplace (por loja/conta). Quando presente, substitui a necessidade de '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.
  - `value_discount` number, float, required — Valor total de descontos aplicados ao pedido.
  - `value_shipment` number, float, required — Valor do frete cobrado no pedido, em reais.
  - `value_tax` number, float, nullable — Valor de juros do gateway de pagamento cobrado no pedido, quando aplicável.
  - `shipment_service` string, required — Alias Serviço de frete escolhido.
  - `days_delivery` integer, required — Prazo estimado de entrega do pedido, em dias.
  - `ip` union — IP do comprador, pode ser IPv4 ou IPv6.
    - string, ipv4
    - string, ipv6
  - `items` object[], required — Lista de produtos incluídos no pedido.
    - `product_id` integer, required — ID do Produto
    - `sku_id` integer, required — ID do SKU.
    - `sku` string, required — Código do SKU.
    - `quantity` integer, required — Quantidade do produto/SKU no pedido.
    - `price` number, float, required — Preço unitário do produto/SKU no momento do pedido, em reais.
    - `gift` boolean, nullable — Indica se o item deve ser embalado como presente, para entrega a alguém diferente do comprador.
    - `gift_value` number, float, nullable — Valor cobrado pela embalagem de presente do item, aplicável quando `gift` for verdadeiro.
    - `has_recomm` boolean, nullable — Indica se tem recomendação associada.
  - `address` object[], required — Endereço de entrega.
    - `receiver` string, required — Nome de quem vai receber a entrega.
    - `zipcode` string, required — CEP do endereço de entrega.
    - `street` string, required — Nome da rua do endereço de entrega.
    - `number` string, required — Número do endereço de entrega.
    - `neighborhood` string, required — Bairro do endereço de entrega.
    - `city` string, required — Cidade do endereço de entrega.
    - `uf` string, required — UF do estado (2 letras).
  - `transactions` object[], nullable — Transação do pedido.
    - `customer_id` integer, required — Mesmo cliente e loja do pedido.
    - `payment_id` integer, nullable — ID da forma/meio de pagamento
    - `affiliation_id` integer, nullable — ID da Afiliação.
    - `marketplace_id` integer, nullable — ID do marketplace de origem da transação, quando aplicável.
    - `marketplace_account_id` integer, nullable — ID da conta do marketplace vinculada à transação, quando aplicável.
    - `authorized` boolean, nullable — Indica se a transação foi autorizada pela adquirente/gateway.
    - `authorized_at` string, date-time, required — Data e hora em que a transação foi autorizada.
    - `captured` boolean, nullable — Indica se a transação foi capturada (pagamento efetivado).
    - `captured_at` string, date-time, nullable — Momento em que o pagamento da transação foi capturado (efetivado), preenchido quando `captured` for verdadeiro.
    - `cancelled` boolean, nullable — Indica se a transação foi cancelada.
    - `amount` number, float, required — Valor da transação, em reais.
    - `installments` integer, required — Número de parcelas da transação.
    - `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).
    - `holder_name` string, required — Nome do titular do meio de pagamento usado na transação.
    - `holder_document` string, required — Documento do comprador (CPF/CNPJ).
    - `billet_url` string, uri, nullable — URL do boleto gerado para a transação, quando o meio de pagamento for boleto.
    - `billet_date` string, date, nullable — Data de vencimento do boleto gerado para a transação.
  - `sent_to_antifraud` boolean, 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_date` string, date, nullable — Data em que o pagamento do pedido foi capturado.
  - `authorized_at` string, date-time, nullable — Data e hora em que o pagamento do pedido foi autorizado.
  - `captured_at` string, date-time, nullable — Data e hora em que o pagamento do pedido foi capturado.
  - `cancelled_at` string, date-time, nullable — Data e hora em que o pedido foi cancelado.
  - `track_code` string, nullable — Código de rastreio do envio. O valor é sanitizado e normalizado automaticamente.
  - `track_url` string, nullable — URL de rastreio do envio. O valor é sanitizado e normalizado automaticamente.
  - `cart_token` string, uuid — Token do carrinho.

## Response `200`

Pedido criado com sucesso

- Order — 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 — Endereço IP do comprador no momento da criação do pedido.
  - `items` OrderItem[] — Itens do pedido
    - `id` integer — ID do item no pedido
    - `product_id` integer — ID do produto
    - `sku_id` integer — ID do SKU
    - `item_sku` string — Código do SKU
    - `quantity` integer — Quantidade adquirida
    - `price` number, float — Preço do item
    - `price_cost` number, float — Custo do item
    - `shipment_cost` number, float — Custo de envio do item
    - `gift` boolean — Indica se é um item presente
    - `gift_value` number, float — Valor do item presente
    - `has_recomm` integer — Indica se possui recomendação
    - `is_digital` boolean — Indica se é um item digital
    - `freebie_id` integer, nullable — ID de item brinde (se aplicável)
    - `bundle_id` integer, nullable — ID do bundle (se aplicável)
    - `bundle_name` string, nullable — Nome do bundle (se aplicável)
  - `address` OrderAddress[] — Endereço de entrega
    - `id` integer
    - `order_id` integer
    - `address_name` string
    - `street` string — Rua
    - `number` integer — Número
    - `complement` string — Complemento
    - `reference` string — Referencia
    - `neighborhood` string — Bairro
    - `receiver` string — Nome do recebedor
    - `zipcode` integer — CEP
    - `zip_code` integer — CEP
    - `full_address` string
    - `city` string — Cidade
    - `uf` string — Estado
    - `country` string — País
  - `transactions` object — Transações de pagamento associadas ao pedido.
    - `data` object
      - `id` integer
      - `customer_id` integer — ID do cliente
      - `payment_id` integer — ID do pagamento
      - `affiliation_id` integer — ID da afiliação
      - `marketplace_id` integer
      - `marketplace_account_id` integer
      - `authorized` boolean
      - `captured` boolean
      - `cancelled` boolean
      - `can_be_captured` boolean
      - `can_be_cancelled` boolean
      - `gateway_transaction_id` integer — ID da transação no gateway
      - `gateway_order_id` integer
      - `gateway_authorization_code` string
      - `gateway_billet_id` integer
      - `amount` number, float — Valor
      - `buyer_amount` number, float — Valor
      - `installment_value` number, float — Valor
      - `buyer_installment_value` number, float — Valor
      - `installments` integer — Número de parcelas
      - `installment_formated` string — Status da transação
      - `buyer_installment_formated` string — Status da transação
      - `status` string — Status da transação
      - `error_message` string
      - `bank_name` string
      - `bank_alias` string
      - `truncated_card` string
      - `holder_name` string — Nome do titular
      - `holder_document` string — Documento do titular
      - `billet_url` string
      - `billet_barcode` string
      - `billet_date` string
      - `billet_our_number` string
      - `billet_document_number` string
      - `billet_whatsapp_link` string
      - `antifraud_sale_id` integer
      - `antifraud_status` string
      - `antifraud_score` string
      - `sent_to_antifraud` string
      - `total_logs` integer
      - `error_code` integer
      - `created_at` BaseTimestamp
        - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
        - `timezone_type` integer — Número de representação do timezone.
        - `timezone` string — Fuso horário associado.
      - `updated_at` BaseTimestamp
        - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
        - `timezone_type` integer — Número de representação do timezone.
        - `timezone` string — Fuso horário associado.
      - `capture_date` BaseTimestamp
        - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
        - `timezone_type` integer — Número de representação do timezone.
        - `timezone` string — Fuso horário associado.
      - `authorized_at` BaseTimestamp
        - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
        - `timezone_type` integer — Número de representação do timezone.
        - `timezone` string — Fuso horário associado.
      - `captured_at` BaseTimestamp
        - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
        - `timezone_type` integer — Número de representação do timezone.
        - `timezone` string — Fuso horário associado.
      - `cancelled_at` BaseTimestamp
        - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
        - `timezone_type` integer — Número de representação do timezone.
        - `timezone` string — Fuso horário associado.
      - `payment` object — Informações sobre o meio de pagamento
        - `data` object — Detalhes do pagamento
          - `id` integer — ID do meio de pagamento
          - `alias` string — Alias do meio de pagamento
          - `name` string — Nome do meio de pagamento
          - `has_config` boolean — Indica se há configuração disponível
          - `active_config` boolean — Indica se a configuração está ativa
          - `is_credit_card` boolean — Indica se é um cartão de crédito
          - `is_deposit` boolean — Indica se é um pagamento por depósito
          - `is_billet` boolean — Indica se é um boleto bancário
          - `is_pix` boolean — Indica se é um pagamento via Pix
          - `is_pix_in_installments` boolean — Indica se o Pix permite parcelamento
          - `is_wallet` boolean — Indica se é um pagamento via carteira digital
          - `icon_url` string, uri — URL do ícone do meio de pagamento
      - `metadata` object[] — Lista de metadados
        - `key` string — Chave do metadado
        - `value` string — Valor do metadado

## Other responses

- `422` — Dados inválidos. Pode ocorrer quando campos obrigatórios estão ausentes, o formato é incorreto, ou quando o valor enviado resulta em uma string vazia após sanitização e normalização.

---

[API](https://skmtc.net/yampi/apis/yampi-api.md) · [All operations](https://skmtc.net/yampi/apis/yampi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yampi/yampi-api/revisions/fa16c50bef09/schema)