Skip to main content

Add CouponCodes to a Coupon

PUT 
/coupon/:guid/codes

Add CouponCodes to a Coupon. The applies_to_count and usage_count properties can be set globally or per CouponCode. Using the global settings can be combined with the per CouponCode settings, then all the CouponCodes that do not have individual settings will inherit the global settings.

The CouponCodes are the actual codes that the visitors will fill in on Orders to get discount. This also holds the information about how many times the CouponCode can be used. To which type the CouponCode applies and the discount the CouponCode gives are determined by its Coupon, which is its description.

Request​

Path Parameters

    guid stringrequired

    The guid of the Coupon to add the CouponCodes to.

Body

Input data

    codes

    object[]

  • Array [

    • code stringrequired

    Possible values: >= 4 characters

    The actual code.

    applies_to_count integer

    Possible values: >= 1 and <= 9999999999

    Default value: 1

    The maximum number of times this CouponCode can be applied within a single Order.

  • ]

    • applies_to_count integer

    Possible values: >= 1 and <= 9999999999

    Default value: 1

    The maximum number of times this CouponCode can be applied within a single Order.

Responses​

The created CouponCodes.

Schema

  • Array [

    • guid uuidrequired

    The guid of the CouponCode.

    company_id uuid

    The guid of the Company associated with the CouponCode.

    coupon_guid uuidrequired

    The guid of the Coupon (Campaign) the CouponCode belongs to.

    code stringrequired

    Possible values: >= 4 characters

    The actual code.

    applies_to_count integer

    Possible values: >= 1 and <= 9999999999

    Default value: 1

    The maximum number of times this CouponCode can be applied within a single Order.

    used_amount float

    The amount of monetary value for which this CouponCode is used.

  • ]

Loading...