Gift card update

Event Group	Event Identification
app_memberSystem_giftCard	app_memberSystem_giftCard/challenged

When the client changes the current gift card , inform the monitor to make a gift card information update for the customer .

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 gift card after the change. Accurate to two decimal places, for example, $10.00 will return 1000.
Example: 1000
gift_card_code string

Gift card code
Example: 240acd
gift_card_expiry_date long

Gift card expiration time
Example: 1721829526566
gift_card_original_value long

The original value of gift card
Example: 10000
scene_type string

Gift card update scenario type. SELF_PURCHASE: Purchase for the customers themselves. OTHERS_SEND: Gift from others PURCHASE_PAYMENT: Customers use gift cards to pay for shopping. RETURN_INCREASE: When the merchant refunds an order, the amount used is added back to the gift card. CARD_DIABLED: The gift card is disabled.
Example: SELF_PURCHASE
store_id string

store ID
Example: 1718263946864
update_type string

Gift card update type. DECREASE: Gift card decrease INCREASE: Gift card increase
Example: DECREASE
update_value long

The absolute value of the gift card 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