Atualizar pedido - Yampi Developer Portal

Atualizar pedido

curl --request PUT \
  --url https://api.dooki.com.br/v2/{alias}/orders/{id} \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '
{
  "sync_by_erp": true,
  "delivered": true,
  "shipment_service": "<string>",
  "track_url": "<string>",
  "track_code": "<string>",
  "status_id": 123,
  "status_details": "<string>"
}
'

{
  "data": [
    {
      "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"
            }
          ]
        }
      },
      "date_delivery": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "whatsapp": {
        "data": {
          "billet": {
            "link": "<string>",
            "message": "<string>"
          },
          "order_shipped": "<string>",
          "abandoned_cart": "<string>",
          "pix": "<string>",
          "payment_link": "<string>"
        }
      },
      "pickup_address": {
        "data": {
          "id": 123,
          "order_id": 123,
          "country": "<string>",
          "uf": "<string>",
          "city": "<string>",
          "neighborhood": "<string>",
          "street": "<string>",
          "number": "<string>",
          "zipcode": "<string>",
          "full_address": "<string>",
          "complement": "<string>",
          "pickup_time_type": "<string>",
          "pickup_time": 123,
          "only_weekdays": 123,
          "local_description": "<string>"
        }
      },
      "metadata": {
        "data": [
          {
            "key": "discount_highlight",
            "value": "pix"
          }
        ]
      },
      "status": {
        "data": {
          "id": 123,
          "name": "<string>",
          "alias": "<string>",
          "description": "<string>"
        }
      },
      "pix": {
        "data": {
          "pix_qr_code": "<string>",
          "pix_expiration_date": "2023-11-07T05:31:56Z"
        }
      },
      "promocode": {
        "data": {
          "id": 123,
          "code": "TEST",
          "description": "",
          "customer_id": 123,
          "active": true,
          "expired": true,
          "discount_type": "p",
          "for_the_price_of": true,
          "cart_default": true,
          "type_increment_value": "",
          "value": 10,
          "price_products": 123,
          "percent_products": 123,
          "quantity": "100000",
          "total_customers_used": "22",
          "product_quantity": 123,
          "product_max_quantity": 123,
          "used": 22,
          "items_count": 123,
          "min_value": 99.99,
          "use_percent": 0.02,
          "shipment_percent": 123,
          "accumulate": true,
          "once_per_customer": true,
          "abandoned_cart": true,
          "newsletter": true,
          "payments_ids": "<unknown>",
          "free_shipment": true,
          "ignore_promotion_products": true,
          "start_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "end_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "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"
          }
        }
      },
      "statuses": {
        "data": [
          {
            "id": 123,
            "name": "<string>",
            "alias": "<string>",
            "description": "<string>",
            "details": "<string>",
            "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"
            }
          }
        ]
      },
      "payments": [
        {
          "icon_url": "<string>",
          "name": "<string>",
          "alias": "<string>"
        }
      ],
      "services": {
        "data": [
          {}
        ]
      },
      "customer": {
        "data": {
          "id": 123,
          "merchant_id": 123,
          "marketplace_id": 123,
          "active": true,
          "type": "<string>",
          "cluster_id": 123,
          "name": "<string>",
          "first_name": "<string>",
          "last_name": "<string>",
          "generic_name": "<string>",
          "cpf": "<string>",
          "spreadsheet": {
            "data": {
              "brands": "<string>",
              "city": "<string>",
              "purchased_brands": "<string>",
              "last_order_date": {
                "date": "2023-11-07T05:31:56Z",
                "timezone_type": 123,
                "timezone": "<string>"
              },
              "last_order_value": "<string>",
              "purchased_categories": "<string>",
              "number": "<string>",
              "uf": "<string>",
              "phone": "(16) 98187-5668",
              "street": "<string>",
              "phone_number": "981875668",
              "categories": "<string>",
              "neighborhood": "<string>",
              "complement": "<string>",
              "phone_code": "16"
            }
          },
          "phone": {
            "area_code": "<string>",
            "full_number": "<string>",
            "number": "<string>",
            "formated_number": "<string>",
            "whatsapp_link": "<string>"
          },
          "razao_social": "<string>",
          "cnpj": "<string>",
          "state_registration": "<string>",
          "email": "[email protected]",
          "birthday": "2023-12-25",
          "newsletter": true,
          "whatsapp": true,
          "social_driver": "<string>",
          "social_id": 123,
          "ip": "<string>",
          "token": "<string>",
          "utm_source": "<string>",
          "utm_campaign": "<string>",
          "notes": "<string>",
          "login_url": "<string>",
          "anonymized": true
        }
      }
    }
  ]
}

