Criar pedido - Yampi Developer Portal

Criar pedido

curl --request POST \
  --url https://api.dooki.com.br/v2/{alias}/orders \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '{
  "status": "waiting_payment",
  "marketplace_id": 123,
  "marketplace_account_id": 123,
  "authorized": true,
  "number": 123,
  "marketplace_sale_number": "<string>",
  "customer_id": 123,
  "value_total": 123,
  "value_products": 1,
  "value_discount": 1,
  "value_shipment": 1,
  "value_tax": 1,
  "shipment_service": "<string>",
  "days_delivery": 1,
  "ip": "200.179.10.10",
  "items": [
    {
      "product_id": 123,
      "sku_id": 123,
      "sku": "<string>",
      "quantity": 2,
      "price": 1,
      "gift": true,
      "gift_value": 1,
      "has_recomm": true
    }
  ],
  "address": [
    {
      "receiver": "<string>",
      "zipcode": "<string>",
      "street": "<string>",
      "number": "<string>",
      "neighborhood": "<string>",
      "city": "<string>",
      "uf": "<string>"
    }
  ],
  "transactions": [
    {
      "customer_id": 123,
      "payment_id": 123,
      "affiliation_id": 123,
      "marketplace_id": 123,
      "marketplace_account_id": 123,
      "authorized": true,
      "authorized_at": "2025-07-31 23:59:59",
      "captured": true,
      "captured_at": "2025-07-31 23:59:59",
      "cancelled": true,
      "amount": 1,
      "installments": 2,
      "status": "waiting_payment",
      "holder_name": "<string>",
      "holder_document": "<string>",
      "billet_url": "<string>",
      "billet_date": "2023-12-25"
    }
  ],
  "sent_to_antifraud": true,
  "capture_date": "2023-12-25",
  "authorized_at": "2025-07-31 23:59:59",
  "captured_at": "2025-07-31 23:59:59",
  "cancelled_at": "2025-07-31 23:59:59"
}'

{
  "delivered": true,
  "track_url": "<string>",
  "track_code": "<string>",
  "authorized": true,
  "customer_id": 123,
  "promocode_id": 123,
  "marketplace_id": 123,
  "marketplace_account_id": 123,
  "has_recomm": true,
  "number": 123,
  "marketplace_partner_id": 123,
  "marketplace_sale_number": 123,
  "value_total": 123,
  "value_products": 123,
  "value_discount": 123,
  "value_shipment": 123,
  "value_tax": 123,
  "shipment_service": "<string>",
  "shipment_quote_id": 123,
  "days_delivery": 123,
  "utm_source": "<string>",
  "utm_campaign": "<string>",
  "utm_term": "<string>",
  "utm_content": "<string>",
  "utm_medium": "<string>",
  "ip": "<string>",
  "items": [
    {
      "id": 123,
      "product_id": 123,
      "sku_id": 123,
      "item_sku": "<string>",
      "quantity": 123,
      "price": 123,
      "price_cost": 123,
      "shipment_cost": 123,
      "gift": true,
      "gift_value": 123,
      "has_recomm": 123,
      "is_digital": true,
      "freebie_id": 123,
      "bundle_id": 123,
      "bundle_name": "<string>"
    }
  ],
  "address": [
    {
      "id": 123,
      "order_id": 123,
      "address_name": "<string>",
      "street": "<string>",
      "number": 123,
      "complement": "<string>",
      "reference": "<string>",
      "neighborhood": "<string>",
      "receiver": "<string>",
      "zipcode": 123,
      "zip_code": 123,
      "full_address": "<string>",
      "city": "<string>",
      "uf": "<string>",
      "country": "<string>"
    }
  ],
  "transactions": {
    "data": {
      "id": 123,
      "customer_id": 123,
      "payment_id": 123,
      "affiliation_id": 123,
      "marketplace_id": 123,
      "marketplace_account_id": 123,
      "authorized": true,
      "captured": true,
      "cancelled": true,
      "can_be_captured": true,
      "can_be_cancelled": true,
      "gateway_transaction_id": 123,
      "gateway_order_id": 123,
      "gateway_authorization_code": "<string>",
      "gateway_billet_id": 123,
      "amount": 123,
      "buyer_amount": 123,
      "installment_value": 123,
      "buyer_installment_value": 123,
      "installments": 123,
      "installment_formated": "<string>",
      "buyer_installment_formated": "<string>",
      "status": "<string>",
      "error_message": "<string>",
      "bank_name": "<string>",
      "bank_alias": "<string>",
      "truncated_card": "<string>",
      "holder_name": "<string>",
      "holder_document": "<string>",
      "billet_url": "<string>",
      "billet_barcode": "<string>",
      "billet_date": "<string>",
      "billet_our_number": "<string>",
      "billet_document_number": "<string>",
      "billet_whatsapp_link": "<string>",
      "antifraud_sale_id": 123,
      "antifraud_status": "<string>",
      "antifraud_score": "<string>",
      "sent_to_antifraud": "<string>",
      "total_logs": 123,
      "error_code": 123,
      "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"
      },
      "payment": {
        "data": {
          "id": 123,
          "alias": "<string>",
          "name": "<string>",
          "has_config": true,
          "active_config": true,
          "is_credit_card": true,
          "is_deposit": true,
          "is_billet": true,
          "is_pix": true,
          "is_pix_in_installments": true,
          "is_wallet": true,
          "icon_url": "<string>"
        }
      },
      "metadata": [
        {
          "key": "discount_highlight",
          "value": "pix"
        }
      ]
    }
  }
}

