Build Version:

GET promotions

Gets a list of promotions.

Request Information

» Expands

Name	Description	Usage
portal	This will retrieve the related list of portals.	GET promotions?expand=portal
profiles	This will retrieve the related list of profiles.	GET promotions?expand=profiles
promotionType	This will retrieve the related promotion type.	GET promotions?expand=promotiontype

» Filters

Name	Description	Usage
accountId	This will filter the request by account ID.	GET promotions?filter=accountid~{operator}~{value}
catalogId	This will filter the request by catalog ID.	GET promotions?filter=catalogid~{operator}~{value}
categoryId	This will filter the request by category ID.	GET promotions?filter=categoryid~{operator}~{value}
discount	This will filter the request by discount.	GET promotions?filter=discount~{operator}~{value}
discountedProductId	This will filter the request by discounted product ID.	GET promotions?filter=discountedproductid~{operator}~{value}
endDate	This will filter the request by end date.	GET promotions?filter=enddate~{operator}~{value}
externalId	This will filter the request by external ID.	GET promotions?filter=externalid~{operator}~{value}
manufacturerId	This will filter the request by manufacturer ID.	GET promotions?filter=manufacturerid~{operator}~{value}
name	This will filter the request by name.	GET promotions?filter=name~{operator}~{value}
portalId	This will filter the request by portal ID.	GET promotions?filter=portalid~{operator}~{value}
profileId	This will filter the request by profile ID.	GET promotions?filter=profileid~{operator}~{value}
promotionTypeId	This will filter the request by promotion type ID.	GET promotions?filter=promotiontypeid~{operator}~{value}
requiredProductId	This will filter the request by required product ID.	GET promotions?filter=requiredproductid~{operator}~{value}
startDate	This will filter the request by start date.	GET promotions?filter=startdate~{operator}~{value}

» Sorting

Name	Description	Usage
discount	This will sort the response by discount.	GET promotions?sort=discount
displayOrder	This will sort the response by display order.	GET promotions?sort=displayorder
endDate	This will sort the response by end date.	GET promotions?sort=enddate
name	This will sort the response by name.	GET promotions?sort=name
promotionId	This will sort the response by promotion ID.	GET promotions?sort=promotionid
startDate	This will sort the response by start date.	GET promotions?sort=startdate

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET promotions?page=index~{value}
size	The size of the page when retrieving paged results.	GET promotions?page=size~{value}

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.

application/json

Sample:

	{
  "Promotions": [
    {
      "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.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.0,
      "SkuId": null,
      "StartDate": "2013-08-01T00:00:00",
      "IsCouponAllowedWithOtherCoupons": false
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}