Webhook Event ReferenceOrders
order.updated
Triggers when an order is updated.
Example Requests
POST
/order.updated{ "api_version": "2024-04-01", "data": { "attribution": { "affiliate": null, "agent": { "email": null, "first_name": "string", "id": 0, "last_name": "string" }, "funnel": null, "gclid": null, "metadata": {}, "subaffiliate1": null, "subaffiliate2": null, "subaffiliate3": null, "subaffiliate4": null, "subaffiliate5": null, "utm_campaign": null, "utm_content": null, "utm_medium": null, "utm_source": null, "utm_term": null }, "billing_address": { "country": "string", "first_name": "string", "id": 0, "last_name": "string", "line1": "string", "line2": "string", "line3": "string", "line4": "string", "phone_number": "string", "postcode": "string", "state": "string" }, "created_at": "2024-01-01T00:00:00Z", "currency": "string", "date_placed": "2024-01-01T00:00:00Z", "display_taxes": "string", "fulfillment_status": "string", "fulfillments": [ { "created_at": "2024-01-01T00:00:00Z", "delivered_at": null, "delivery_status": {}, "id": 0, "last_event_date": null, "line_items": [ { "currency": null, "fulfilled_quantity": null, "fulfillment_service": null, "id": null, "order_line_id": null, "price_excl_tax": null, "price_incl_tax": null, "product_id": null, "product_image": null, "product_title": null, "properties": null, "quantity": null, "requires_shipping": null, "returnable_quantity": null, "returned_quantity": null, "sku": null, "tax_lines": null, "total_discount": null } ], "location_id": 0, "order_number": "string", "origin_address": { "country": "string", "line1": "string", "line2": "string", "line3": "string", "line4": "string", "phone_number": "string", "postcode": "string", "state": "string" }, "processing_at": null, "requires_shipping": false, "shipping_method": "string", "status": "string", "tracking_carrier": "string", "tracking_carriers": "string", "tracking_code": "string", "tracking_codes": "string", "tracking_link": "string", "tracking_links": "https://example.com" } ], "is_test": false, "lines": [ { "created_at": null, "currency": "string", "current_quantity": 0, "editable_quantity": 0, "fulfillable_quantity": 0, "id": 0, "is_gift_card": false, "is_upsell": false, "metadata": {}, "original_price_excl_tax": "0.00", "original_price_incl_tax": "0.00", "original_total_discount": "0.00", "price_excl_tax": "0.00", "price_incl_tax": "0.00", "product_id": 0, "product_image": "https://example.com", "product_title": "string", "product_url": "https://example.com", "properties": [ { "key": null, "value": null } ], "quantity": 0, "report_values": { "currency": "string", "original_price_excl_tax": "0.00", "original_price_incl_tax": "0.00", "original_total_discount": "0.00", "price_excl_tax": "0.00", "price_incl_tax": "0.00", "total_cost": "0.00", "total_discount": "0.00", "unit_cost": "0.00" }, "requires_shipping": false, "sku": "string", "tax_lines": [ { "amount": null, "currency": null, "rate": null, "report_values": null, "source": null, "tax_id": null, "tax_title": null } ], "total_cost": "0.00", "total_discount": "0.00", "unit_cost": "0.00", "updated_at": null, "variant_id": 0, "variant_title": "string" } ], "metadata": {}, "number": "string", "offer_discounts": [ { "amount": "0.00", "description": "string", "name": "string" } ], "order_status_url": "https://example.com", "original_shipping_excl_tax": "0.00", "original_shipping_incl_tax": "0.00", "original_total_discount": "0.00", "original_total_excl_tax": "0.00", "original_total_incl_tax": "0.00", "payment_status": "string", "refunds": [ { "adjustments": [ { "amount_excl_tax": null, "amount_incl_tax": null, "id": null, "report_values": null, "type": null } ], "created_at": "2024-01-01T00:00:00Z", "id": 0, "note": null, "order_number": "string", "refund_line_items": [ { "amount_excl_tax": null, "amount_incl_tax": null, "id": null, "line_item_id": null, "location_id": null, "quantity": null, "report_values": null, "restock_type": null } ], "report_values": { "currency": "string", "total_refund_amount": "0.00", "total_return_excl_tax": "0.00", "total_return_incl_tax": "0.00" }, "total_refund_amount": "0.00", "total_return_excl_tax": "0.00", "total_return_incl_tax": "0.00", "transactions": [ { "amount": null, "auth_code": null, "currency": null, "date_created": null, "external_id": null, "id": null, "is_disputed": null, "is_external": null, "is_initial_retry": null, "is_test": null, "network_transaction_id": null, "parent_id": null, "payment_details": null, "payment_method": null, "report_values": null, "response_code": null, "statement_descriptor": null, "status": null, "type": null } ], "user_id": 0 } ], "report_values": { "currency": "string", "original_shipping_excl_tax": "0.00", "original_shipping_incl_tax": "0.00", "original_total_discount": "0.00", "original_total_excl_tax": "0.00", "original_total_incl_tax": "0.00", "shipping_excl_tax": "0.00", "shipping_incl_tax": "0.00", "total_cost": "0.00", "total_discount": "0.00", "total_excl_tax": "0.00", "total_incl_tax": "0.00" }, "shipping_address": { "country": "string", "first_name": "string", "id": 0, "last_name": "string", "line1": "string", "line2": "string", "line3": "string", "line4": "string", "notes": "string", "phone_number": "string", "postcode": "string", "state": "string" }, "shipping_code": "string", "shipping_excl_tax": "0.00", "shipping_incl_tax": "0.00", "shipping_method": "string", "shipping_tax": "0.00", "shipping_tax_lines": [ { "amount": "0.00", "currency": "string", "rate": 0, "report_values": { "amount": "0.00", "currency": "string" }, "source": "string", "tax_id": 0, "tax_title": "string" } ], "source": "string", "status": "string", "subscription_lifecycle": "string", "subscriptions": [ { "billing_cycle": 0, "id": 0 } ], "supports_post_purchase_upsells": false, "tags": [], "tax_lines": [ { "amount": "0.00", "currency": null, "id": 0, "rate": 0, "report_values": { "amount": "0.00", "currency": "string" }, "source": null, "tax_title": "string" } ], "total_cost": "0.00", "total_discount": "0.00", "total_excl_tax": "0.00", "total_incl_tax": "0.00", "total_outstanding": "0.00", "total_tax": "0.00", "transactions": [ { "amount": "0.00", "auth_code": null, "currency": null, "date_created": "2024-01-01T00:00:00Z", "external_id": null, "id": 0, "is_disputed": false, "is_external": false, "is_initial_retry": null, "is_test": null, "network_transaction_id": null, "parent_id": null, "payment_details": { "bankcard_first_six": null, "bankcard_last_four": null, "card_token": "string", "gateway": { "id": null, "is_next_payments": null, "name": null, "type": null }, "is_3ds": false, "optimized_3ds": false, "paypal_vault_id": "string", "sca_flow": "string" }, "payment_method": null, "report_values": { "amount": "0.00", "currency": "string" }, "response_code": 0, "statement_descriptor": null, "status": "string", "type": "string" } ], "updated_at": "2024-01-01T00:00:00Z", "user": { "accepts_marketing": false, "email": null, "first_name": "string", "id": 0, "ip": null, "language": null, "last_name": "string", "phone_number": null, "user_agent": null }, "voucher_discounts": [ { "amount": "0.00", "description": "string", "name": "string", "voucher": { "code": "string", "end_datetime": "2024-01-01T00:00:00Z", "name": "string", "start_datetime": "2024-01-01T00:00:00Z" } } ] }, "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "event_type": "order.updated", "object": "order", "webhook": { "events": [ "order.updated" ], "id": 1, "store": "example", "target": "https://example.com/webhook/" }}