PUT

{alias}

orders

{id}

Atualizar pedido

curl --request PUT \
  --url https://api.dooki.com.br/v2/{alias}/orders/{id} \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '
{
  "sync_by_erp": true,
  "delivered": true,
  "shipment_service": "<string>",
  "track_url": "<string>",
  "track_code": "<string>",
  "status_id": 123,
  "status_details": "<string>"
}
'

{
  "data": [
    {
      "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"
            }
          ]
        }
      },
      "date_delivery": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "whatsapp": {
        "data": {
          "billet": {
            "link": "<string>",
            "message": "<string>"
          },
          "order_shipped": "<string>",
          "abandoned_cart": "<string>",
          "pix": "<string>",
          "payment_link": "<string>"
        }
      },
      "pickup_address": {
        "data": {
          "id": 123,
          "order_id": 123,
          "country": "<string>",
          "uf": "<string>",
          "city": "<string>",
          "neighborhood": "<string>",
          "street": "<string>",
          "number": "<string>",
          "zipcode": "<string>",
          "full_address": "<string>",
          "complement": "<string>",
          "pickup_time_type": "<string>",
          "pickup_time": 123,
          "only_weekdays": 123,
          "local_description": "<string>"
        }
      },
      "metadata": {
        "data": [
          {
            "key": "discount_highlight",
            "value": "pix"
          }
        ]
      },
      "status": {
        "data": {
          "id": 123,
          "name": "<string>",
          "alias": "<string>",
          "description": "<string>"
        }
      },
      "pix": {
        "data": {
          "pix_qr_code": "<string>",
          "pix_expiration_date": "2023-11-07T05:31:56Z"
        }
      },
      "promocode": {
        "data": {
          "id": 123,
          "code": "TEST",
          "description": "",
          "customer_id": 123,
          "active": true,
          "expired": true,
          "discount_type": "p",
          "for_the_price_of": true,
          "cart_default": true,
          "type_increment_value": "",
          "value": 10,
          "price_products": 123,
          "percent_products": 123,
          "quantity": "100000",
          "total_customers_used": "22",
          "product_quantity": 123,
          "product_max_quantity": 123,
          "used": 22,
          "items_count": 123,
          "min_value": 99.99,
          "use_percent": 0.02,
          "shipment_percent": 123,
          "accumulate": true,
          "once_per_customer": true,
          "abandoned_cart": true,
          "newsletter": true,
          "payments_ids": "<unknown>",
          "free_shipment": true,
          "ignore_promotion_products": true,
          "start_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "end_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "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"
          }
        }
      },
      "statuses": {
        "data": [
          {
            "id": 123,
            "name": "<string>",
            "alias": "<string>",
            "description": "<string>",
            "details": "<string>",
            "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"
            }
          }
        ]
      },
      "payments": [
        {
          "icon_url": "<string>",
          "name": "<string>",
          "alias": "<string>"
        }
      ],
      "services": {
        "data": [
          {}
        ]
      },
      "customer": {
        "data": {
          "id": 123,
          "merchant_id": 123,
          "marketplace_id": 123,
          "active": true,
          "type": "<string>",
          "cluster_id": 123,
          "name": "<string>",
          "first_name": "<string>",
          "last_name": "<string>",
          "generic_name": "<string>",
          "cpf": "<string>",
          "spreadsheet": {
            "data": {
              "brands": "<string>",
              "city": "<string>",
              "purchased_brands": "<string>",
              "last_order_date": {
                "date": "2023-11-07T05:31:56Z",
                "timezone_type": 123,
                "timezone": "<string>"
              },
              "last_order_value": "<string>",
              "purchased_categories": "<string>",
              "number": "<string>",
              "uf": "<string>",
              "phone": "(16) 98187-5668",
              "street": "<string>",
              "phone_number": "981875668",
              "categories": "<string>",
              "neighborhood": "<string>",
              "complement": "<string>",
              "phone_code": "16"
            }
          },
          "phone": {
            "area_code": "<string>",
            "full_number": "<string>",
            "number": "<string>",
            "formated_number": "<string>",
            "whatsapp_link": "<string>"
          },
          "razao_social": "<string>",
          "cnpj": "<string>",
          "state_registration": "<string>",
          "email": "[email protected]",
          "birthday": "2023-12-25",
          "newsletter": true,
          "whatsapp": true,
          "social_driver": "<string>",
          "social_id": 123,
          "ip": "<string>",
          "token": "<string>",
          "utm_source": "<string>",
          "utm_campaign": "<string>",
          "notes": "<string>",
          "login_url": "<string>",
          "anonymized": true
        }
      }
    }
  ]
}

