{
"data": {
"source": "EXTERNAL",
"mode": "LIVE",
"id": "order_e9c7062a-b557-4adc-92b8-867aa90bac97",
"external_id": "external_id",
"status": "CANCELLED",
"email": "[email protected]",
"invoice_number": "invoice_number",
"items": [
{
"id": "item_847d4c5f44924f238fdda46968924b0b",
"product_id": null,
"variation_id": null,
"external_product_id": null,
"external_variation_id": null,
"name": "test_product2",
"image": null,
"sku": null,
"options": [],
"quantity": 1,
"shippable": false,
"unit_price": "19.99",
"unit_weight": null,
"unit_dimensions": null,
"total": "19.99",
"combined_weight": null,
"metadata": {}
}
],
"billing_address": {
"name": "first_name last_name",
"first_name": "first_name last_name",
"last_name": null,
"full_name": "first_name last_name",
"address_1": "address",
"address_2": null,
"street_number": null,
"street_name": null,
"city": "city",
"sub_locality": null,
"region": null,
"country": "US",
"postal_code": "postal_code",
"phone": null
},
"shipping_address": {
"name": "first_name last_name",
"first_name": "first_name last_name",
"last_name": null,
"full_name": "first_name last_name",
"address_1": "address",
"address_2": null,
"street_number": null,
"street_name": null,
"city": "city",
"sub_locality": null,
"region": null,
"country": "US",
"postal_code": "postal_code",
"phone": null
},
"shipping_method": {
"name": "Express shipping",
"cost": "10.00"
},
"shipping_instructions": "instructions",
"discounts": [],
"taxes": [],
"subtotal": "19.99",
"total": "29.99",
"payment": {
"transaction_id": "transaction_id",
"status": "REFUNDED",
"currency": "USD",
"method": "unknown",
"card_brand": null,
"card_last_4": null,
"confirmed_method": {
"gateway": "NONE",
"name": "UNKNOWN",
"display_name": null,
"icon": null,
"details": null,
"instructions": null
}
},
"refunds": [
{
"id": "refund_c87f9270a7b542179a018d653b72941b",
"order_id": "order_e9c7062a-b557-4adc-92b8-867aa90bac97",
"transaction_id": null,
"reason": null,
"items": [
{
"id": "item_847d4c5f44924f238fdda46968924b0b",
"quantity": 1,
"amount": "19.99",
"taxes": []
},
{
"id": "item_shipping",
"quantity": 1,
"amount": "10.00",
"taxes": []
}
],
"currency": "USD",
"tax_provider": {
"provider": "BUILT_IN",
"avalara_reference_id": null
},
"subtotal": "29.99",
"taxes": [],
"total": "29.99",
"created": "2025-05-07T17:19:14.1966946Z"
}
],
"tracking_url": null,
"tracking_number": null,
"created": "2024-01-17T00:05:52.641Z",
"user_agent": null,
"customer_accepts_marketing": false,
"ip_address": null,
"cancellation_reason": "",
"cancelled": "2025-05-07T17:19:14.1558377+00:00",
"metadata": ""
},
"source": null,
"resource_data": {
"site_name": "931c0ef0"
},
"event_timestamp": 1746638354579,
"event_type": "ECOMM_ORDER_CANCELLED"
}
order_details
Property | Description |
---|---|
mode string | Can be "TEST" or "LIVE". |
id string | Unique identifier of the order. |
status string | Can be "IN_PROGRESS", "PROCESSED", "SHIPPED", "DELIVERED", "PENDING", "CANCELLED", or "DISPATCHED". Note: The DISPUTED is now deprecated. Any usage of it will set the status to "CANCELLED". |
email string | Email associated with the order. |
invoice_number string | Invoice number of the order. |
items object[] | The items in the order. |
billing_address object | The billing address details of the order owner. |
shipping_address object | The shipping address details of the order owner. |
shipping_method object | The shipping method of the order. |
discounts object[] | The discounts applied to the order. |
taxes object[] | The taxes applied to the order. |
subtotal number | Cost of the order before any additions (i.e.: Taxes, Shipping, etc.) |
total number | The total cost of the order. |
payment object | The payment information of the order. |
refunds object[] | The refunds applied to the order. |
tracking_url string | Public URL from the shipping provider to get updates on the shipped order. |
tracking_number string | Public tracking number associated to the order. |
created string | Date that indicates when the order was completed. |
user_agent string | User agent of the customer who made the order. |
ip_address string | IP address of the customer who made the order. |
cancellation_reason string | Reason why the order was cancelled. |
cancelled string | Date when the order was cancelled. |
metadata string | Metadata associated with the order. |
items
Property | Description |
---|---|
id string | System identifier of the line item. |
product_id string | The unique identifier for the product backing this order item. |
variation_id string | The unique identifier for the product variation backing this order item. |
external_product_id string | The external id of the product backing this order item. |
external_variation_id string | The external id of the product variation backing this order item. |
name string | Display name of the line item. |
image string | Display image of the line item. |
options object[] | Options selected by the customer associated with the line item. |
shippable bool | Indicates if this item requires shipping. |
quantity number | Quantity bought for this item. |
unit_price number | Price of a single unit of this line item. |
unit_weight number | Weight of a single unit of this line item. |
unit_dimensions object | Dimensions of this line item. |
total number | Total price of this line item (quantity * unit price). |
combined_weight number | Total weight of this line item (quantity * unit weight). |
options
Property | Description | Mutable |
---|---|---|
name string | Name of the option. | Yes |
value string | Value of the option. | Yes |
unit_dimensions
Property | Description |
---|---|
height number | Height of a single unit of this line item. |
width number | Width of a single unit of this line item. |
length number | Length of a single unit of this line item. |
address
Field | Description |
---|---|
first_name string | First Name attached to the address. |
last_name string | Last Name attached to the address. |
full_name string | Full Name attached to the address. |
address_1 string | The first line of the address. |
address_2 string | The second line of the address. |
street_number *string | The street number note: this may be part of the address_1 or address_2 values, but is available here as a separate value. |
street_name string | The street name note: this may be part of the address_1 or address_2 values, but is available here as a separate value. |
city string | Name of city attached to the address. |
sub_locality string | Sub-locality attached to the address (ex: county or district name). |
region string | Region attached to the address (ex. the state or province name). |
country string | Country attached to the address. |
postal_code string | Postal code attached to the address. |
phone string | Phone number of contact located at this address. |
shipping_method
Property | Description |
---|---|
name string | Name of the shipping method selected on the order. |
cost number | The cost incurred for the order by the shipping method. |
discounts
Property | Description |
---|---|
id string | System identifier of the discount resource that was added to this order. |
savings number | The amount of money that was saved on the total of the order using the discount. |
name string | The name of the discount. |
type string | The type of discount that was applied to the order. |
taxes
Property | Description |
---|---|
name string | Name of the tax. |
amount number | Amount of the tax when applied to the given order. |
rate number | Percentage rate of the amount that was added for this tax. |
payment
Property | Description |
---|---|
transaction_id string | Unique identifier given by the payment provider used to identify the payment made for the order. |
status string | Can be "PAID", "DEFERRED", "PAID_DEFERRED", "CHARGED_BACK", "REFUNDED", "PAIDOUT", "PENDING", "FAILED", "EXPIRED", "CANCELLED", "OPEN", or "AUTHORIZED". |
currency string | Currency of the order. |
card_brand string | Can be "NULL", "VISA", "MASTERCARD", "AMEX", "DINERS_CLUB", "DISCOVER", "J_C_B", "CARD_BLEUE", "DANKORT", "CARTA_SI", "POSTEPAY", "MAESTRO", "LASER", "UNIONPAY", or "OTHER". |
payment object | The confirmed payment method for the order. |
refunds
Property | Description |
---|---|
id string | System identifier of the refund. |
amount number | Refunded amount. |
reason string | Reason written by the merchant for the refund. |
created string | Date of the refund. |
confirmed_method
Property | Description |
---|---|
gateway string | Can be "NONE", "STRIPE", "SQUARE", "CUSTOM", "PAYPAL_COMMERCE_EXPRESS_CHECKOUT_ONLY", "PAYPAL_COMMERCE", "MANUAL_PAYMENTS", or "MOLLIE". |
name string | Can be "UNKNOWN", "CREDIT_CARD", "PAYPAL", "MANUAL", "CUSTOM", "NO_PAYMENT", "APPLE_PAY", "GOOGLE_PAY", "MASTERPASS", "AMEX_EXPRESS_CHECKOUT", "SAMSUNG_PAY", "VISA_CHECKOUT", "LINK", "ACH_CREDIT_TRANSFER", "ACH_DIRECT_DEBIT", "ACSS_DEBIT", "ALIPAY", "BECS_DIRECT_DEBIT", "BANCONTACT", "POINT_OF_SALE", "EPS", "IDEAL", "KLARNA", "MULTIBANCO", "PRZELEWY24", "SEPA_DIRECT_DEBIT", "SOFORT", "WE_CHAT_PAY", "AFFIRM", "AFTERPAY_CLEARPAY", "BACS_DIRECT_DEBIT", "BLIK, BOLETO", "CASH", "FPX", "GRAB_PAY", "INTERAC_DEBIT", "KONBINI", "OXXO", "PAY_NOW", "PIX", "PROMPT_PAY", "TWINT", "CHECK", "BANK_TRANSFER", "GIFT_CARD", "CRYPTO", "SQUARE_CASH_APP", "VOUCHER", "CASH_APP", "PAY_PAY", "RAKUTEN_PAY", "AU_PAY", "D_BARAI, MERPAY", "AMAZON_PAY", "MOBILE_PAY", "REVOLUT_PAY", "SWISH", or "ZIP". |
display_name string | The name of the payment method. |
icon string | The icon associated with the payment method. |
details string | The details of the payment method. |
instructions string | The instructions for the payment method. |