Checkout updated

Event GroupEvent Identification
checkoutscheckouts/update
Occurs whenever a checkout page is updated.
Request Headers
  • Content-Type string required
    The field must be set to the fixed value application/json; charset=utf-8.
  • X-Shopline-Topic string required
    The unique identifier for the event.
    Example: orders/edited
  • X-Shopline-Hmac-Sha256 string required
    The signature of the request. Upon receiving the request, you must verify the signature to confirm the authenticity and integrity of the data.
    Example: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
  • X-Shopline-Shop-Domain string required
    The store domain.
    Example: example.myshopline.com
  • X-Shopline-Shop-Id string required
    The store ID.
    Example: 1610418123456
  • X-Shopline-Merchant-Id string required
    The merchant ID.
    Example: 2000001234
  • X-Shopline-API-Version string required
    The API version.
    Example: v20250601
  • X-Shopline-Webhook-Id string required
    The ID of this Webhook event.
    Example: b54557e48a5fbf7d70bcd043
Request Body
  • abandoned_checkout_url string
    The link to the abandoned checkout.
    Example: https://example.myshopline.com/trade/checkouts/c2c4a7b0c586a273f781c271f6a1b6f6?mark=345B5E216A2080FBA20456099D2B8468A895199B21CA87BAE83141EF693C0033
  • applied_discountsobject[]
    Discounts or promotions applied at the order level.
  • amount string
    The discount amount, rounded to two decimal places and displayed in the currency corresponding to presentment_currency.
    Example: 8.00
  • application_type string
    Discount type. Valid values are:
    • MANUAL_DISCOUNT: manual discount
    • FULL_DISCOUNT: bulk discount or free shipping
    • TIME_LIMITED: time-limited promotion
    • BUNDLED: bundle combination
    • DISCOUNT_CODE: discount code
    • GIFT: gift promotion
    • PRE_ORDER: pre-order
  • target_selection string
    The discount scope. Valid values are:
    • explicit: Applies to an individual product
    • entitled: Applies to the entire line item
    • all: If target_type is line_item, the discount applies to the entire order. If target_type is shipping_line, the discount applies to the shipping fee.
  • target_type string
    The target that the discount applies to. Valid values:
    • line_item: The discount applies to the line item.
    • shipping_line: The discount applies to the shipping fee.
  • title string
    The title of the discount promotion.
  • value string
    The specific value of the discount.
    • When value_type is fix_amount, this field value represents a specific discount amount. For example, if the value is 10 and the currency is CNY, it means a discount of 10 yuan.
    • When value_type is percentage, the value of this field value represents a specific discount percentage. For example, 10 means 10% off of the order amount.
  • value_type string
    The type of discount value. Valid values are:
    • fix_amount: Fixed amount discount. For example, if value is 10 in CNY, it means a discount of 10 yuan.
    • percentage: Percentage-based discount. For example, if value is 10, it means 10% off of the order amount.
  • billing_addressobject
    The address for sending billing invoices.
  • address1 string
    The first line of the address. This typically includes information such as the street address or a post office box number.
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
  • city string
    The city in the address.
    Example: New York
  • country string
    The country or region in the address.
    Example: USA
  • country_code string
    A two-letter country or region code that follows the ISO 3166-1 standard, used to identify a specific country or region in the address.
    Example: US
  • first_name string
    The first name of the billing recipient.
  • last_name string
    The last name of the billing recipient.
  • name string
    The full name of the billing recipient.
  • phone string
    The phone number of the billing recipient.
  • province string
    The province in the address.
    Example: California
  • province_code string
    The code for the province in the address, which can be a custom code or a two-character ISO 3166-2 international code.
    Example: 4200006
  • zip string
    The postal code information of the billing address.
  • buyer_accepts_marketing boolean
    Whether the buyer has subscribed to promotion and order update information.
    • true: subscribed
    • false: not subscribed
  • cart_token string
    The unique credential for shopping cart data.
    Example: c4a54360f2b2460fbb6973bb80406111
  • closed_at string
    The date and time when the checkout was closed. Format: ISO 8601. The closing process occurs in the following two ways:
    • Automatic closing: The system automatically closes the checkout if the order is not completed within 60 days.
    • Order generation: Closing is triggered when an order is generated through the abandoned checkout.
    Example: 2024-08-31T02:20:26+08:00
  • completed_at string
    The date and time when the checkout was completed. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • created_at string
    The date and time when the checkout was created. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • currency string
    Three-letter currency code, displayed in the store's currency and following the ISO 4217 international standard.
    Example: USD
  • customerobject
    Buyer information.
  • addressesobject
    Buyer's address information.
  • address1 string
    The first line of the buyer address. This typically includes information such as the street address or a post office box number.
  • address2 string
    The second line of the buyer address. This typically includes information such as apartment, suite, or unit number.
  • city string
    The city in the address.
    Example: New York
  • country string
    The country or region in the address.
    Example: USA
  • country_code string
    A two-letter country or region code that follows the ISO 3166-1 standard, used to identify a specific country or region in the address.
    Example: US
  • first_name string
    The first name of the buyer.
  • last_name string
    The last name of the buyer.
  • name string
    The full name of the buyer.
  • phone string
    The phone number of the buyer.
  • province string
    The province in the address.
    Example: California
  • province_code string
    The code for the province in the address, which can be a custom code or a two-character ISO 3166-2 international code.
    Example: 4200006
  • zip string
    The postal code information of the address.
    Example: 92503
  • currency string
    Three-letter currency code, displayed in the store's currency and following the ISO 4217 international standard.
    Example: USD
  • email string
    The email of the buyer.
    Example: example@example.com
  • first_name string
    The first name of the buyer.
  • id string
    Buyer's ID.
    Example: 4201057495
  • last_name string
    The last name of the buyer.
  • phone string
    The phone number of the buyer.
  • discount_codesobject[]
    List of discount codes.
  • amount double
    Discount code amount. The value is rounded to two decimal places and displayed in the currency corresponding to presentment_currency.
    Example: 8
  • title string
    The title of the discount code promotion.
  • type integer
    Activity type at the order level. Valid values are:
    • 1: Amount reduction
    • 2: Discount(percentage off)
    • 3: Free shipping
    • 4: Marked-up item
    • 5: Preferential price for any N items
    • 6: Preferential price for A+B combination
    • 7: Free gift
    • 8: Fixed selling price
    • 9: Lowest-priced item free
    • 10: Bundle price
    • 11: Discount for Nth item
    • 12: Buy X get Y free
    • 13: Customized
  • email string
    Customer's contact email.
    Example: email@example.cpm
  • id string
    The unique credential for the checkout.
    Example: c2c4a7b1e182e894f6e194a99489f870
  • line_itemsobject[]
    Checkout item information list.
  • applied_discountsobject[]
    Discounts or promotions applied at the line item level.
  • amount string
    The discount amount, rounded to two decimal places and displayed in the currency corresponding to presentment_currency.
    Example: 8.00
  • application_type string
    Discount type. Valid values are:
    • MANUAL_DISCOUNT: manual discount
    • FULL_DISCOUNT: bulk discount or free shipping
    • TIME_LIMITED: time-limited promotion
    • BUNDLED: bundle combination
    • DISCOUNT_CODE: discount code
    • GIFT: gift promotion
    • PRE_ORDER: pre-order
  • target_selection string
    The discount scope. Valid values are:
    • explicit: Applies to an individual product
    • entitled: Applies to the entire line item
    • all: If target_type is line_item, the discount applies to the entire order. If target_type is shipping_line, the discount applies to the shipping fee.
  • target_type string
    The target that the discount applies to. Valid values:
    • line_item: The discount applies to the line item.
    • shipping_line: The discount applies to the shipping fee.
  • title string
    The title of the discount promotion.
  • value string
    The specific value of the discount.
    • When value_type is fix_amount, this field value represents a specific discount amount. For example, if the value is 10 and the currency is CNY, it means a discount of 10 yuan.
    • When value_type is percentage, the value of this field value represents a specific discount percentage. For example, 10 means 10% off of the order amount.
  • value_type string
    The type of discount value. Valid values are:
    • fix_amount: Fixed amount discount. For example, if value is 10 in CNY, it means a discount of 10 yuan.
    • percentage: Percentage-based discount. For example, if value is 10, it means 10% off of the order amount.
  • gift_card boolean
    Whether the product is a gift card.
    • true: gift card
    • false: not a gift card
  • grams double
    The weight of the product in grams(g).
    Example: 100
  • line_price double
    Line item price. The amount is calculated by multiplying the product's selling price by quantity. The value is rounded to two decimal places and displayed in the currency corresponding to presentment_currency.
  • presentment_title string
    The title of the current product.
    Example: 8.00
  • price double
    The price of the products, rounded to two decimal places and displayed in the currency corresponding to presentment_currency.
  • product_id string
    The unique identifier for the product.
    Example: 16060214426601453066501487
  • propertiesobject[]
    A list of product customization information.
  • name string
    Custom attribute name.
  • show boolean
    Whether the customized information is visible.
    • true: visible
    • false: not visible
  • urls array
    URL list.
    • If type is picture, thumbnails are retrieved via the urls values.
    • If type is link, the hyperlink is the first URL in the urls values.
  • value string
    Custom attribute value.
  • quantity integer
    Quantity of items in the order.
  • requires_shipping boolean
    Indicates whether the product is subject to shipping.
    • true: Shipping is required.
    • false: Shipping is not required.
  • sku string
    Product SKU serial number.
    Example: 18065562457702740835053185
  • tax_linesobject[]
    A list of tax information.
  • price double
    The tax amount, rounded to two decimal places and displayed in the currency corresponding to presentment_currency.
    Example: 8
  • tax_no string
    The tax identification number.
    Example: 385642
  • title string
    The title for the tax description, for display only.
  • type string
    Order tax type. Valid values are:
    • product_tax: product tax
    • shipping_tax: shipping tax
    • duty_tax: duty tax
  • taxable boolean
    Whether the product is subject to tax.
    • true: Tax is required.
    • false: No tax is required.
  • title string
    The title of the product.
  • user_id string
    Buyer's ID.
    Example: 4603327877
  • variant_id string
    The unique identifier for the variant.
  • variant_price double
    The price of the product, rounded to two decimal places and displayed in the currency corresponding to presentment_currency.
    Example: 8
  • name string
    The string formed by concatenating a # with the unique checkout credential.
    Example: #c2c4a7b1e182e894f6e194a99489f870
  • note string
    Buyer's note.
  • note_attributesobject[]
    Information added by the merchant to the checkout.
  • name string
    The name of the custom attribute.
  • value string
    The value of the custom attribute.
  • phone string
    The user's contact phone number.
  • phone_area_code string
    The international dialing code for the phone number.
    Example: +1
  • presentment_currency string
    Currency of the current checkout. If the merchant has set up the multi-market currency, it refers to the currency of the corresponding market for the checkout; otherwise, it is the store's currency. It is a three-letter currency code following the ISO 4217 international standard.
    Example: USD
  • shipping_addressobject
    The address used for receiving packages.
  • address1 string
    The first line of the address. This typically includes information such as the street address or a post office box number.
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
  • city string
    The city in the address.
    Example: New York
  • country string
    The country or region in the address.
    Example: USA
  • country_code string
    A two-letter country or region code that follows the ISO 3166-1 standard, used to identify a specific country or region in the address.
    Example: US
  • first_name string
    The first name of the recipient.
  • last_name string
    The last name of the recipient.
  • name string
    The full name of the recipient.
  • phone string
    The phone number of the recipient.
  • province string
    The province in the address.
    Example: California
  • province_code string
    The code for the province in the address, which can be a custom code or a two-character ISO 3166-2 international code.
    Example: 4200006
  • zip string
    The postal code information of the address.
    Example: 92503
  • shipping_linesobject[]
    A list of shipping fees.
  • code string
    Returns Local delivery only for local shipping methods.
  • delivery_name string
    The name of the shipping fee plan.
  • delivery_seq string
    The delivery method ID.
    Example: DP7026099381353365514
  • logistics_amount double
    The shipping fee amount. The value is rounded to two decimal places and displayed in the currency corresponding to presentment_currency.
    Example: 8
  • phone string
    Buyer's phone.
  • sub_total_price double
    The discounted price of the product. The value is rounded to two decimal places and displayed in the currency corresponding to presentment_currency.
    Example: 8
  • taxes_included boolean
    Whether the order includes a tax amount.
    • true: tax amount included
    • false: tax amount not included
  • token string
    The unique credential for the checkout.
    Example: c2c4a7b1e182e894f6e194a99489f870
  • total_discount string
    The total discount amount. The value is rounded to two decimal places and displayed in the currency corresponding to presentment_currency.
  • total_duties string
    The total tariff amount. The value is rounded to two decimal places and displayed in the currency corresponding to presentment_currency.
    Example: 8.00
  • total_price double
    The total discounted order amount, including shipping fees and taxes. The value is rounded to two decimal places and displayed in the currency corresponding to presentment_currency.
  • total_tax string
    The total tax amount of the order. The value is rounded to two decimal places and displayed in the currency corresponding to presentment_currency.
    Example: 8.00
  • total_weight double
    The total weight of the products, in grams (g).
  • update_at string
    The date and time when the checkout was updated. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • user_id string
    Buyer's ID.
    Example: 4603327877
Status Codes
After receiving a webhook notification from SHOPLINE, you must respond with the following format:
HTTP/1.1 200 OK
For more information about how to subscribe to webhooks and webhook response rules, refer to Webhook overview.
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.