Where to find coupon and promo code data in GetOrder, GetPayments, and item.add webhook

Coupon and promo code information is available in the order APIs and related webhooks.

Supported endpoints and webhooks

You can access coupon data in:

• GetOrder

• GetPayments

• Corresponding webhooks, including item.add

item.add webhook field path

In the item.add webhook payload, coupons are available at:

event_data.context.order.coupons

Coupon object structure

Each coupon in the coupons array includes the following fields:

• id

• code

• name

• type

• discount_percent

• bonus_percent

• bonus_fixed

If you need the promo code string used at checkout (for example, WHATSAPP20), use the code field.

Example

"coupons": [
  {
    "id": "cpn_eGGhmqBXdWu",
    "code": "SH65",
    "name": "Shekhar",
    "type": "non_benefit",
    "discount_percent": null,
    "bonus_percent": null,
    "bonus_fixed": null
  }
]

Note about older behavior

Previously, coupon information was not exposed for paid orders in item.add and GetOrder. This is now live in the APIs and corresponding webhooks.