Skip to main content
GET
cURL

Coupon Configurations

This API call retrieves your coupon configurations, including details about how coupons are structured, authenticated, and mapped within Gameball.
Security: Provide both apikey and secretkey headers.

Authorizations

apikey
string
header
required
secretkey
string
header
required

Response

200 - application/json

Coupon configurations retrieved successfully

url
string

The URL where the coupon configuration is applied.

Example:

"https://api.mywebsite.com/coupons"

method
string

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

Example:

"POST"

queryParams
object[]

List of query parameters used in the request.

headers
object[]

List of headers used in the request.

payload
string

The request payload format or template.

Example:

"{ \"couponCode\": \"DISCOUNT10\" }"

couponMapping
object

A dictionary mapping coupon types to specific keys in your system.

enableFreeProduct
boolean

Indicates whether free product coupons are enabled.

Example:

true

enableFixedRate
boolean

Indicates whether fixed-rate discount coupons are enabled.

Example:

true

enableFreeShipping
boolean

Indicates whether free shipping coupons are enabled.

Example:

true

enablePercentage
boolean

Indicates whether percentage-based discount coupons are enabled.

Example:

true

platforms
object[]

List of platforms for which the coupon configurations are applied.