GET promotions/{promotionId}

Gets a promotion.

Request Information

» Parameters

Name Description Additional information
promotionId The ID of the promotion.

Define this parameter in the request URI.

» Expands

Name Description Usage
promotionType This will retrieve the related promotion type. GET promotions/{promotionId}?expand=promotiontype

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

  "Promotion": {
    "AccountId": null,
    "AddOnValueId": null,
    "CatalogId": 4,
    "CategoryId": 86,
    "CouponCode": "",
    "CouponQuantityAvailable": 0,
    "Custom1": "",
    "Custom2": "",
    "Custom3": "",
    "Description": "Applies a percent off order",
    "Discount": 10.00,
    "DiscountedProductId": null,
    "DiscountedProductQuantity": 0,
    "DisplayOrder": 1,
    "EnableCouponUrl": false,
    "EndDate": "2013-08-31T00:00:00",
    "ExternalId": "",
    "HasCoupon": false,
    "ManufacturerId": 3,
    "MinimumOrderAmount": 0.00,
    "Name": "Percent Off Order",
    "PortalId": 7,
    "ProfileId": 5,
    "PromoCode": "AUG2013",
    "PromotionId": 13,
    "PromotionMessage": "Good through August 31, 2013",
    "PromotionType": {
      "ClassName": "ZnodeCartPromotionAmountOffProduct",
      "ClassType": "CART",
      "Description": "Applies an amount off a product for an order; affects the shopping cart.",
      "IsActive": true,
      "Name": "Amount Off Product",
      "PromotionTypeId": 6,
      "UserType": null
    "StoreName": null,
    "Profile": null,
    "PromotionTypeId": 6,
    "RequiredProductId": 552,
    "RequiredProductMinimumQuantity": 1,
    "SkuId": null,
    "StartDate": "2013-08-01T00:00:00"
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false