GET CMPromotions?SiteID={SiteID}&PackageId={PackageId}

Returns All Promotions From The Site

Request Information

URI Parameters

Name	Type	Description	Additional information
SiteID	integer
PackageId	integer	Optional: leave null and the method Package/GetLatestPackageForSite will be used to determine packageid	None.

Body Parameters

None.

Response Information

Resource Description

CMPromoCatalogue

Name	Type	Additional information
SiteId	integer	None.
PackageId	integer	None.
CMPromo	Collection of CMPromoModel	None.

Response Formats

application/json, text/json

Sample:

{
  "SiteId": 1,
  "PackageId": 2,
  "CMPromo": [
    {
      "CMPromoID": 1,
      "CMPackageID": 2,
      "Name": "sample string 3",
      "PromoType": 4,
      "Value": 5.1,
      "FirePriority": 6,
      "CMPriceGroupID": 1,
      "StartDate": "2026-10-18T23:12:48.0495128",
      "EndDate": "2026-10-18T23:12:48.0495128",
      "CMPromoGroupModels": [
        {
          "CMPromoGroupID": 1,
          "CMPromoID": 2,
          "IsInput": true,
          "TriggerQty": 4,
          "ActionValue": 5.1,
          "PromoBuilderConfig": "sample string 6",
          "CMPromoGroupProducts": [
            {
              "CMPromoGroupProductID": 1,
              "CMPromoGroupID": 2,
              "CMProductMeasureID": 3,
              "CMProductID": 4,
              "CMMeasureID": 5
            },
            {
              "CMPromoGroupProductID": 1,
              "CMPromoGroupID": 2,
              "CMProductMeasureID": 3,
              "CMProductID": 4,
              "CMMeasureID": 5
            }
          ]
        },
        {
          "CMPromoGroupID": 1,
          "CMPromoID": 2,
          "IsInput": true,
          "TriggerQty": 4,
          "ActionValue": 5.1,
          "PromoBuilderConfig": "sample string 6",
          "CMPromoGroupProducts": [
            {
              "CMPromoGroupProductID": 1,
              "CMPromoGroupID": 2,
              "CMProductMeasureID": 3,
              "CMProductID": 4,
              "CMMeasureID": 5
            },
            {
              "CMPromoGroupProductID": 1,
              "CMPromoGroupID": 2,
              "CMProductMeasureID": 3,
              "CMProductID": 4,
              "CMMeasureID": 5
            }
          ]
        }
      ],
      "CMPromoGroupSchedules": [
        {
          "CMPromoScheduleID": 1,
          "CMPromoID": 2,
          "Weekday": 3,
          "StartTime": "00:00:00.1234567",
          "EndTime": "00:00:00.1234567"
        },
        {
          "CMPromoScheduleID": 1,
          "CMPromoID": 2,
          "Weekday": 3,
          "StartTime": "00:00:00.1234567",
          "EndTime": "00:00:00.1234567"
        }
      ]
    },
    {
      "CMPromoID": 1,
      "CMPackageID": 2,
      "Name": "sample string 3",
      "PromoType": 4,
      "Value": 5.1,
      "FirePriority": 6,
      "CMPriceGroupID": 1,
      "StartDate": "2026-10-18T23:12:48.0495128",
      "EndDate": "2026-10-18T23:12:48.0495128",
      "CMPromoGroupModels": [
        {
          "CMPromoGroupID": 1,
          "CMPromoID": 2,
          "IsInput": true,
          "TriggerQty": 4,
          "ActionValue": 5.1,
          "PromoBuilderConfig": "sample string 6",
          "CMPromoGroupProducts": [
            {
              "CMPromoGroupProductID": 1,
              "CMPromoGroupID": 2,
              "CMProductMeasureID": 3,
              "CMProductID": 4,
              "CMMeasureID": 5
            },
            {
              "CMPromoGroupProductID": 1,
              "CMPromoGroupID": 2,
              "CMProductMeasureID": 3,
              "CMProductID": 4,
              "CMMeasureID": 5
            }
          ]
        },
        {
          "CMPromoGroupID": 1,
          "CMPromoID": 2,
          "IsInput": true,
          "TriggerQty": 4,
          "ActionValue": 5.1,
          "PromoBuilderConfig": "sample string 6",
          "CMPromoGroupProducts": [
            {
              "CMPromoGroupProductID": 1,
              "CMPromoGroupID": 2,
              "CMProductMeasureID": 3,
              "CMProductID": 4,
              "CMMeasureID": 5
            },
            {
              "CMPromoGroupProductID": 1,
              "CMPromoGroupID": 2,
              "CMProductMeasureID": 3,
              "CMProductID": 4,
              "CMMeasureID": 5
            }
          ]
        }
      ],
      "CMPromoGroupSchedules": [
        {
          "CMPromoScheduleID": 1,
          "CMPromoID": 2,
          "Weekday": 3,
          "StartTime": "00:00:00.1234567",
          "EndTime": "00:00:00.1234567"
        },
        {
          "CMPromoScheduleID": 1,
          "CMPromoID": 2,
          "Weekday": 3,
          "StartTime": "00:00:00.1234567",
          "EndTime": "00:00:00.1234567"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

System.Xml.XmlDocument