# List promotions

Endpoint: GET /api/promotion
Version: v1

## Response 200 fields (application/json):

  - `Id` (integer)

  - `Name` (string)

  - `DefaultName` (string)
    Read only inherited name

  - `IsNameInherited` (boolean)

  - `SubHeader` (string)

  - `DefaultSubHeader` (string)
    Read only inherited sub header

  - `IsSubHeaderInherited` (boolean)

  - `SubDescription` (string)

  - `DefaultSubDescription` (string)
    Read only inherited sub description

  - `IsSubDescriptionInherited` (boolean)

  - `DescriptionHeader` (string)

  - `DefaultDescriptionHeader` (string)
    Read only inherited description header

  - `IsDescriptionHeaderInherited` (boolean)

  - `Description` (string)

  - `DefaultDescription` (string)
    Read only inherited description

  - `IsDescriptionInherited` (boolean)

  - `ImageKey` (string)
    Example: "00000000-0000-0000-0000-000000000000"

  - `ImageUrl` (string)
    Read only full image url at CDN

  - `Code` (string)

  - `ExclusivityType` (string)
    Exclusive promotion type: NotExclusive, Exclusive, IgnoreExclusivity. Default is NotExclusive

  - `StartDate` (string)

  - `EndDate` (string)

  - `CountLeft` (integer)
    Read only value that shows count left when AllowedUsageCount is set

  - `AllowedUsageCount` (integer)

  - `UsageCount` (integer)
    Read only value that shows how many times this promotion has been used

  - `UniqueUserUsageCount` (integer)

  - `UniqueDiscountCodeCount` (integer)
    Read only value that shows count of unique discount codes

  - `UniqueDiscountCodeUsedCount` (integer)
    Read only value that shows count of used unique discount codes

  - `TotalOrder` (number)
    Read only value that shows total order value of orders where promotion was used

  - `TotalDiscount` (number)
    Read only value that shows total order discount of orders where promotion was used

  - `DiscountPercentage` (number)
    Read only value that shows discount percentage for rows where promotion was used

  - `MarginPercentage` (number)
    Read only value that shows total order margin of orders where promotion was used

  - `IsStackable` (boolean)

  - `IsProductReq` (boolean)

  - `ExcludeFromPriceCalculation` (boolean)

  - `Status` (string)
    Promotion status: Inactive, Active, Draft. Default is Inactive

  - `CurrencyCode` (string)

  - `StoppedDate` (string)
    Read only value that shows when a promotion was inactivated

  - `StoppedBy` (integer)
    Read only value that shows who inactivated promotion

  - `StoppedByName` (string)
    Read only value that shows who inactivated promotion

  - `Created` (string)
    Read only value that shows when promotion was created

  - `CreatedByName` (string)
    Read only value that shows who created this promotion

  - `Changed` (string)
    Read only value that shows when promotion was changed

  - `ChangedBy` (string)
    Read only value that shows who changed this promotion

  - `Cultures` (array)

  - `Cultures.CultureCode` (string)

  - `Cultures.IsTranslated` (boolean)