Abandoned order attribution

Event Group	Event Identification
abandoned_order_attribution	abandoned_order_attribution/create

The order abandonment message will be sent once the conversion information has been calculated. Please be aware that in some instances, due to a large volume of data or network delays, SHOPLINE may need to recalculate the attribution information for the abandoned order. Once the recalculation is finished, the abandoned order will be reissued/pushed again.

Request Headers

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

abandonedOrderSeq string

Abandon order sequence number.
Example: 21059478554517401789150705
actionType string

Event type , currently only support : create
Example: create
firstInteractRefererUrl string

The first interaction source URL within a 30-day period before the abandoned order was created. Users may have interacted with your store by entering from various off-site platforms or by clicking on different ads.
Example: www.facebook.com
firstInteractSource string

The name of the user's initial interaction source channel within a 30-day period before the abandoned order was created.
Example: Direct
firstInteractTime string

The time when the user generated the initial interaction, recorded in GMT+8:00 district, within a 30-day period before the abandoned order was created.
Example: 2023-05-23T20:53:25.199
firstInteractUrl string

The landing page URL that generated the initial interaction within a 30-day period before the user abandoned the order.
Example: www.facebook.com
isOffline string

For offline data or not.
Example: false
key string

Message distribution key.
Example: 21059478554517401789150705
lastInteractRefererUrl string

The last interactive source url within 30 days of successful order . users will have an interaction from different station outside platforms , or by clicking on different advertising to your store .
Example: www.facebook.com
lastInteractSource string

The last interaction source within a 30-day period before the user abandoned the order.
Example: Direct
lastInteractTime string

The time of the last interaction, recorded in GMT+8:00 district, within a 30-day period before the user abandoned the order.
Example: 2023-05-23T20:53:25.199
lastInteractUrl string

The landing page URL corresponds to the last interaction that occurred within a 30-day period before the user abandoned the order.
Example: www.facebook.com
storeId string

store ID.
Example: 1637826610248

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

Legal