POST

{alias}

orders

Criar pedido

curl --request POST \
  --url https://api.dooki.com.br/v2/{alias}/orders \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '{
  "status": "waiting_payment",
  "marketplace_id": 123,
  "marketplace_account_id": 123,
  "authorized": true,
  "number": 123,
  "marketplace_sale_number": "<string>",
  "customer_id": 123,
  "value_total": 123,
  "value_products": 1,
  "value_discount": 1,
  "value_shipment": 1,
  "value_tax": 1,
  "shipment_service": "<string>",
  "days_delivery": 1,
  "ip": "200.179.10.10",
  "items": [
    {
      "product_id": 123,
      "sku_id": 123,
      "sku": "<string>",
      "quantity": 2,
      "price": 1,
      "gift": true,
      "gift_value": 1,
      "has_recomm": true
    }
  ],
  "address": [
    {
      "receiver": "<string>",
      "zipcode": "<string>",
      "street": "<string>",
      "number": "<string>",
      "neighborhood": "<string>",
      "city": "<string>",
      "uf": "<string>"
    }
  ],
  "transactions": [
    {
      "customer_id": 123,
      "payment_id": 123,
      "affiliation_id": 123,
      "marketplace_id": 123,
      "marketplace_account_id": 123,
      "authorized": true,
      "authorized_at": "2025-07-31 23:59:59",
      "captured": true,
      "captured_at": "2025-07-31 23:59:59",
      "cancelled": true,
      "amount": 1,
      "installments": 2,
      "status": "waiting_payment",
      "holder_name": "<string>",
      "holder_document": "<string>",
      "billet_url": "<string>",
      "billet_date": "2023-12-25"
    }
  ],
  "sent_to_antifraud": true,
  "capture_date": "2023-12-25",
  "authorized_at": "2025-07-31 23:59:59",
  "captured_at": "2025-07-31 23:59:59",
  "cancelled_at": "2025-07-31 23:59:59"
}'

