---
title: "Order Updated Webhook"
source_url: https://docs.rapyd.net/en/order-updated-webhook.html
lang: en
---

# Order Updated Webhook

The **ORDER_UPDATED** webhook is sent when an order is modified.

> **Note:**
>
> The endpoint for webhooks is unique for each client. To set up a webhook endpoint, see [Defining a Webhook Endpoint](https://docs.rapyd.net/en/defining-a-webhook-endpoint.md "Defining a Webhook Endpoint").

### Parameters

### Webhook Header Parameters

- - Content-Type
  - Indicates that the data appears in JSON format. Set to **application/json**.
- - salt
  - Random string.
- - signature
  - Signature calculated for each webhook individually.

    See [Webhook Authentication](https://docs.rapyd.net/en/webhook-authentication.md "Webhook Authentication").
- - timestamp
  - Timestamp for the webhook, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time") (seconds).

### Webhook Root Parameters

- - created_at
  - Time that the webhook was created, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time").

    > **Note:**
    >
    > Inside the `data` object, some webhooks have another `created_at` field that refers to a different event.
- - data
  - Contains the actual data of the webhook.

    For details, see below.
- - extended_timestamp
  - Time in milliseconds that the webhook was created, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time").
- - id
  - ID of the webhook. String starting with **wh_**.
- - status
  - Status of the webhook. One of the following:

    - **NEW**
    - **CLO** - Closed.
    - **ERR** - Error.
    - **RET** - Re-sent.

    > **Note:**
    >
    > Inside the `data` object, some webhooks have another `status` field that refers to a different event.
- - trigger_operation_id
  - ID of the operation that triggered the webhook. UUID.
- - type
  - Name of the webhook type.

    > **Note:**
    >
    > The name in the Client Portal is different.

### Webhook Data Parameters

- - amount
  - Total amount of the order, the sum of the amount of the shipping' items, plus the `amount` of the tax, plus `amount` times `quantity` of each of the `sku` items. Decimal.
- - amount_returned
  - Total amount of returns against the order. Decimal.
- - coupon
  - ID of a coupon that is applied against this order.
- - created
  - When the order was created, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time").
- - currency
  - Three-letter ISO 4217 code for the currency used in the `item` objects.
- - customer
  - ID of the customer. String starting with **cus_**.
- - email
  - Email address of the customer.
- - external_coupon_code
  - ID of a coupon that is applied against this order, defined by the merchant. If generated by Rapyd, a string starting with **coupon_**.
- - id
  - Unique ID of the Order object. If the merchant does not define an ID, Rapyd generates a string starting with **order_**.
- - items
  - Each item describes one charge in this invoice. There must be one item of `type` = **shipping** and at least one item of `type` = **sku**.

    - - amount
      - Price of one SKU unit, in the currency defined in `currency`. Decimal, including the correct number of decimal places for the currency exponent, as defined in ISO 2417:2015.
    - - currency
      - Three-letter ISO 4217 code for the currency. Must be the same as the currency of the order and the currency of the customer's payment method.
    - - description
      - Description of the item.
    - - parent
      - ID of the SKU object that represents the product. One of the following:

        - ID of the SKU object. String starting with **sku_**
        - ID of the coupon. If generated by Rapyd, a string starting with **coupon_**.
    - - quantity
      - Quantity of the product in the line item. Integer. Required when `type` is **sku**.
    - - type
      - Type of line item. One of the following:

        - **discount**
        - **shipping**
        - **sku**
        - **tax**
- - metadata
  - A JSON object defined by the client. See [Metadata](https://docs.rapyd.net/en/metadata.md "Metadata").
- - payment
  - Describes the collection efforts being made against this order.
- - payment_method
  - Payment method ID. String starting with **card_** or **other_**.

    If not specified in this field, the payment method is the default payment method specified for the customer.
- - returns
  - A list of the returns charged against this order.
- - shipping_address
  - Address to receive the shipment.

    - address
    - Billing address associated with the payment. For details about the fields of the 'address' object, see [Create Address](https://docs.rapyd.net/en/create-address.md "Create Address").
- - status
  - Indicates the status of the order. One of the following:

    - **created** - Created.
    - **pending** - The collection process has been started.
    - **paid** - Paid in full.
    - **canceled** - The total amount of returns against this order equal the total amount of the order.
    - **partial** - Some of the products have been delivered to the customer.
    - **fulfilled** - The products have been delivered to the customer.
    - **returned** - A return has been processed against this order.
- - status_transitions
  - Indicates the last time in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time") that the order transitioned to one of the following statuses. A zero value for a status indicates that the order has never transitioned to it.

    - **canceled**
    - **fulfilled**
    - **paid**
    - **partial**
    - **pending**
    - **returned**
- - tax_percent
  - Percentage of tax to charge. Decimal 0-100, up to four decimal places.
- - updated
  - Time the order was last updated, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time").
- - upstream_id
  - Merchant-defined ID for the order.

- ORDER_UPDATED Webhook
- ```json
  {
      "id": "wh_66aa9af7675fcd38b0e6ff4b177d2ebf",
      "type": "ORDER_UPDATED",
      "data": {
          "id": "order_70cfe834559542f7878bfbeaa1321e17",
          "email": "johndoe@rapyd.net",
          "items": [{
                  "type": "sku",
                  "amount": 1050,
                  "parent": "sku_c73de1b03e758d9f536d352a0c7e0d26",
                  "currency": "USD",
                  "quantity": 1,
                  "description": "Deluxe Gamer's Chair"
              }, {
                  "type": "shipping",
                  "amount": 10,
                  "parent": "",
                  "currency": "USD",
                  "quantity": 1,
                  "description": "Shipping"
              }
          ],
          "amount": 1060,
          "status": "paid",
          "created": 1643715533,
          "payment": {
              "id": "payment_7d24de62aaf783f08a328b0a0fecf3e4",
              "mid": "",
              "paid": true,
              "order": null,
              "amount": 1060,
              "escrow": null,
              "status": "CLO",
              "address": null,
              "dispute": null,
              "fx_rate": 1,
              "invoice": "",
              "outcome": null,
              "paid_at": 1643719155,
              "refunds": null,
              "captured": true,
              "ewallets": [{
                      "amount": 1060,
                      "percent": 100,
                      "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                      "refunded_amount": 0
                  }
              ],
              "metadata": {},
              "refunded": false,
              "flow_type": "",
              "created_at": 1643718644,
              "error_code": "",
              "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
              "expiration": 1644323444,
              "fixed_side": "",
              "is_partial": false,
              "description": "",
              "next_action": "not_applicable",
              "country_code": "US",
              "failure_code": "",
              "instructions": [],
              "payment_fees": null,
              "redirect_url": "https://sandboxcheckout.rapyd.net/3ds-payment?token=payment_7d24de62aaf783f08a328b0a0fecf3e4",
              "visual_codes": {},
              "cancel_reason": null,
              "currency_code": "USD",
              "group_payment": "",
              "receipt_email": "johndoe@rapyd.net",
              "textual_codes": {},
              "customer_token": "cus_d3ed65d5091a8398cc3651bcedec1201",
              "payment_method": "card_531e75e121d99dc23a0779d83c2de26d",
              "receipt_number": "",
              "transaction_id": "",
              "failure_message": "",
              "initiation_type": "customer_present",
              "original_amount": 1060,
              "refunded_amount": 0,
              "error_payment_url": "",
              "payment_method_data": {
                  "id": "card_531e75e121d99dc23a0779d83c2de26d",
                  "name": "Jeff Doe",
                  "type": "us_visa_card",
                  "image": "",
                  "last4": "1111",
                  "category": "card",
                  "metadata": {},
                  "acs_check": "unchecked",
                  "cvv_check": "unchecked",
                  "bin_details": {
                      "type": null,
                      "brand": null,
                      "country": null,
                      "bin_number": "411111"
                  },
                  "next_action": "not_applicable",
                  "webhook_url": "",
                  "expiration_year": "25",
                  "expiration_month": "12",
                  "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                  "supporting_documentation": ""
              },
              "payment_method_type": "us_visa_card",
              "complete_payment_url": "",
              "remitter_information": {},
              "statement_descriptor": "Doc Team",
              "merchant_reference_id": "",
              "payment_method_options": {},
              "merchant_requested_amount": null,
              "merchant_requested_currency": null,
              "payment_method_type_category": "card"
          },
          "returns": [],
          "updated": 1643719155,
          "currency": "USD",
          "customer": "cus_d3ed65d5091a8398cc3651bcedec1201",
          "metadata": {},
          "tax_percent": 0,
          "upstream_id": "order_70cfe834559542f7878bfbeaa1321e17",
          "amount_returned": 0,
          "shipping_address": {
              "id": "address_946f3d3791b704410959e017def785f4",
              "zip": "12345",
              "city": "Anytown",
              "name": "John Doe",
              "state": "NY",
              "canton": "",
              "line_1": "",
              "line_2": "",
              "line_3": "",
              "country": "US",
              "district": "",
              "metadata": {},
              "created_at": 1643715533,
              "phone_number": "+14155551234"
          },
          "status_transitions": {
              "paid": 1643719155,
              "partial": 0,
              "pending": 1643718644,
              "canceled": 0,
              "returned": 0,
              "fulfilled": 0
          },
          "external_coupon_code": ""
      },
      "trigger_operation_id": "3a9b1c17-5bc2-41f4-8df0-16c193a409af",
      "status": "NEW",
      "created_at": 1643719155,
      "extended_timestamp": 1643719155939
  }
  ```