Envie somente os campos obrigatórios e os que deseja alterar, para reduzir validações desnecessárias. Caso não envie um campo, o mesmo será mantido com o valor atual.

Esta API possui limites de requisições (rate limits) para garantir estabilidade. Cada endpoint tem um limite específico de chamadas por minuto. Este endpoint em específico tem um limite de requisições por minuto.

Authorizations

User-Token

string

header

required

User-Secret-Key

string

header

required

Path Parameters

alias

string

required

Alias da loja

integer

required

ID do pedido

Body

application/json

Detalhes do pedido

sync_by_erp

boolean

Marca se o pedido foi importado pelo ERP

delivered

boolean

Marca se o pedido foi entregue

shipment_service

string

Altera o método de entrega

track_url

string

URL de rastreamento

track_code

string

Código de rastreamento

status_id

integer

Status do pedido

status_details

string

Alguma observação para anexar ao status

Response

Pedido atualizado com sucesso

data

object[]

Detalhes de um pedido

Show child attributes

data.delivered

boolean

data.track_url

string

data.track_code

string

data.authorized

boolean

data.customer_id

integer

ID do cliente

data.promocode_id

integer

data.marketplace_id

integer

data.marketplace_account_id

integer

data.has_recomm

boolean

data.number

number

Número do pedido

data.marketplace_partner_id

integer

data.marketplace_sale_number

number

data.value_total

number<float>

Valor total do pedido

data.value_products

number<float>

Valor dos produtos

data.value_discount

number<float>

Valor do desconto

data.value_shipment

number<float>

Valor do frete

data.value_tax

number<float>

Valor do imposto

data.shipment_service

string

Método de entrega

data.shipment_quote_id

integer

data.days_delivery

integer

Dias para entrega

data.utm_source

string

data.utm_campaign

string

data.utm_term

string

data.utm_content

string

data.utm_medium

string

data.ip

string<ip>

data.items

object[]

Itens do pedido

Show child attributes

data.items.id

integer

ID do item no pedido

data.items.product_id

integer

ID do produto

data.items.sku_id

integer

ID do SKU

data.items.item_sku

string

Código do SKU

data.items.quantity

integer

Quantidade adquirida

data.items.price

number<float>

Preço do item

data.items.price_cost

number<float>

Custo do item

data.items.shipment_cost

number<float>

Custo de envio do item

data.items.gift

boolean

Indica se é um item presente

data.items.gift_value

number<float>

Valor do item presente

data.items.has_recomm

integer

Indica se possui recomendação

data.items.is_digital

boolean

Indica se é um item digital

data.items.freebie_id

integer | null

ID de item brinde (se aplicável)

data.items.bundle_id

integer | null

ID do bundle (se aplicável)

data.items.bundle_name

string | null

Nome do bundle (se aplicável)

data.address

