Gets the promotion list by query type and parameters.
The following example shows how to gets the promotion list by query type and parameters.
Request
GET /wcs/resources/store/10101/promotion?q=byName%26qName=promotionName HTTP/1.1
Host: testserver.mycompany.com
Content-Type: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"Promotion": [
{
"Description": [
{
"longDescription": "To all customers who've successfully purchased from us, come back and save $5.00 on your next order.",
"shortDescription": "Repeat customers save $5.00 USD"
}
],
"administrativeName": "Discount for Repeat Customers",
"description": [
{
"language": "-1",
"longDescription": "To all customers who've successfully purchased from us, come back and save $5.00 on your next order.",
"shortDescription": "Repeat customers save $5.00 USD",
"userData": {
"userDataField": [
{
"key": "custom1",
"value": "\""
},
{
"key": "custom2",
"value": "\""
},
{
"key": "custom3",
"value": "\""
},
{
"key": "custom4",
"value": "\""
},
{
"key": "custom5",
"value": "\""
},
{
"key": "admin",
"value": "Order Discount - Customers in the Repeat customer segment receive $5.00 of their next order"
}
]
}
}
],
"promotionId": "10000002",
"promotionName": "Discount for Repeat Customers",
"promotionType": "OrderLevelValueDiscount",
"resourceId": "https:\/\/testserver.mycompany.com\/wcs\/resources\/store\/10001\/promotion10000002",
"schdule": {
"dailyEndTime": "15:59:59.000",
"dailyStartTime": "16:00:00.000",
"endDate": "2999-12-30T16:00:00.000Z",
"startDate": "2003-12-31T16:00:00.000Z",
"weekDays": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"status": "Inactive"
},
{
"Description": [
{
"longDescription": "Use US Regular shipping and pay only $5 for shipping for your entire order.",
"shortDescription": "Flat $5 US-Regular shipping!"
}
],
"administrativeName": "Flat Shipping",
"description": [
{
"language": "-1",
"longDescription": "Use US Regular shipping and pay only $5 for shipping for your entire order.",
"shortDescription": "Flat $5 US-Regular shipping!",
"userData": {
"userDataField": [
{
"key": "custom1",
"value": "\""
},
{
"key": "custom2",
"value": "\""
},
{
"key": "custom3",
"value": "\""
},
{
"key": "custom4",
"value": "\""
},
{
"key": "custom5",
"value": "\""
},
{
"key": "admin",
"value": "Shipping discount"
}
]
}
}
],
"promotionId": "10000006",
"promotionName": "Flat Shipping",
"promotionType": "OrderLevelFixedShippingDiscount",
"resourceId": "https:\/\/testserver.mycompany.com\/wcs\/resources\/store\/10001\/promotion10000006",
"schdule": {
"dailyEndTime": "15:59:59.000",
"dailyStartTime": "16:00:00.000",
"endDate": "2999-12-30T16:00:00.000Z",
"startDate": "2003-12-31T16:00:00.000Z",
"weekDays": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"status": "Inactive"
},
{
"Description": [
{
"longDescription": "Free Ground Shipping on orders over $70.",
"shortDescription": "Free Ground Shipping!"
}
],
"administrativeName": "Free Ground Shipping",
"description": [
{
"language": "-1",
"longDescription": "Free Ground Shipping on orders over $70.",
"shortDescription": "Free Ground Shipping!",
"userData": {
"userDataField": [
{
"key": "custom1",
"value": "\""
},
{
"key": "custom2",
"value": "\""
},
{
"key": "custom3",
"value": "\""
},
{
"key": "custom4",
"value": "\""
},
{
"key": "custom5",
"value": "\""
},
{
"key": "admin",
"value": "Shipping Discount - Free Ground Delivery when you buy more than $70 USD"
}
]
}
}
],
"promotionId": "10000001",
"promotionName": "Free Ground Shipping",
"promotionType": "OrderLevelFixedShippingDiscount",
"resourceId": "https:\/\/testserver.mycompany.com\/wcs\/resources\/store\/10001\/promotion10000001",
"schdule": {
"dailyEndTime": "15:59:59.000",
"dailyStartTime": "16:00:00.000",
"endDate": "2999-12-30T16:00:00.000Z",
"startDate": "2003-12-31T16:00:00.000Z",
"weekDays": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"status": "Inactive"
},
{
"Description": [
{
"longDescription": "Save 20% on all Furniture items! No restrictions!",
"shortDescription": "Save 20% on Furniture!"
}
],
"administrativeName": "Furniture Category Discount",
"description": [
{
"language": "-1",
"longDescription": "Save 20% on all Furniture items! No restrictions!",
"shortDescription": "Save 20% on Furniture!",
"userData": {
"userDataField": [
{
"key": "custom1",
"value": "\""
},
{
"key": "custom2",
"value": "\""
},
{
"key": "custom3",
"value": "\""
},
{
"key": "custom4",
"value": "\""
},
{
"key": "custom5",
"value": "\""
},
{
"key": "admin",
"value": "Category Discount - Save 20% on Furniture"
}
]
}
}
],
"promotionId": "10000007",
"promotionName": "Furniture Category Discount",
"promotionType": "CategoryLevelPercentDiscount",
"resourceId": "https:\/\/testserver.mycompany.com\/wcs\/resources\/store\/10001\/promotion10000007",
"schdule": {
"dailyEndTime": "15:59:59.000",
"dailyStartTime": "16:00:00.000",
"endDate": "2999-12-30T16:00:00.000Z",
"startDate": "2003-12-31T16:00:00.000Z",
"weekDays": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"status": "Active"
},
{
"Description": [
{
"longDescription": "Register with us today and save 7% on your next order.",
"shortDescription": "Register today and save 7%."
}
],
"administrativeName": "Register and Save",
"description": [
{
"language": "-1",
"longDescription": "Register with us today and save 7% on your next order.",
"shortDescription": "Register today and save 7%.",
"userData": {
"userDataField": [
{
"key": "custom1",
"value": "\""
},
{
"key": "custom2",
"value": "\""
},
{
"key": "custom3",
"value": "\""
},
{
"key": "custom4",
"value": "\""
},
{
"key": "custom5",
"value": "\""
},
{
"key": "admin",
"value": "Order Discount - Promotion code for Registered customers to save 7% on their next order"
}
]
}
}
],
"promotionId": "10000003",
"promotionName": "Register and Save",
"promotionType": "OrderLevelPercentDiscount",
"resourceId": "https:\/\/testserver.mycompany.com\/wcs\/resources\/store\/10001\/promotion10000003",
"schdule": {
"dailyEndTime": "15:59:59.000",
"dailyStartTime": "16:00:00.000",
"endDate": "2999-12-30T16:00:00.000Z",
"startDate": "2003-12-31T16:00:00.000Z",
"weekDays": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"status": "Inactive"
},
{
"Description": [
{
"longDescription": "Save $25 on all orders over $200 USD.",
"shortDescription": "Save $25 on all orders over $200 USD"
}
],
"administrativeName": "Save $25 on all orders over $200 USD",
"description": [
{
"language": "-1",
"longDescription": "Save $25 on all orders over $200 USD.",
"shortDescription": "Save $25 on all orders over $200 USD",
"userData": {
"userDataField": [
{
"key": "custom1",
"value": "\""
},
{
"key": "custom2",
"value": "\""
},
{
"key": "custom3",
"value": "\""
},
{
"key": "custom4",
"value": "\""
},
{
"key": "custom5",
"value": "\""
},
{
"key": "admin",
"value": "Save $25 on all orders before Saturday"
}
]
}
}
],
"promotionId": "10000005",
"promotionName": "Save $25 on all orders over $200 USD",
"promotionType": "OrderLevelValueDiscount",
"resourceId": "https:\/\/testserver.mycompany.com\/wcs\/resources\/store\/10001\/promotion10000005",
"schdule": {
"dailyEndTime": "15:59:59.000",
"dailyStartTime": "16:00:00.000",
"endDate": "2999-12-30T16:00:00.000Z",
"startDate": "2003-12-31T16:00:00.000Z",
"weekDays": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"status": "Inactive"
},
{
"Description": [
{
"longDescription": "Save 10% on all orders.",
"shortDescription": "Save 10% on all orders"
}
],
"administrativeName": "Save 10% on all orders today",
"description": [
{
"language": "-1",
"longDescription": "Save 10% on all orders.",
"shortDescription": "Save 10% on all orders",
"userData": {
"userDataField": [
{
"key": "custom1",
"value": "\""
},
{
"key": "custom2",
"value": "\""
},
{
"key": "custom3",
"value": "\""
},
{
"key": "custom4",
"value": "\""
},
{
"key": "custom5",
"value": "\""
},
{
"key": "admin",
"value": "Save 10% on all orders today"
}
]
}
}
],
"promotionId": "10000004",
"promotionName": "Save 10% on all orders today",
"promotionType": "OrderLevelPercentDiscount",
"resourceId": "https:\/\/testserver.mycompany.com\/wcs\/resources\/store\/10001\/promotion10000004",
"schdule": {
"dailyEndTime": "15:59:59.000",
"dailyStartTime": "16:00:00.000",
"endDate": "2999-12-30T16:00:00.000Z",
"startDate": "2003-12-31T16:00:00.000Z",
"weekDays": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"status": "Inactive"
},
{
"administrativeName": "testCoupon",
"promotionId": "10000151",
"promotionName": "testCoupon-10000151",
"promotionType": "OrderLevelPercentDiscount",
"resourceId": "https:\/\/testserver.mycompany.com\/wcs\/resources\/store\/10001\/promotion10000151",
"schdule": {
"dailyEndTime": "23:59:59.999",
"dailyStartTime": "00:00:00.001",
"endDate": "9999-12-31T23:59:59.999Z",
"startDate": "2013-10-07T16:00:00.000Z",
"weekDays": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"status": "Active"
},
{
"administrativeName": "testPromoCode",
"promotionId": "10000651",
"promotionName": "testPromoCode-10000651",
"promotionType": "OrderLevelValueDiscount",
"resourceId": "https:\/\/testserver.mycompany.com\/wcs\/resources\/store\/10001\/promotion10000651",
"schdule": {
"dailyEndTime": "23:59:59.999",
"dailyStartTime": "00:00:00.001",
"endDate": "9999-12-31T23:59:59.999Z",
"startDate": "2013-10-07T16:00:00.000Z",
"weekDays": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"status": "Active"
},
{
"Description": [
{
"longDescription": "",
"shortDescription": ""
}
],
"administrativeName": "testpromotion",
"description": [
{
"language": "-1",
"longDescription": "",
"shortDescription": "",
"userData": {
"userDataField": [
]
}
}
],
"promotionId": "10001151",
"promotionName": "testpromotion-10001151",
"promotionType": "CategoryLevelValueDiscount",
"resourceId": "https:\/\/testserver.mycompany.com\/wcs\/resources\/store\/10001\/promotion10001151",
"schdule": {
"dailyEndTime": "23:59:59.999",
"dailyStartTime": "00:00:00.001",
"endDate": "9999-12-31T23:59:59.999Z",
"startDate": "2013-10-09T16:00:00.000Z",
"weekDays": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"status": "Active"
}
],
"recordSetComplete": "true",
"recordSetCount": "10",
"recordSetStartNumber": "0",
"recordSetTotal": "10",
"resourceId": "https:\/\/testserver.mycompany.com\/wcs\/resources\/store\/10001\/promotion",
"resourceName": "promotion"
}