Orders update

Webhookorders/update

Triggered for any update to the order information.

Requires the order access scope. Minimum supported version: 202007.

Request headers

X-Shoplazza-Topicstring

The event that triggered this delivery, e.g. orders/create

Example: orders/create

X-Shoplazza-Hmac-Sha256string

Base64-encoded HMAC-SHA256 signature of the request body, generated with your app's Client Secret. Use it to verify the request comes from Shoplazza

X-Shoplazza-Shop-Domainstring

The domain of the store that generated the event

Example: example.myshoplaza.com

X-Shoplazza-Api-Versionstring

The API version used to serialize the payload

Example: 2025-06

X-Shoplazza-Deduplication-IDstring

Deduplication ID for this delivery. It stays the same across retries of the same event—use it for idempotency

Request body

Schema
Example

order object
idstring
Order ID
numberstring
Order number
notestring
A custom note input by the merchant regarding the order
financial_statusstring
Payment status. Values: waiting (awaiting payment), paying (payment processing), authorized, partially_paid, paid, failed, refunding, refund_failed, refunded, partially_refunded, cancelled
statusstring
Order status. Values: opened (in progress), placed (paid / order placed), finished (completed, or a terminal state after post-payment cancellation), cancelled (cancelled before payment)
cancel_reasonstring
Reason for order cancellation
canceled_atstring
Time when the order was canceled
payment_methodstring
The payment method used for the order (e.g., apple_pay, credit_card, online)
fulfillment_statusstring
Order fulfillment status. Values: initialled (not yet fulfilling), waiting (awaiting shipment), partially_shipped, shipped, partially_finished, finished, cancelled, returning, partially_returned, returned
customer_notestring
A note provided by the customer during checkout
buyer_accepts_marketingboolean
Indicates whether the customer has agreed to receive marketing promotions
currencystring
Currency code for the order
tagsstring
Custom tags added to the order by merchants or the system
sub_totalstring
The sum of the prices for all line items in the order
total_discountstring
Total amount of discounts applied to the order, including product, shipping, and payment discounts
total_taxstring
Total tax amount applied to the products in the order, excluding shipping tax
total_shippingstring
Total shipping fee for the order
total_pricestring
The final price paid by the customer, including taxes, discounts, tips, additional fee and shipping fees
duty_totalstring
Total customs duty and tax amount
total_tip_receivedstring
Total amount of tips received for the order
discount_applicationsstring
Details of discounts (JSON string)
discount_codestringdeprecated
Discount code applied to the order. (Deprecated: parse discount_applications instead.)
code_discount_totalstringdeprecated
Total discount from discount codes. (Deprecated: extract from discount_applications instead.)
line_item_discount_totalstringdeprecated
Line-item level discount total. (Deprecated: extract from discount_applications instead.)
applied_gift_cardsstringdeprecated
Gift cards applied during checkout. (Deprecated: not recommended.)
created_atstring
Time when the order was created (e.g., 2018-11-02T12:30:10Z)
updated_atstring
Time when the order was last updated
customer_deleted_atstring
Time when the customer associated with the order was deleted
deleted_atstring
Time when the order was deleted
placed_atstring
Time when the order was paid
closed_atstring
Time when the order was closed
browser_ipstring
Browser IP address
landing_sitestring
The first page the customer landed on (URL)
last_landing_urlstring
Last visited page
configstring
Order configuration snapshot (JSON string), including market info and checkout page config
checkout_urlstring
The checkout page URL for the order (including store domain)
refer_infostring
Visit information (JSON string)
sales_platformstring
Sales channel
order_typeinteger
Order type
product_tax_includedboolean
Whether product prices already include tax
additional_totalstring
Total amount of additional charges, numeric string (e.g., "9.99")
shipping_tax_totalstring
Total shipping tax amount of the order
shipping_tax_typeinteger
Shipping tax type
testbooleandeprecated
Whether this is a test order. (Deprecated: not recommended, determine on your own.)
total_paidstring
Total amount paid by the customer for the order
real_total_paidstring
Actual total amount paid
refund_pricestringdeprecated
Amount of the most recent refund request (refund events only). (Deprecated: do not use.)
refund_statusstringdeprecated
Refund method of the most recent refund (refund events only). (Deprecated: do not use.)
total_refund_pricestring
Total refund amount that has been successfully processed (e.g., "9.99")
total_refund_discountstringdeprecated
Cumulative refunded discount (refund events only). (Deprecated: do not use.)
total_refund_taxstringdeprecated
Cumulative refunded tax (refund events only). (Deprecated: do not use.)
customer object
Customer who placed the order. This is not an order snapshot — it may change when the customer places their next order
idstring
Customer ID
first_namestring
First name
last_namestring
Last name
emailstring
Email address
phonestring
Phone number
order_countinteger
Number of orders placed by the customer
total_spentstring
Total amount spent by the customer
created_atstring
Time when the customer record was created
updated_atstring
Time when the customer record was last updated
shipping_address object
Delivery address
first_namestring
First name of consignee
last_namestring
Last name of consignee
namestring
Name of consignee
address1string
Address line (e.g., Suite 1234)
address2string
Second address line
citystring
City (e.g., SAN JOSE)
areastring
Area (e.g., Bay area)
provincestring
Province (e.g., New Mexico)
province_codestring
Province code (e.g., NM)
countrystring
Country (e.g., United States)
country_codestring
Country code (e.g., US)
zipstring
ZIP code (e.g., 87036)
phonestring
Phone number (e.g., +86 1231231234)
phone_area_codestring
Area code (e.g., +86). Present on shipping_address
companystring
Company (e.g., ABC Limited)
latitudestring
Latitude of the delivery address (e.g., 22.54)
longitudestring
Longitude of the delivery address (e.g., 114.06)
emailstring
Email address
extra_info object
Special shipping information: extra_info.cpf (personal tax ID), extra_info.tax_text (tax text), extra_info.short_address (short address); extra_info.addition is a merchant-defined dictionary
cpfstring
Personal tax ID (CPF)
tax_textstring
Tax text
short_addressstring
Short address
additionobject
Merchant-defined dictionary; keys vary
billing_address object
Billing address
first_namestring
First name of consignee
last_namestring
Last name of consignee
namestring
Name of consignee
address1string
Address line (e.g., Suite 1234)
address2string
Second address line
citystring
City (e.g., SAN JOSE)
areastring
Area (e.g., Bay area)
provincestring
Province (e.g., New Mexico)
province_codestring
Province code (e.g., NM)
countrystring
Country (e.g., United States)
country_codestring
Country code (e.g., US)
zipstring
ZIP code (e.g., 87036)
phonestring
Phone number (e.g., +86 1231231234)
phone_area_codestring
Area code (e.g., +86). Present on shipping_address
companystring
Company (e.g., ABC Limited)
latitudestring
Latitude of the delivery address (e.g., 22.54)
longitudestring
Longitude of the delivery address (e.g., 114.06)
emailstring
Email address
extra_info object
Special shipping information: extra_info.cpf (personal tax ID), extra_info.tax_text (tax text), extra_info.short_address (short address); extra_info.addition is a merchant-defined dictionary
cpfstring
Personal tax ID (CPF)
tax_textstring
Tax text
short_addressstring
Short address
additionobject
Merchant-defined dictionary; keys vary
line_items object[]
List of purchased products
Array [
idstring
Line item ID
product_idstring
ID of the product associated with this line item
variant_idstring
ID of the specific product variant
product_titlestring
The name of the product purchased
variant_titlestring
The title of the product variant, e.g. "Blue, Size M"
product_handlestring
URL handle of the product
product_urlstring
The URL of the product page for customers
skustring
Stock Keeping Unit (SKU) for the product variant
spustring
Standard Product Unit (SPU)
quantityinteger
The number of units of this product purchased
pricestring
Price
compare_at_pricestring
Compare-at price
totalstring
Line total for this item
duty_pricestring
Duty cost
payment_discount_pricestring
Price of payment discounts applied to the line item
discount_applicationsstring
Discounts applied to this line item (JSON string)
fulfillment_statusstring
The fulfillment status of this line item, e.g. "fulfilled", "unfulfilled"
requires_shippingboolean
Whether this line item requires shipping
weightstring
Weight of the product
weight_unitstring
Unit of measurement for the product weight, e.g. "kg", "lbs"
imagestring
Product image
notestring
A note related to the product in this line item
vendorstring
The vendor or supplier of the product
refund_quantityintegerdeprecated
Quantity of the most recent refund request (refund events only). (Deprecated: do not use.)
refund_totalstringdeprecated
Cumulative refunded item amount (refund events only). (Deprecated: do not use.)
properties object[]
Line item properties, each with name and value
Array [
namestring
Property name
valuestring
Property value
]
custom_propertiesobject
Custom properties of the line item (e.g. size, color). A merchant-defined dictionary — keys vary by product
shipped_quantityinteger
Quantity shipped in this fulfillment. Present in fulfillments[].line_items only
main_currency_prices object
Prices converted to the primary-market currency
sub_totalstring
Subtotal in the primary-market currency
total_pricestring
Total price in the primary-market currency
total_discountstring
Total discount in the primary-market currency
total_taxstring
Total tax in the primary-market currency
total_shippingstring
Total shipping in the primary-market currency
actual_ratestring
Exchange rate applied
primary_market_currencystring
The primary-market currency code
pricestring
Unit price in the primary-market currency (line-item level)
compare_at_pricestring
Compare-at price in the primary-market currency (line-item level)
totalstring
Line total (price x quantity) in the primary-market currency (line-item level)
]
main_currency_prices object
Prices converted to the store's primary-market currency
sub_totalstring
Subtotal in the primary-market currency
total_pricestring
Total price in the primary-market currency
total_discountstring
Total discount in the primary-market currency
total_taxstring
Total tax in the primary-market currency
total_shippingstring
Total shipping in the primary-market currency
actual_ratestring
Exchange rate applied
primary_market_currencystring
The primary-market currency code
pricestring
Unit price in the primary-market currency (line-item level)
compare_at_pricestring
Compare-at price in the primary-market currency (line-item level)
totalstring
Line total (price x quantity) in the primary-market currency (line-item level)
payment_line object
Payment details
idstring
Payment line ID
payment_channelstring
The payment channel used for the transaction (e.g., PayPal, Stripe, Bank Transfer)
payment_methodstring
The specific method of payment used within the channel (e.g., Visa, MasterCard, online)
transaction_nostring
The unique transaction number associated with this payment
credit_card_numberstring
The last few digits of the credit card used
merchant_emailstring
Merchant email address
descstring
Payment description
merchant_idstring
Merchant ID
paid_totalstring
Amount paid through this payment line
payment_lines object[]
List of payment lines
Array [
idstring
Payment line ID
payment_channelstring
The payment channel used for the transaction (e.g., PayPal, Stripe, Bank Transfer)
payment_methodstring
The specific method of payment used within the channel (e.g., Visa, MasterCard, online)
transaction_nostring
The unique transaction number associated with this payment
credit_card_numberstring
The last few digits of the credit card used
merchant_emailstring
Merchant email address
descstring
Payment description
merchant_idstring
Merchant ID
paid_totalstring
Amount paid through this payment line
]
shipping_line object
Information about the shipping plan selected for the order
namestring
Name
descstring
Description
delivery_methodinteger
Delivery method
extra_infostring
Additional shipping information (JSON string)
fulfillments object[]
List of fulfillments
Array [
idstring
Fulfillment ID
order_idstring
Order ID
statusstring
Fulfillment status
created_atstring
Creation time, in ISO-8601 format
updated_atstring
Last update time, in ISO-8601 format
line_items object[]
Line items included in this fulfillment
Array [
idstring
Line item ID
product_idstring
ID of the product associated with this line item
variant_idstring
ID of the specific product variant
product_titlestring
The name of the product purchased
variant_titlestring
The title of the product variant, e.g. "Blue, Size M"
product_handlestring
URL handle of the product
product_urlstring
The URL of the product page for customers
skustring
Stock Keeping Unit (SKU) for the product variant
spustring
Standard Product Unit (SPU)
quantityinteger
The number of units of this product purchased
pricestring
Price
compare_at_pricestring
Compare-at price
totalstring
Line total for this item
duty_pricestring
Duty cost
payment_discount_pricestring
Price of payment discounts applied to the line item
discount_applicationsstring
Discounts applied to this line item (JSON string)
fulfillment_statusstring
The fulfillment status of this line item, e.g. "fulfilled", "unfulfilled"
requires_shippingboolean
Whether this line item requires shipping
weightstring
Weight of the product
weight_unitstring
Unit of measurement for the product weight, e.g. "kg", "lbs"
imagestring
Product image
notestring
A note related to the product in this line item
vendorstring
The vendor or supplier of the product
refund_quantityintegerdeprecated
Quantity of the most recent refund request (refund events only). (Deprecated: do not use.)
refund_totalstringdeprecated
Cumulative refunded item amount (refund events only). (Deprecated: do not use.)
properties object[]
Line item properties, each with name and value
Array [
namestring
Property name
valuestring
Property value
]
custom_propertiesobject
Custom properties of the line item (e.g. size, color). A merchant-defined dictionary — keys vary by product
shipped_quantityinteger
Quantity shipped in this fulfillment. Present in fulfillments[].line_items only
main_currency_prices object
Prices converted to the primary-market currency
sub_totalstring
Subtotal in the primary-market currency
total_pricestring
Total price in the primary-market currency
total_discountstring
Total discount in the primary-market currency
total_taxstring
Total tax in the primary-market currency
total_shippingstring
Total shipping in the primary-market currency
actual_ratestring
Exchange rate applied
primary_market_currencystring
The primary-market currency code
pricestring
Unit price in the primary-market currency (line-item level)
compare_at_pricestring
Compare-at price in the primary-market currency (line-item level)
totalstring
Line total (price x quantity) in the primary-market currency (line-item level)
]
tracking_items object[]
List of tracking items in this fulfillment
Array [
tracking_companystring
Logistics company
tracking_company_codestring
Logistics company code
tracking_numberstring
Tracking number
tracking_urlstring
Tracking URL
]
tracking_companystring
Logistics company name. See tracking_items for multiple tracking numbers
tracking_company_codestring
Logistics company code. See tracking_items for multiple tracking numbers
tracking_numberstring
Tracking number. See tracking_items for multiple tracking numbers
tracking_urlstring
Tracking URL. See tracking_items for multiple tracking numbers
]
location_line object
Merchant's warehouse address
location_idstring
Identifier for the associated location
location_namestring
Name of the location, such as a store or warehouse
first_namestring
Contact first name
last_namestring
Contact last name
phonestring
Contact phone number
emailstring
Contact email
countrystring
Country
country_codestring
Country code
provincestring
Province
province_codestring
Province code
areastring
Area
citystring
City
addressstring
Address
address1string
Address line
companystring
Company
zipstring
ZIP code
latitudestring
Latitude
longitudestring
Longitude
additional_prices object[]
The detail list of additional charges
Array [
biz_idstring
Business ID
namestring
Name of the additional charge
fee_titlestring
Custom charge name
pricestring
Amount of the additional charge
]

