Retrieve all CouponCodes related to this Coupon

GET 
/coupon/:guid/codes

Retrieve all CouponCodes related to a Coupon. The CouponCodes are the objects that are actually applied to the applied to type of the Coupon to get discount.

Request

Path Parameters

guid stringrequired

The guid of the Coupon to get the CouponCodes from.

Responses

200

CouponCodes found.

application/json

Schema

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.

• ]

Example (from schema)

[
  {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "coupon_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "code": "string",
    "applies_to_count": 1,
    "used_amount": 0
  }
]

404

Coupon not found.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

Loading...