Sign in

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
}

Changes

Changed in 3 of the 38 revisions of this API.14

  • d43ca6bdac5a3See the full diff
    • ○

      the endpoint scheme security apiKey AND secretKey was added to the API

      api-security-added

    • ○

      the endpoint scheme security apiKey was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security secretKey was removed from the API

      api-security-removed

  • 7887186517671See the full diff
    • ○

      endpoint added

      endpoint-added

  • 919eb7a392aa1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 38 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog