# List Promotion Coupons

Get a list of promotion coupons.
Requires the "VIEW" role in the "Promotion" group.

Endpoint: GET /api/v3/PromotionCoupon
Version: 3.1.0
Security: OAuth2_clientCredentials

## Query parameters:

  - `PageNumber` (number, required)
    The number of page data to be displayed
    Example: 1

  - `PageSize` (number, required)
    The number of rows returned by the API
    Example: 10

  - `From` (string)
    Start date of Created Promotion Coupon
    Example: "2019-12-01T00:00:00"

  - `To` (string)
    To date of Created Promotion Coupon
    Example: "2019-12-19T00:00:00"

  - `Type` (string)
    Type of promotion coupon
    Enum: "DiscountPercentage", "DiscountAmount", "ParkedDeletion", "Return", "FullAccess"

  - `UsageStatus` (string)
    Status Coupon usage (If value null it will show only Active Coupon)
    Enum: "Active", "Used", "Expired", "All"

  - `CustomerCode` (string)
    The customer code that assigned to the coupon
    Example: "DP-001"

  - `Code` (string)
    Promotion coupon code
    Example: "Disc99"

## Response 200 fields (application/json):

  - `Code` (string)
    Promotion Coupon Code

  - `Limit` (integer)
    the usage limit of the promotion coupon key

  - `Balance` (integer)
    Remaining balance of the promotion coupon key

  - `Discount` (integer)
    the discount applied of the promotion coupon

  - `Created` (string)
    the promotion coupon created time

  - `StartDate` (string)
    Started Date of Promotion Coupon

  - `ExpiryDate` (string)
    the promotion coupon expiry date

  - `Type` (string)
    the promotion coupon discount type

  - `MinimumSpending` (number)
    Minimum spending amount that allow to use the coupon code. Only for Type DiscountAmount and DiscountPercentage.

  - `Description` (string)
    Description of promotion coupon

  - `CustomerCode` (string)
    Code of Customer (Member Code)

  - `ReferenceID` (string)
    ID of Customer Reffered By

  - `CustomerID` (string)
    Customer ID of the customer assigned to this Coupon.


## Response 400 fields

## Response 500 fields