Endereço do pedido · object[]

Endereço de entrega

Show child attributes

data.address.id

integer

data.address.order_id

integer

data.address.address_name

string

data.address.street

string

Rua

data.address.number

integer

Número

data.address.complement

string

Complemento

data.address.reference

string

Referencia

data.address.neighborhood

string

Bairro

data.address.receiver

string

Nome do recebedor

data.address.zipcode

integer

CEP

data.address.zip_code

integer

CEP

data.address.full_address

string

data.address.city

string

Cidade

data.address.uf

string

Estado

data.address.country

string

País

data.transactions

object

Show child attributes

data.transactions.data

object

Show child attributes

data.transactions.data.id

integer

data.transactions.data.customer_id

integer

ID do cliente

data.transactions.data.payment_id

integer

ID do pagamento

data.transactions.data.affiliation_id

integer

ID da afiliação

data.transactions.data.marketplace_id

integer

data.transactions.data.marketplace_account_id

integer

data.transactions.data.authorized

boolean

data.transactions.data.captured

boolean

data.transactions.data.cancelled

boolean

data.transactions.data.can_be_captured

boolean

data.transactions.data.can_be_cancelled

boolean

data.transactions.data.gateway_transaction_id

integer

ID da transação no gateway

data.transactions.data.gateway_order_id

integer

data.transactions.data.gateway_authorization_code

string

data.transactions.data.gateway_billet_id

integer

data.transactions.data.amount

number<float>

Valor

data.transactions.data.buyer_amount

number<float>

Valor

data.transactions.data.installment_value

number<float>

Valor

data.transactions.data.buyer_installment_value

number<float>

Valor

data.transactions.data.installments

integer

Número de parcelas

data.transactions.data.installment_formated

string

Status da transação

data.transactions.data.buyer_installment_formated

string

Status da transação

data.transactions.data.status

string

Status da transação

data.transactions.data.error_message

string

data.transactions.data.bank_name

string

data.transactions.data.bank_alias

string

data.transactions.data.truncated_card

string

data.transactions.data.holder_name

string

Nome do titular

data.transactions.data.holder_document

string

Documento do titular

data.transactions.data.billet_url

string

data.transactions.data.billet_barcode

string

data.transactions.data.billet_date

string

data.transactions.data.billet_our_number

string

data.transactions.data.billet_document_number

string

data.transactions.data.billet_whatsapp_link

string

data.transactions.data.antifraud_sale_id

integer

data.transactions.data.antifraud_status

string

data.transactions.data.antifraud_score

string

data.transactions.data.sent_to_antifraud

string

data.transactions.data.total_logs

integer

data.transactions.data.error_code

integer

data.transactions.data.created_at

object

Show child attributes

data.transactions.data.created_at.date

string

Data e hora no formato YYYY-MM-DD H:MM:SS.

Example:

"2000-08-17 10:24:24"

data.transactions.data.created_at.timezone_type

integer

Número de representação do timezone.

Example:

3

data.transactions.data.created_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

data.transactions.data.updated_at

object

Show child attributes

data.transactions.data.updated_at.date

string

Data e hora no formato YYYY-MM-DD H:MM:SS.

Example:

"2000-08-17 10:24:24"

data.transactions.data.updated_at.timezone_type

integer

Número de representação do timezone.

Example:

3

data.transactions.data.updated_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

data.transactions.data.capture_date

object

Show child attributes

data.transactions.data.capture_date.date

string

Data e hora no formato YYYY-MM-DD H:MM:SS.

Example:

"2000-08-17 10:24:24"

data.transactions.data.capture_date.timezone_type

integer

Número de representação do timezone.

Example:

3

data.transactions.data.capture_date.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

data.transactions.data.authorized_at

object

Show child attributes

data.transactions.data.authorized_at.date

string

Data e hora no formato YYYY-MM-DD H:MM:SS.

Example:

"2000-08-17 10:24:24"

data.transactions.data.authorized_at.timezone_type

integer

Número de representação do timezone.

Example:

3

data.transactions.data.authorized_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

