Store Credits Update

Event Group	Event Identification
app_memberSystem_shoppingCredit	app_memberSystem_shoppingCredit/challenged

When the customer's current store credits change, inform the monitoring party to update the corresponding customer's store credits information.

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

buyer_id string

Customer id
Example: 2404721679
current_balance long

The balance of store credits after the change. Accurate to two decimal places, for example, $10.00 will return 1000.
Example: 1000
store_credits_code string

Store credits code
Example: 2404721679455
store_credits_expiry_date long

Store credits expiration time
Example: 1721829526566
store_credits_update_reason string

Store credits update reason types. ● refund: Refund. ● transfer: Transfer. ● reward: Reward. ● compensation: Compensation. ● other: Other.
Example: refund
store_id string

store ID
Example: 1718263946864
update_type string

Store credits update type. DECREASE: Store credits decrease INCREASE: Store credits increase
Example: INCREASE
update_value long

The absolute value of the store credit amount for this update. Accurate to two decimal places, for example, $10.00 will return 1000.
Example: 1000
updated_at long

Update time
Example: 1721829526566

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

Legal

Privacy