Gift card

WEBHOOK GiftCardRequested

Example

{
  "topic": "giftcard",
  "trigger": "giftcard.requested",
  "id": 12345,
  "total_credit_issued": "23.50",
  "gift_card_subtotal": "25.00",
  "gift_card_tax": "0.50",
  "gift_card_bonus_credit": "1.00",
  "currency": "USD",
  "return_id": 23456,
  "email": "[e-mail]",
  "first_name": "Eliza",
  "last_name": "Strawberry",
  "external_order_id": 1234567890,
  "external_order_name": "#2234",
  "external_order_number": 1234,
  "presentment": {
    "total_credit_issued": "23.50",
    "gift_card_subtotal": "25.00",
    "gift_card_tax": "0.50",
    "gift_card_bonus_credit": "1.00",
    "currency": "CAD"
  }
}

For Shopify-native gift card issuance, Loop can also write gift card details to a Shopify order metafield. See Shopify Gift Card Order Metafield.

Body

application/json

topic · string

Webhook type

Example:

"giftcard"

trigger · string

Event that triggered the webhook

Example:

"giftcard.requested"

id · integer | null

Loop gift card ID, null in the case of auto out-of-stock gift cards

Example:

12345

total_credit_issued · string

Total credit issued

Example:

"23.50"

gift_card_subtotal · string

Gift card value minus taxes and bonus

Example:

"25.00"

gift_card_tax · string

Gift card tax applied, "0.00" if no taxes applied

Example:

"0.50"

gift_card_bonus_credit · string

Gift card bonus credit applied, "0.00" if no bonus applied

Example:

"1.00"

currency · string

Currency of the gift card values

Example:

"USD"

return_id · integer

Loop return ID

Example:

23456

email · string<email>

Customer email address

Example:

"[e-mail]"

first_name · string

Customer first name

Example:

"Eliza"

last_name · string

Customer last name

Example:

"Strawberry"

external_order_id · integer

External order ID

Example:

1234567890

external_order_name · string

External order name

Example:

"#2234"

external_order_number · integer | null

External order number

Example:

1234

presentment · object

Gift card credit values reported in the customer-facing (presentment) currency.

Show child attributes

Response

200

Return a 200 status to indicate that the data was received successfully