data.transactions.data.captured_at

object

Show child attributes

data.transactions.data.captured_at.date

string

Data e hora no formato YYYY-MM-DD H:MM:SS.

Example:

"2000-08-17 10:24:24"

data.transactions.data.captured_at.timezone_type

integer

Número de representação do timezone.

Example:

3

data.transactions.data.captured_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

data.transactions.data.cancelled_at

object

Show child attributes

data.transactions.data.cancelled_at.date

string

Data e hora no formato YYYY-MM-DD H:MM:SS.

Example:

"2000-08-17 10:24:24"

data.transactions.data.cancelled_at.timezone_type

integer

Número de representação do timezone.

Example:

3

data.transactions.data.cancelled_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

data.transactions.data.payment

object

Informações sobre o meio de pagamento

Show child attributes

data.transactions.data.payment.data

object

Detalhes do pagamento

Show child attributes

data.transactions.data.payment.data.id

integer

ID do meio de pagamento

data.transactions.data.payment.data.alias

string

Alias do meio de pagamento

data.transactions.data.payment.data.name

string

Nome do meio de pagamento

data.transactions.data.payment.data.has_config

boolean

Indica se há configuração disponível

data.transactions.data.payment.data.active_config

boolean

Indica se a configuração está ativa

data.transactions.data.payment.data.is_credit_card

boolean

Indica se é um cartão de crédito

data.transactions.data.payment.data.is_deposit

boolean

Indica se é um pagamento por depósito

data.transactions.data.payment.data.is_billet

boolean

Indica se é um boleto bancário

data.transactions.data.payment.data.is_pix

boolean

Indica se é um pagamento via Pix

data.transactions.data.payment.data.is_pix_in_installments

boolean

Indica se o Pix permite parcelamento

data.transactions.data.payment.data.is_wallet

boolean

Indica se é um pagamento via carteira digital

data.transactions.data.payment.data.icon_url

string<uri>

URL do ícone do meio de pagamento

data.transactions.data.metadata

object[]

Lista de metadados

Show child attributes

data.transactions.data.metadata.key

string

Chave do metadado

Example:

"discount_highlight"

data.transactions.data.metadata.value

string

Valor do metadado

Example:

"pix"

data.date_delivery

object

Show child attributes

data.date_delivery.date

string

Data e hora no formato YYYY-MM-DD H:MM:SS.

Example:

"2000-08-17 10:24:24"

data.date_delivery.timezone_type

integer

Número de representação do timezone.

Example:

3

data.date_delivery.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

data.whatsapp

object

Mensagens configuradas para WhatsApp relacionadas ao pedido

Show child attributes

data.whatsapp.data

object

Show child attributes

data.whatsapp.data.billet

object

Mensagem de boleto via WhatsApp

Show child attributes

data.whatsapp.data.billet.link

string<uri>

Link do WhatsApp com mensagem pré-configurada

data.whatsapp.data.billet.message

string

Conteúdo da mensagem do boleto

data.whatsapp.data.order_shipped

string | null

Mensagem de pedido enviado

data.whatsapp.data.abandoned_cart

string | null

Mensagem de carrinho abandonado

data.whatsapp.data.pix

string | null

Mensagem de Pix

data.whatsapp.data.payment_link

string | null

Mensagem de link de pagamento

data.pickup_address

object

Show child attributes

data.pickup_address.data

Endereço de retirada · object

Show child attributes

data.pickup_address.data.id

integer

ID do endereço de retirada

data.pickup_address.data.order_id

integer

ID do pedido relacionado

data.pickup_address.data.country

string

País

data.pickup_address.data.uf

string

Estado (sigla)

data.pickup_address.data.city

string

Cidade

data.pickup_address.data.neighborhood

string

Bairro

data.pickup_address.data.street

string

Nome da rua

data.pickup_address.data.number

string

Número do endereço

data.pickup_address.data.zipcode

string

CEP

data.pickup_address.data.full_address

string

Endereço completo

data.pickup_address.data.complement

string | null

Complemento

data.pickup_address.data.pickup_time_type

