Events
Triggering Webhook Types
The following event types are associated with the Order event payload from Shopify.Shopify Order Created
{
"billing_address": {
"address1": "123 Shipping Street",
"address2": "Suite 100",
"city": "Shippington",
"country": "United States",
"country_code": "US",
"first_name": "Steve",
"last_name": "Shipper",
"phone": "555-555-7447",
"province": "Kentucky",
"province_code": "KY",
"zip": "40003"
},
"cancel_reason": "customer",
"cancelled_at": null,
"created_at": null,
"currency": "USD",
"customer": {
"email": "john@example.com",
"first_name": "John",
"id": 115310627314723950,
"last_name": "Smith",
"phone": "+15555555555"
},
"email": "jon@example.com",
"financial_status": "paid",
"fulfillment_status": "fulfilled",
"id": 820982911946154500,
"line_items": [
{
"id": 487817672276298560,
"name": "Aviator sunglasses",
"price": "89.99",
"product_id": 788032119674292900,
"quantity": 1,
"sku": "SKU2006-001",
"title": "Aviator sunglasses",
"variant_id": 12345678
}
],
"name": "#9999",
"order_number": 1234,
"shipping_address": {
"address1": "123 Shipping Street",
"address2": "Suite 100",
"city": "Shippington",
"country": "United States",
"country_code": "US",
"first_name": "Steve",
"last_name": "Shipper",
"phone": "555-555-7447",
"province": "Kentucky",
"province_code": "KY",
"zip": "40003"
},
"tags": "tag1, tag2",
"total_price": "404.95",
"updated_at": null
}
{
"billing_address": {
"address1": "Street address line 1",
"address2": "Street address line 2",
"city": "City",
"country": "Country name",
"country_code": "Two-letter ISO country code",
"first_name": "First name",
"last_name": "Last name",
"phone": "Phone number",
"province": "Province or state name",
"province_code": "Province or state code",
"zip": "ZIP or postal code"
},
"cancel_reason": "Reason for cancellation if the order was cancelled",
"cancelled_at": "When the order was cancelled, if applicable",
"created_at": "When the order was placed",
"currency": "Three-letter ISO currency code",
"customer": {
"email": "Customer email address",
"first_name": "Customer first name",
"id": "Shopify customer ID",
"last_name": "Customer last name",
"phone": "Customer phone number"
},
"email": "Contact email for the order",
"financial_status": "Payment status, e.g. paid, pending, voided, refunded",
"fulfillment_status": "Fulfillment status, e.g. fulfilled, partial, unfulfilled",
"id": "Shopify order ID",
"line_items": {
"id": "Shopify line item ID",
"name": "Line item display name (may include variant)",
"price": "Unit price as a decimal string",
"product_id": "Shopify product ID",
"quantity": "Number of units",
"sku": "Stock-keeping unit identifier",
"title": "Product title",
"variant_id": "Shopify product variant ID"
},
"name": "Human-readable order identifier, e.g. #9999",
"order_number": "Sequential order number",
"shipping_address": {
"address1": "Street address line 1",
"address2": "Street address line 2",
"city": "City",
"country": "Country name",
"country_code": "Two-letter ISO country code",
"first_name": "First name",
"last_name": "Last name",
"phone": "Phone number",
"province": "Province or state name",
"province_code": "Province or state code",
"zip": "ZIP or postal code"
},
"tags": "Comma-separated list of tags applied to the order",
"total_price": "Total order amount as a decimal string",
"updated_at": "When the order was last updated"
}
Payload Field Details
Event Payload
Hide fields
Hide fields
int64
required
Shopify order ID
CEL
id
Example
820982911946154500
string
required
Human-readable order identifier, e.g. #9999
CEL
name
Example
"#9999"
int64
required
Sequential order number
CEL
order_number
Example
1234
string
Contact email for the order
CEL
email
Example
"jon@example.com"
string
Payment status, e.g. paid, pending, voided, refunded
CEL
financial_status
Example
"paid"
string
Fulfillment status, e.g. fulfilled, partial, unfulfilled
CEL
fulfillment_status
Example
"fulfilled"
string
required
Total order amount as a decimal string
CEL
total_price
Example
"404.95"
string
required
Three-letter ISO currency code
CEL
currency
Example
"USD"
string
required
Comma-separated list of tags applied to the order
CEL
tags
Example
"tag1, tag2"
string
Reason for cancellation if the order was cancelled
CEL
cancel_reason
Example
"customer"
timing.v1.Timestamp
required
When the order was placed
CEL
created_at
Example
null
timing.v1.Timestamp
required
When the order was last updated
CEL
updated_at
Example
null
timing.v1.Timestamp
When the order was cancelled, if applicable
CEL
cancelled_at
Example
null
object
Customer who placed the order
CEL
customer
Example
{
"email": "john@example.com",
"first_name": "John",
"id": 115310627314723950,
"last_name": "Smith",
"phone": "+15555555555"
}
int64
Shopify customer ID
CEL
customer.id
Example
115310627314723950
string
Customer email address
CEL
customer.email
Example
"john@example.com"
string
Customer first name
CEL
customer.first_name
Example
"John"
string
Customer last name
CEL
customer.last_name
Example
"Smith"
string
Customer phone number
CEL
customer.phone
Example
"+15555555555"
[]object
required
Products included in the order
CEL
line_items
Example
[
{
"id": 487817672276298560,
"name": "Aviator sunglasses",
"price": "89.99",
"product_id": 788032119674292900,
"quantity": 1,
"sku": "SKU2006-001",
"title": "Aviator sunglasses",
"variant_id": 12345678
}
]
[]int64
required
Mapped array of: Shopify line item ID
CEL
line_items.map(x, x.id)
Example
[
487817672276298560
]
[]string
required
Mapped array of: Product title
CEL
line_items.map(x, x.title)
Example
[
"Aviator sunglasses"
]
[]string
required
Mapped array of: Line item display name (may include variant)
CEL
line_items.map(x, x.name)
Example
[
"Aviator sunglasses"
]
[]int64
required
Mapped array of: Number of units
CEL
line_items.map(x, x.quantity)
Example
[
1
]
[]string
required
Mapped array of: Unit price as a decimal string
CEL
line_items.map(x, x.price)
Example
[
"89.99"
]
[]string
required
Mapped array of: Stock-keeping unit identifier
CEL
line_items.map(x, x.sku)
Example
[
"SKU2006-001"
]
[]int64
required
Mapped array of: Shopify product ID
CEL
line_items.map(x, x.product_id)
Example
[
788032119674292900
]
[]int64
required
Mapped array of: Shopify product variant ID
CEL
line_items.map(x, x.variant_id)
Example
[
12345678
]
object
Billing address for the order
CEL
billing_address
Example
{
"address1": "123 Shipping Street",
"address2": "Suite 100",
"city": "Shippington",
"country": "United States",
"country_code": "US",
"first_name": "Steve",
"last_name": "Shipper",
"phone": "555-555-7447",
"province": "Kentucky",
"province_code": "KY",
"zip": "40003"
}
string
First name
CEL
billing_address.first_name
Example
"Steve"
string
Last name
CEL
billing_address.last_name
Example
"Shipper"
string
Street address line 1
CEL
billing_address.address1
Example
"123 Shipping Street"
string
Street address line 2
CEL
billing_address.address2
Example
"Suite 100"
string
City
CEL
billing_address.city
Example
"Shippington"
string
Province or state name
CEL
billing_address.province
Example
"Kentucky"
string
Country name
CEL
billing_address.country
Example
"United States"
string
ZIP or postal code
CEL
billing_address.zip
Example
"40003"
string
Phone number
CEL
billing_address.phone
Example
"555-555-7447"
string
Two-letter ISO country code
CEL
billing_address.country_code
Example
"US"
string
Province or state code
CEL
billing_address.province_code
Example
"KY"
object
Shipping address for the order
CEL
shipping_address
Example
{
"address1": "123 Shipping Street",
"address2": "Suite 100",
"city": "Shippington",
"country": "United States",
"country_code": "US",
"first_name": "Steve",
"last_name": "Shipper",
"phone": "555-555-7447",
"province": "Kentucky",
"province_code": "KY",
"zip": "40003"
}
string
First name
CEL
shipping_address.first_name
Example
"Steve"
string
Last name
CEL
shipping_address.last_name
Example
"Shipper"
string
Street address line 1
CEL
shipping_address.address1
Example
"123 Shipping Street"
string
Street address line 2
CEL
shipping_address.address2
Example
"Suite 100"
string
City
CEL
shipping_address.city
Example
"Shippington"
string
Province or state name
CEL
shipping_address.province
Example
"Kentucky"
string
Country name
CEL
shipping_address.country
Example
"United States"
string
ZIP or postal code
CEL
shipping_address.zip
Example
"40003"
string
Phone number
CEL
shipping_address.phone
Example
"555-555-7447"
string
Two-letter ISO country code
CEL
shipping_address.country_code
Example
"US"
string
Province or state code
CEL
shipping_address.province_code
Example
"KY"