Cart create

Webhookcart/create

Triggered when an item is added to the cart.

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

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

cart object
created_atstring
Cart creation time
currency_codestring
Currency code
discount_applications object[]
Cart-level discount details
Array [
apply_methodstring
Application method for automatic-activity lines
codestring
Discount code (present only for discount-code activities)
discount_amountnumber
Discount amount
discount_idstring
Discount ID
discount_messagestring
Discount prompt text
discount_textstring
Discount text (may be the title or a label)
discount_typestring
Discount-code discount type: percentage or fixed amount (discount codes only)
entitled_product_listundefined[]
List of products the discount applies to
extentsobject
Extension fields (string-to-string key-value pairs; keys vary)
extents.application_timestring
Application time
extents.business_custom_datastring
Business-defined custom data
extents.discount_apply_typestring
Discount application type
extents.discount_codestring
Discount code
extents.discount_rule_infostring
Discount rule information
extents.old_discount_idstring
Legacy discount ID
extents.use_with_otherstring
Whether the discount can be combined with others
iconstring
Icon
is_free_giftboolean
Whether the entitled-product list are free gifts
messagestring
Input-box prompt text
propertiesstring
Additional discount-code fields
statusstring
Discount-code application status: success (applied), undetermined (pending), fail (not applied)
subtypestring
Marketing-activity subtype: discount_rebate (spend-threshold discount), discount_code (discount code), discount_coupon (coupon), discount_flashsale (flash sale), automatic (automatic discount), buy_x_get_y (buy X get Y)
target_selectionstring
Discount target selection method
target_typestring
Discount target: shipping_line (shipping), line_item (line item), payment_line (payment method)
titlestring
Discount name
typestring
Marketing-activity type: discount_rebate (spend-threshold discount), discount_code (discount code), discount_coupon (coupon), discount_flashsale (flash sale), automatic (automatic discount)
value_typestring
Discount value type
]
extra object
Additional information about the cart change
client_idstring
Client ID
item_countinteger
Number of items
line_items object[]
List of items in the cart
Array [
add_quantitystring
Quantity added
availableboolean
Whether the product is available for sale
available_quantityinteger
Available quantity
can_buyboolean
Whether the item can be purchased
compare_at_pricestring
Compare-at (strikethrough) unit price
cost_pricestring
Cost price
customboolean
Whether this is a custom line item
discount_applications object[]
Discount details for this line item
Array [
allocation_methodstring
Allocation method
codestring
Discount code
discount_amountstring
Discount amount
discount_idstring
Discount ID
discount_quantityinteger
Discounted quantity
discount_textstring
Discount text (may be the title or a label)
discount_typestring
Discount-code discount type
extentsobject
Extension fields (key-value pairs; keys vary)
extents.business_custom_datastring
Business-defined custom data
extents.old_discount_idstring
Legacy discount ID
extents.raw_input_line_item_pricestring
Raw input line item price
groupsundefined[]
Discount application groups
iconstring
Icon
is_free_giftboolean
Whether this product list are free gifts
is_need_splitboolean
Whether splitting is allowed
subtypestring
Marketing-activity subtype (values as listed under discount_applications)
target_selectionstring
Discount target selection method
target_typestring
Discount target (values as listed under discount_applications)
titlestring
Discount name
total_discount_amountstring
Total discount amount
typestring
Marketing-activity type (values as listed under discount_applications)
valuestring
Discount value
value_typestring
Discount value type
]
discount_totalstring
Total discount amount
final_line_pricestring
Final line price
final_pricestring
Final unit price
fixed_discount_totalstring
Fixed discount total
idstring
Cart line item ID
imageobject
Product image
image.heightinteger
Image height
image.pathstring
Image path
image.srcstring
Image URL
image.widthinteger
Image width
inventory_policystring
Inventory policy (continue: keep selling when out of stock / deny: stop selling when out of stock / auto_unpublished: auto-unpublish when out of stock)
inventory_quantityinteger
Inventory quantity
inventory_trackingboolean
Whether inventory tracking is enabled
item_idstring
Item ID
line_pricestring
Line price
mixed_wholesaleboolean
Whether mixed wholesale is supported
options object[]
List of product option attributes
Array [
namestring
Option name
valuestring
Option value
]
origin_pricestring
Original price
original_line_pricenumber
Original line price
parts_pricestring
Parts price
pricestring
Selling unit price
product_handlestring
Product handle
product_idstring
Product ID
product_tagsundefined[]
Product tags
product_titlestring
Product title
product_typestring
Product type
product_urlstring
Product URL
propertiesstring
Product option properties (key-value pairs)
publishedboolean
Whether the product is published (listed)
published_atstring
Product publish time
quantitystring
Purchase quantity
requires_shippingboolean
Whether shipping is required
retail_pricestring
Retail price
saved_priceinteger
Amount saved
skustring
Variant SKU
taxableboolean
Whether the item is taxable
trunk_pricestring
Trunk price
variant_idstring
Variant ID
variant_titlestring
Variant title
vendorstring
Vendor
weightstring
Product weight
weight_unitstring
Weight unit
wholesale_price object[]
Wholesale prices (list)
Array [
min_quantityinteger
Minimum quantity
pricestring
Price
]
]
total_discountstring
Total discount amount of the cart
total_pricestring
Total amount of items in the cart
updated_atstring
Cart update time
user_idstring
User ID
user_signstring
User signature (guest identifier)

