Sign in

v36

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-017439390.7 KB

This API call retrieves your coupon configurations, including details about how coupons are structured, authenticated, and mapped within Gameball.

get/api/v4.0/integrations/configurations/coupon

Response

Coupon configurations retrieved successfully

urlstring

The URL where the coupon configuration is applied.

methodstring

The HTTP method used for the coupon configuration process (e.g., POST, PUT or GET).

payloadstring

The request payload format or template.

enableFreeProductboolean

Indicates whether free product coupons are enabled.

enableFixedRateboolean

Indicates whether fixed-rate discount coupons are enabled.

enableFreeShippingboolean

Indicates whether free shipping coupons are enabled.

enablePercentageboolean

Indicates whether percentage-based discount coupons are enabled.

Example response

{
  "url": "https://api.mywebsite.com/coupons",
  "method": "POST",
  "queryParams": [
    {
      "key": "appId",
      "value": "12345"
    }
  ],
  "headers": [
    {
      "key": "Authorization",
      "value": "Bearer token"
    }
  ],
  "payload": "{ \"couponCode\": \"DISCOUNT10\" }",
  "couponMapping": {
    "fixed": "fixed_discount",
    "percentage": "percentage_discount",
    "freeProduct": "free_product",
    "freeShipping": "free_delivery"
  },
  "enableFreeProduct": true,
  "enableFixedRate": true,
  "enableFreeShipping": true,
  "enablePercentage": true
}