Sign in
Coupons

Get Coupons

Returns a list of coupons.

get/v1/coupons

Query parameters

qstring
type'bonus' | 'discount' | 'free_item' | 'vc' | 'non_benefit' | 'discount_fixed' | 'discount_reward_point'
category_idstring
generated_type'campaign' | 'receipt'
limitinteger

A limit on the number of objects to be returned

A limit on the number of objects to be returned

offsetinteger

The number of objects to skip

The number of objects to skip

Response

Successful Response

discount_percentinteger

The discount percent for the coupon

bonus_percentinteger

The bonus percent for the coupon

bonus_fixedinteger nullable

The fixed bonus amount for the coupon

discount_amount_usdinteger

The discount amount in USD for the coupon

expires_atinteger

The expiration date of the coupon

applicable_item_idsstring[]

The applicable item IDs

category_idstring

The coupon category ID

min_amountinteger

Require a minimum order amount to apply the coupon

max_redemptionsinteger

Limit the number of times this code can be redeemed

max_redemptions_per_userinteger

Limit the number of times a user can redeem the coupon

is_stackable_with_bonus_couponsboolean

Allow stacking with bonus coupons

stackable_bonus_limit_percentinteger

Limit the bonus percent when stacking with bonus coupons

is_stackable_with_discount_couponsboolean

Allow stacking with discount coupons

stackable_discount_limit_percentinteger

Limit the discount percent when stacking with discount coupons

store_item_discount_limit_percentinteger

Limit the combined store item and coupon discount percent

store_item_bonus_limit_percentinteger

Limit the combined store item and coupon bonus percent

start_atinteger

The timestamp when the coupon becomes valid

end_atinteger

The timestamp when the coupon ceases to be valid

player_idsstring[]

The player IDs that can redeem the coupon

exclude_player_idsstring[]

The player IDs that cannot redeem the coupon

namestring required

The name of the coupon

codestring required

The code of the coupon

type'bonus' | 'discount' | 'free_item' | 'vc' | 'non_benefit' | 'discount_fixed' | 'discount_reward_point' required
idstring required

The unique identifier of the coupon

current_balance_usdinteger

The current balance in USD for fixed discount coupon type

Changes

Changed in 4 of the 28 revisions of this API.285

  • 1816e2044c07243See the full diff
    • ▲

      the response property ////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //// became optional for the status

      response-property-became-optional

    • ●

      added the new function enum value to the //////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new function enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new function enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new piggy_bank enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property ////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

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

  • fb9750c99d0a4See the full diff
    • ●

      for the query request parameter limit, the exclusiveMinimum was set to 1.00

      request-parameter-exclusive-min-set

    • ●

      for the query request parameter category_id, the maxLength was set to 32

      request-parameter-max-length-set

    • ●

      for the query request parameter limit, the max was set to 300.00

      request-parameter-max-set

    • ●

      for the query request parameter offset, the min was set to 0.00

      request-parameter-min-set

  • fbb6b66272c81See the full diff
    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

  • ef61f771db1d1See the full diff
    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

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