string

Tipo de horário de retirada

data.pickup_address.data.pickup_time

integer

Horário de retirada

data.pickup_address.data.only_weekdays

integer

Indica se a retirada é apenas em dias úteis (1 = sim, 0 = não)

data.pickup_address.data.local_description

string

Descrição do local de retirada

data.metadata

object

Metadados adicionais

Show child attributes

data.metadata.data

object[]

Lista de metadados

Show child attributes

data.metadata.data.key

string

Chave do metadado

Example:

"discount_highlight"

data.metadata.data.value

string

Valor do metadado

Example:

"pix"

data.status

object

Status atual do pedido

Show child attributes

data.status.data

object

Show child attributes

data.status.data.id

integer

ID do status

data.status.data.name

string

Nome do status

data.status.data.alias

string

Alias identificador do status

data.status.data.description

string

Descrição detalhada do status

data.pix

object

Show child attributes

data.pix.data

object

Show child attributes

data.pix.data.pix_qr_code

string

Código QR do Pix

data.pix.data.pix_expiration_date

string<date-time>

Data e hora de expiração do Pix

data.promocode

object

Show child attributes

data.promocode.data

Código Promocional · object

Representa os clientes que usaram um cupom Representa um código promocional

Show child attributes

data.promocode.data.id

integer

data.promocode.data.code

string

Example:

"TEST"

data.promocode.data.description

string

Example:

""

data.promocode.data.customer_id

integer

data.promocode.data.active

boolean

data.promocode.data.expired

boolean

data.promocode.data.discount_type

enum<string>

Available options:

p,

v

data.promocode.data.for_the_price_of

boolean

data.promocode.data.cart_default

boolean

data.promocode.data.type_increment_value

string

Example:

""

data.promocode.data.value

number<float>

Example:

10

data.promocode.data.price_products

number<float>

data.promocode.data.percent_products

number<float>

data.promocode.data.quantity

integer

Example:

"100000"

data.promocode.data.total_customers_used

integer

Example:

"22"

data.promocode.data.product_quantity

integer

data.promocode.data.product_max_quantity

integer

data.promocode.data.used

integer

Example:

22

data.promocode.data.items_count

integer

data.promocode.data.min_value

number<float>

Example:

99.99

data.promocode.data.use_percent

number<float>

Example:

0.02

data.promocode.data.shipment_percent

number<float>

data.promocode.data.accumulate

boolean

data.promocode.data.once_per_customer

boolean

data.promocode.data.abandoned_cart

boolean

data.promocode.data.payments_ids

any

data.promocode.data.free_shipment

boolean

data.promocode.data.ignore_promotion_products

boolean

data.promocode.data.start_at

object

Show child attributes

data.promocode.data.start_at.date

string

Data e hora no formato YYYY-MM-DD H:MM:SS.

Example:

"2000-08-17 10:24:24"

data.promocode.data.start_at.timezone_type

integer

Número de representação do timezone.

Example:

3

data.promocode.data.start_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

data.promocode.data.end_at

object

Show child attributes

data.promocode.data.end_at.date

string

Data e hora no formato YYYY-MM-DD H:MM:SS.

Example:

"2000-08-17 10:24:24"

data.promocode.data.end_at.timezone_type

integer

Número de representação do timezone.

Example:

3

data.promocode.data.end_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

data.promocode.data.created_at

object

Show child attributes

data.promocode.data.created_at.date

string

Data e hora no formato YYYY-MM-DD H:MM:SS.

Example:

"2000-08-17 10:24:24"

data.promocode.data.created_at.timezone_type

integer

Número de representação do timezone.

Example:

3

data.promocode.data.created_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

data.promocode.data.updated_at

object

Show child attributes

data.promocode.data.updated_at.date

string

Data e hora no formato YYYY-MM-DD H:MM:SS.

Example:

"2000-08-17 10:24:24"

data.promocode.data.updated_at.timezone_type

integer

Número de representação do timezone.

Example:

3

data.promocode.data.updated_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

data.statuses

object

Histórico de status do pedido