{
  "cart": {
    "created_at": "string",
    "currency_code": "string",
    "discount_applications": [
      {
        "apply_method": "string",
        "code": "string",
        "discount_amount": 0,
        "discount_id": "string",
        "discount_message": "string",
        "discount_text": "string",
        "discount_type": "string",
        "entitled_product_list": [
          null
        ],
        "extents": {},
        "extents.application_time": "string",
        "extents.business_custom_data": "string",
        "extents.discount_apply_type": "string",
        "extents.discount_code": "string",
        "extents.discount_rule_info": "string",
        "extents.old_discount_id": "string",
        "extents.use_with_other": "string",
        "icon": "string",
        "is_free_gift": true,
        "message": "string",
        "properties": "string",
        "status": "string",
        "subtype": "string",
        "target_selection": "string",
        "target_type": "string",
        "title": "string",
        "type": "string",
        "value_type": "string"
      }
    ],
    "extra": {
      "client_id": "string"
    },
    "item_count": 0,
    "line_items": [
      {
        "add_quantity": "string",
        "available": true,
        "available_quantity": 0,
        "can_buy": true,
        "compare_at_price": "string",
        "cost_price": "string",
        "custom": true,
        "discount_applications": [
          {
            "allocation_method": "string",
            "code": "string",
            "discount_amount": "string",
            "discount_id": "string",
            "discount_quantity": 0,
            "discount_text": "string",
            "discount_type": "string",
            "extents": {},
            "extents.business_custom_data": "string",
            "extents.old_discount_id": "string",
            "extents.raw_input_line_item_price": "string",
            "groups": [
              null
            ],
            "icon": "string",
            "is_free_gift": true,
            "is_need_split": true,
            "subtype": "string",
            "target_selection": "string",
            "target_type": "string",
            "title": "string",
            "total_discount_amount": "string",
            "type": "string",
            "value": "string",
            "value_type": "string"
          }
        ],
        "discount_total": "string",
        "final_line_price": "string",
        "final_price": "string",
        "fixed_discount_total": "string",
        "id": "string",
        "image": {},
        "image.height": 0,
        "image.path": "string",
        "image.src": "string",
        "image.width": 0,
        "inventory_policy": "string",
        "inventory_quantity": 0,
        "inventory_tracking": true,
        "item_id": "string",
        "line_price": "string",
        "mixed_wholesale": true,
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "origin_price": "string",
        "original_line_price": 0,
        "parts_price": "string",
        "price": "string",
        "product_handle": "string",
        "product_id": "string",
        "product_tags": [
          null
        ],
        "product_title": "string",
        "product_type": "string",
        "product_url": "string",
        "properties": "string",
        "published": true,
        "published_at": "string",
        "quantity": "string",
        "requires_shipping": true,
        "retail_price": "string",
        "saved_price": 0,
        "sku": "string",
        "taxable": true,
        "trunk_price": "string",
        "variant_id": "string",
        "variant_title": "string",
        "vendor": "string",
        "weight": "string",
        "weight_unit": "string",
        "wholesale_price": [
          {
            "min_quantity": 0,
            "price": "string"
          }
        ]
      }
    ],
    "total_discount": "string",
    "total_price": "string",
    "updated_at": "string",
    "user_id": "string",
    "user_sign": "string"
  }
}

Request headers​

Request body​

Request headers

Request body