{
  "delivered": true,
  "track_url": "<string>",
  "track_code": "<string>",
  "authorized": true,
  "customer_id": 123,
  "promocode_id": 123,
  "marketplace_id": 123,
  "marketplace_account_id": 123,
  "has_recomm": true,
  "number": 123,
  "marketplace_partner_id": 123,
  "marketplace_sale_number": 123,
  "value_total": 123,
  "value_products": 123,
  "value_discount": 123,
  "value_shipment": 123,
  "value_tax": 123,
  "shipment_service": "<string>",
  "shipment_quote_id": 123,
  "days_delivery": 123,
  "utm_source": "<string>",
  "utm_campaign": "<string>",
  "utm_term": "<string>",
  "utm_content": "<string>",
  "utm_medium": "<string>",
  "ip": "<string>",
  "items": [
    {
      "id": 123,
      "product_id": 123,
      "sku_id": 123,
      "item_sku": "<string>",
      "quantity": 123,
      "price": 123,
      "price_cost": 123,
      "shipment_cost": 123,
      "gift": true,
      "gift_value": 123,
      "has_recomm": 123,
      "is_digital": true,
      "freebie_id": 123,
      "bundle_id": 123,
      "bundle_name": "<string>"
    }
  ],
  "address": [
    {
      "id": 123,
      "order_id": 123,
      "address_name": "<string>",
      "street": "<string>",
      "number": 123,
      "complement": "<string>",
      "reference": "<string>",
      "neighborhood": "<string>",
      "receiver": "<string>",
      "zipcode": 123,
      "zip_code": 123,
      "full_address": "<string>",
      "city": "<string>",
      "uf": "<string>",
      "country": "<string>"
    }
  ],
  "transactions": {
    "data": {
      "id": 123,
      "customer_id": 123,
      "payment_id": 123,
      "affiliation_id": 123,
      "marketplace_id": 123,
      "marketplace_account_id": 123,
      "authorized": true,
      "captured": true,
      "cancelled": true,
      "can_be_captured": true,
      "can_be_cancelled": true,
      "gateway_transaction_id": 123,
      "gateway_order_id": 123,
      "gateway_authorization_code": "<string>",
      "gateway_billet_id": 123,
      "amount": 123,
      "buyer_amount": 123,
      "installment_value": 123,
      "buyer_installment_value": 123,
      "installments": 123,
      "installment_formated": "<string>",
      "buyer_installment_formated": "<string>",
      "status": "<string>",
      "error_message": "<string>",
      "bank_name": "<string>",
      "bank_alias": "<string>",
      "truncated_card": "<string>",
      "holder_name": "<string>",
      "holder_document": "<string>",
      "billet_url": "<string>",
      "billet_barcode": "<string>",
      "billet_date": "<string>",
      "billet_our_number": "<string>",
      "billet_document_number": "<string>",
      "billet_whatsapp_link": "<string>",
      "antifraud_sale_id": 123,
      "antifraud_status": "<string>",
      "antifraud_score": "<string>",
      "sent_to_antifraud": "<string>",
      "total_logs": 123,
      "error_code": 123,
      "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"
      },
      "payment": {
        "data": {
          "id": 123,
          "alias": "<string>",
          "name": "<string>",
          "has_config": true,
          "active_config": true,
          "is_credit_card": true,
          "is_deposit": true,
          "is_billet": true,
          "is_pix": true,
          "is_pix_in_installments": true,
          "is_wallet": true,
          "icon_url": "<string>"
        }
      },
      "metadata": [
        {
          "key": "discount_highlight",
          "value": "pix"
        }
      ]
    }
  }
}

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

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

required

value_products

number

required

Required range: x >= 0

value_discount

number

required

Required range: x >= 0

value_shipment

number

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 length: 1

Show child attributes

address

object[]

required

Endereço de entrega.

Required array length: 1 element

Show child attributes

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 | null

Required range: x >= 0

IP do comprador, pode ser IPv4 ou IPv6.

Example:

"200.179.10.10"

transactions

object[] | null

Transação do pedido.

Show child attributes

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"

Response

200 - application/json

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

Número do pedido

marketplace_partner_id

integer

marketplace_sale_number

number

value_total

number

Valor total do pedido

value_products

number

Valor dos produtos

value_discount

number

Valor do desconto

value_shipment

number

Valor do frete

value_tax

number

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

string<ip>

items

object[]

Itens do pedido

Show child attributes

address

Endereço do pedido · object[]

Endereço de entrega

Show child attributes

transactions

object

Show child attributes

Listar pedidos Visualizar detalhes de um pedido

⌘I

Referência da API

Authorizations

Path Parameters

Body

Response