# Get Promotion Coupon by Code

Get promotion coupon details by coupon code.
Requires the "VIEW" role in the "Promotion" group.

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

## Query parameters:

  - `Code` (string, required)
    Promotion Coupon Code
    Example: 889977

## Response 200 fields (application/json):

  - `Code` (string)
    Coupon code
    Example: "889977"

  - `Limit` (integer)
    Coupon limit
    Example: 10

  - `Balance` (integer)
    Coupon balance
    Example: 5

  - `Discount` (integer)
    Coupon discount
    Example: 10

  - `Created` (string)
    Coupon created time
    Example: "2019-12-17T14:58:15.447"

  - `StartDate` (string)
    Coupon start time
    Example: "2019-12-17T14:58:15.447"

  - `ExpiryDate` (string)
    Coupon expiry time
    Example: "2019-12-19T00:00:00"

  - `Type` (string)
    Coupon type
    Example: "Discount"

  - `Description` (string)
    Coupon description
    Example: "Discount percentage 99%"

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

  - `RequirementType` (string)
    Type of requirement for this coupon. If this property not set, the coupon will be available for all items.
    Enum: "Variant", "Category"

  - `ListRequirementVariants` (array)
    List of variants that required for this coupon
    Example: [{"Code":"S0001","UnitPrice":100000},{"Code":"TS001","UnitPrice":200000}]

  - `ListRequirementVariants.Code` (string)
    Code of the variant

  - `ListRequirementVariants.UnitPrice` (number)
    Unit price of the variant

  - `ListRequirementCategories` (array)
    List of categories that required for this coupon
    Example: []

  - `ListRequirementCategories.CatergoryID` (string)
    ID of the category

  - `ListRequirementCategories.CategoryName` (string)
    Name of the category

  - `MultipleItemRequirementDiscount` (integer)
    If set to true, the coupon can be used for multiple items (0 = All, 1 = OneOf, 2 = One of First Quantity)

## Response 400 fields (application/json):

  - `Message` (string)