Show child attributes

data.statuses.data

object[]

Show child attributes

data.statuses.data.id

integer

ID do status

data.statuses.data.name

string

Nome do status

data.statuses.data.alias

string

Alias do status

data.statuses.data.description

string

Descrição do status

data.statuses.data.details

string | null

Detalhes adicionais do status

data.statuses.data.created_at

object

Show child attributes

data.statuses.data.created_at.date

string

Data e hora no formato YYYY-MM-DD H:MM:SS.

Example:

"2000-08-17 10:24:24"

data.statuses.data.created_at.timezone_type

integer

Número de representação do timezone.

Example:

3

data.statuses.data.created_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

data.statuses.data.updated_at

object

Show child attributes

data.statuses.data.updated_at.date

string

Data e hora no formato YYYY-MM-DD H:MM:SS.

Example:

"2000-08-17 10:24:24"

data.statuses.data.updated_at.timezone_type

integer

Número de representação do timezone.

Example:

3

data.statuses.data.updated_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

data.payments

object[]

Lista de meios de pagamento disponíveis ou utilizados

Show child attributes

data.payments.icon_url

string<uri>

URL do ícone do meio de pagamento

data.payments.name

string

Nome do meio de pagamento

data.payments.alias

string

Alias identificador do meio de pagamento

data.services

object

Serviços vinculados ao pedido

Show child attributes

data.services.data

object[]

data.customer

object

Show child attributes

data.customer.data

Customer · object

Representa um cliente

Show child attributes

data.customer.data.id

integer

data.customer.data.merchant_id

integer

data.customer.data.marketplace_id

integer

data.customer.data.active

boolean

data.customer.data.type

string

data.customer.data.cluster_id

integer

data.customer.data.name

string

data.customer.data.first_name

string

data.customer.data.last_name

string

data.customer.data.generic_name

string

data.customer.data.cpf

string

data.customer.data.spreadsheet

object

Show child attributes

data.customer.data.spreadsheet.data

object

Show child attributes

data.customer.data.spreadsheet.data.brands

string

data.customer.data.spreadsheet.data.city

string

data.customer.data.spreadsheet.data.purchased_brands

string

data.customer.data.spreadsheet.data.last_order_date

object

Show child attributes

data.customer.data.spreadsheet.data.last_order_date.date

string<date-time>

data.customer.data.spreadsheet.data.last_order_date.timezone_type

integer

data.customer.data.spreadsheet.data.last_order_date.timezone

string

data.customer.data.spreadsheet.data.last_order_value

string

data.customer.data.spreadsheet.data.purchased_categories

string

data.customer.data.spreadsheet.data.number

string

data.customer.data.spreadsheet.data.uf

string

data.customer.data.spreadsheet.data.phone

string

Example:

"(16) 98187-5668"

data.customer.data.spreadsheet.data.street

string

data.customer.data.spreadsheet.data.phone_number

string

Example:

"981875668"

data.customer.data.spreadsheet.data.categories

string

data.customer.data.spreadsheet.data.neighborhood

string

data.customer.data.spreadsheet.data.complement

string

data.customer.data.spreadsheet.data.phone_code

string

Example:

"16"

data.customer.data.phone

object

Show child attributes

data.customer.data.phone.area_code

string

Código de área do telefone

data.customer.data.phone.full_number

string

Número do telefone

data.customer.data.phone.number

string

Número do telefone

data.customer.data.phone.formated_number

string

Número do telefone formatado

data.customer.data.phone.whatsapp_link

string<uri>

data.customer.data.cnpj

string

data.customer.data.state_registration

string

data.customer.data.email

string<email>

data.customer.data.birthday

string<date>

data.customer.data.whatsapp

boolean

data.customer.data.ip

string

data.customer.data.token

string

data.customer.data.utm_source

string

data.customer.data.utm_campaign

string

data.customer.data.notes

string

data.customer.data.anonymized

boolean

Visualizar detalhes de um pedido Listar transações de um pedido

⌘I

Referência da API

Authorizations

Path Parameters

Body

Response