{
  "order": {
    "id": "string",
    "number": "string",
    "note": "string",
    "financial_status": "string",
    "status": "string",
    "cancel_reason": "string",
    "canceled_at": "string",
    "payment_method": "string",
    "fulfillment_status": "string",
    "customer_note": "string",
    "buyer_accepts_marketing": true,
    "currency": "string",
    "tags": "string",
    "sub_total": "string",
    "total_discount": "string",
    "total_tax": "string",
    "total_shipping": "string",
    "total_price": "string",
    "duty_total": "string",
    "total_tip_received": "string",
    "discount_applications": "string",
    "created_at": "string",
    "updated_at": "string",
    "customer_deleted_at": "string",
    "deleted_at": "string",
    "placed_at": "string",
    "closed_at": "string",
    "browser_ip": "string",
    "landing_site": "string",
    "last_landing_url": "string",
    "config": "string",
    "checkout_url": "string",
    "refer_info": "string",
    "sales_platform": "string",
    "order_type": 0,
    "product_tax_included": true,
    "additional_total": "string",
    "shipping_tax_total": "string",
    "shipping_tax_type": 0,
    "total_paid": "string",
    "real_total_paid": "string",
    "total_refund_price": "string",
    "customer": {
      "id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "string",
      "phone": "string",
      "order_count": 0,
      "total_spent": "string",
      "created_at": "string",
      "updated_at": "string"
    },
    "shipping_address": {
      "first_name": "string",
      "last_name": "string",
      "name": "string",
      "address1": "string",
      "address2": "string",
      "city": "string",
      "area": "string",
      "province": "string",
      "province_code": "string",
      "country": "string",
      "country_code": "string",
      "zip": "string",
      "phone": "string",
      "phone_area_code": "string",
      "company": "string",
      "latitude": "string",
      "longitude": "string",
      "email": "string",
      "extra_info": {
        "cpf": "string",
        "tax_text": "string",
        "short_address": "string",
        "addition": {}
      }
    },
    "billing_address": {
      "first_name": "string",
      "last_name": "string",
      "name": "string",
      "address1": "string",
      "address2": "string",
      "city": "string",
      "area": "string",
      "province": "string",
      "province_code": "string",
      "country": "string",
      "country_code": "string",
      "zip": "string",
      "phone": "string",
      "phone_area_code": "string",
      "company": "string",
      "latitude": "string",
      "longitude": "string",
      "email": "string",
      "extra_info": {
        "cpf": "string",
        "tax_text": "string",
        "short_address": "string",
        "addition": {}
      }
    },
    "line_items": [
      {
        "id": "string",
        "product_id": "string",
        "variant_id": "string",
        "product_title": "string",
        "variant_title": "string",
        "product_handle": "string",
        "product_url": "string",
        "sku": "string",
        "spu": "string",
        "quantity": 0,
        "price": "string",
        "compare_at_price": "string",
        "total": "string",
        "duty_price": "string",
        "payment_discount_price": "string",
        "discount_applications": "string",
        "fulfillment_status": "string",
        "requires_shipping": true,
        "weight": "string",
        "weight_unit": "string",
        "image": "string",
        "note": "string",
        "vendor": "string",
        "properties": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "custom_properties": {},
        "shipped_quantity": 0,
        "main_currency_prices": {
          "sub_total": "string",
          "total_price": "string",
          "total_discount": "string",
          "total_tax": "string",
          "total_shipping": "string",
          "actual_rate": "string",
          "primary_market_currency": "string",
          "price": "string",
          "compare_at_price": "string",
          "total": "string"
        }
      }
    ],
    "main_currency_prices": {
      "sub_total": "string",
      "total_price": "string",
      "total_discount": "string",
      "total_tax": "string",
      "total_shipping": "string",
      "actual_rate": "string",
      "primary_market_currency": "string",
      "price": "string",
      "compare_at_price": "string",
      "total": "string"
    },
    "payment_line": {
      "id": "string",
      "payment_channel": "string",
      "payment_method": "string",
      "transaction_no": "string",
      "credit_card_number": "string",
      "merchant_email": "string",
      "desc": "string",
      "merchant_id": "string",
      "paid_total": "string"
    },
    "payment_lines": [
      {
        "id": "string",
        "payment_channel": "string",
        "payment_method": "string",
        "transaction_no": "string",
        "credit_card_number": "string",
        "merchant_email": "string",
        "desc": "string",
        "merchant_id": "string",
        "paid_total": "string"
      }
    ],
    "shipping_line": {
      "name": "string",
      "desc": "string",
      "delivery_method": 0,
      "extra_info": "string"
    },
    "fulfillments": [
      {
        "id": "string",
        "order_id": "string",
        "status": "string",
        "created_at": "string",
        "updated_at": "string",
        "line_items": [
          {
            "id": "string",
            "product_id": "string",
            "variant_id": "string",
            "product_title": "string",
            "variant_title": "string",
            "product_handle": "string",
            "product_url": "string",
            "sku": "string",
            "spu": "string",
            "quantity": 0,
            "price": "string",
            "compare_at_price": "string",
            "total": "string",
            "duty_price": "string",
            "payment_discount_price": "string",
            "discount_applications": "string",
            "fulfillment_status": "string",
            "requires_shipping": true,
            "weight": "string",
            "weight_unit": "string",
            "image": "string",
            "note": "string",
            "vendor": "string",
            "properties": [
              {
                "name": "string",
                "value": "string"
              }
            ],
            "custom_properties": {},
            "shipped_quantity": 0,
            "main_currency_prices": {
              "sub_total": "string",
              "total_price": "string",
              "total_discount": "string",
              "total_tax": "string",
              "total_shipping": "string",
              "actual_rate": "string",
              "primary_market_currency": "string",
              "price": "string",
              "compare_at_price": "string",
              "total": "string"
            }
          }
        ],
        "tracking_items": [
          {
            "tracking_company": "string",
            "tracking_company_code": "string",
            "tracking_number": "string",
            "tracking_url": "string"
          }
        ],
        "tracking_company": "string",
        "tracking_company_code": "string",
        "tracking_number": "string",
        "tracking_url": "string"
      }
    ],
    "location_line": {
      "location_id": "string",
      "location_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "string",
      "country": "string",
      "country_code": "string",
      "province": "string",
      "province_code": "string",
      "area": "string",
      "city": "string",
      "address": "string",
      "address1": "string",
      "company": "string",
      "zip": "string",
      "latitude": "string",
      "longitude": "string"
    },
    "additional_prices": [
      {
        "biz_id": "string",
        "name": "string",
        "fee_title": "string",
        "price": "string"
      }
    ]
  }
}

Request headers​

Request body​

Request headers

Request body