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": "<any>",
          "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": "<string>",
                "timezone_type": 123
              },
              "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": "jsmith@example.com",
          "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 alterados, 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

​
id
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