Retrieve the Gift-With-Purchase choices
get
/ccstore/v1/orders/getGiftWithPurchaseChoices
Retrieve all of the products and skus available for selection for a 'Gift With Purchase' promotion
Request
Supported Media Types
- application/json
Query Parameters
-
giftWithPurchaseDetail: string
The gift detail of the free gift. This is typically a product or a sku ID
-
giftWithPurchaseType: string
The gift type of the free gift. For example product or sku
Header Parameters
-
X-CCAsset-Language(optional): string
Instructs the endpoint to use the specified locale code for content returned in the response. The locale supplied in the header must be supported by your store.
-
X-CCOrganization(optional): string
Current organization context of the logged in user
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : getGiftWithPurchaseChoices_response
Type:
Show Source
object
-
product(optional):
object product
The details of the product.
-
skus(optional):
array skus
list of gift options
Nested Schema : product
Type:
object
The details of the product.
Show Source
-
active(optional):
boolean
Product active property
-
ancestorCategories(optional):
array ancestorCategories
Array of category objects.
-
ancestorCategoryIds(optional):
array ancestorCategoryIds
ancestor category ids
-
arrivalDate(optional):
string
arrival date of the product
-
assetable(optional):
boolean
Flag that defines whether a product is assetable or not.
-
auxiliaryMedia(optional):
string
auxiliary media
-
avgCustRating(optional):
number
average customer rating for the product
-
brand(optional):
string
brand of the product
-
childSKUs(optional):
array childSKUs
List of SKU's for the product
-
creationDate(optional):
string
product creation date
-
custRatingCount(optional):
integer
total count of the customer rating for the product
-
dateAvailable(optional):
string
available date
-
daysAvailable(optional):
integer
available number of days
-
derivedCatalogs(optional):
array derivedCatalogs
Derived Catalogs.
-
description(optional):
string
description of the product
-
discountable(optional):
boolean
Product discountable property
-
displayName(optional):
string
display name of the product
-
dynamicRelatedProducts(optional):
string
dynamic related products
-
dynamicUpsellProducts(optional):
string
dynamic upsell products
-
endDate(optional):
string
end date
-
fullImageURLs(optional):
array fullImageURLs
full image url paths
-
height(optional):
number
height of the product
-
id(optional):
string
ID of the product
-
itemAcl(optional):
string
item acl
-
keywords(optional):
array keywords
keywords for the product
-
largeImage(optional):
string
large image url path of the product
-
largeImageURLs(optional):
array largeImageURLs
large image urls
-
length(optional):
number
length of the product
-
listPrice(optional):
number
list price of the product
-
listPrices(optional):
object listPrices
list prices of the product in respective price list groups
-
longDescription(optional):
string
long description of the product
-
mediumImageURLs(optional):
array mediumImageURLs
medium image urls path
-
onlineOnly(optional):
boolean
online only property
-
orderable(optional):
string
orderable property
-
orderLimit(optional):
integer
order limit
-
parentCategory(optional):
string
parent category of the product
-
primaryFullImageURL(optional):
string
primary full image url path
-
primaryLargeImageURL(optional):
string
primary large image url path
-
primaryMediumImageURL(optional):
string
primary medium image url path
-
primarySmallImageURL(optional):
string
primary small image url path
-
primarySourceImageURL(optional):
string
primary source image url path
-
primaryThumbImageURL(optional):
string
primary thumb image url path
-
productImages(optional):
array productImages
Details of the product images
-
productVariantOptions(optional):
array productVariantOptions
Objects containing product's variant options details if available for the product.
- relatedProductGroup(optional): string
- relatedProducts(optional): string
-
repositoryId(optional):
string
repository ID of the product
-
route(optional):
string
route of the product
-
salePrice(optional):
string
sale price of the product
-
salePriceEndDate(optional):
string
sale price end date of the product
-
salePrices(optional):
object salePrices
sale prices of the product in respective price list groups
-
salePriceStartDate(optional):
string
start date of the product's sale price
-
seoDescriptionDerived(optional):
string
Derived from display name and description of the product.
-
seoKeywordsDerived(optional):
string
Derived from display name and ancestor category name's of the product.
-
seoMetaInfo(optional):
object seoMetaInfo
Seo meta info for product.
-
seoTitleDerived(optional):
string
Derived from display name of the product.
-
shippingSurcharge(optional):
number
Extra handling costs for shipping the product.
-
shippingSurcharges(optional):
object shippingSurcharges
Extra handling costs for shipping the product in respective price list groups
-
skuOptionsInfo(optional):
string
Sku options info
-
smallImage(optional):
string
small image path of the product
-
smallImageURLs(optional):
array smallImageURLs
small image url paths
-
sourceImageURLs(optional):
array sourceImageURLs
source image urls of the product
-
startDate(optional):
string
start date
-
taxCode(optional):
string
tax code of the product
-
template(optional):
string
template
-
thumbImageURLs(optional):
array thumbImageURLs
thumb image urls of the product
-
type(optional):
string
type of the product
-
upsellProductGroup(optional):
string
upsell product group
-
upsellProducts(optional):
string
upsell products
-
variantValuesOrder(optional):
object variantValuesOrder
Object having various variant property as key and ordered values array as the value.
-
version(optional):
string
version of the product
-
weight(optional):
number
weight
-
width(optional):
number
width of the product
Nested Schema : listPrices
Type:
object
list prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
list price of the product in plg1
-
plg2(optional):
number
list price of the product in plg2
Nested Schema : productVariantOptions
Type:
array
Objects containing product's variant options details if available for the product.
Show Source
Nested Schema : salePrices
Type:
object
sale prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
sale price of the product in plg1
-
plg2(optional):
number
sale price of the product in plg2
Nested Schema : seoMetaInfo
Type:
object
Seo meta info for product.
Show Source
-
repositoryId(optional):
string
Repository ID of seo metadata.
-
seoDescription(optional):
string
Description of category.
-
seoKeywords(optional):
string
Keywords of category.
-
seoTitle(optional):
string
Title of category.
Nested Schema : shippingSurcharges
Type:
object
Extra handling costs for shipping the product in respective price list groups
Show Source
-
plg1(optional):
number
Extra handling costs for shipping the product in plg1
-
plg2(optional):
number
Extra handling costs for shipping the product in plg2
Nested Schema : variantValuesOrder
Type:
object
Object having various variant property as key and ordered values array as the value.
Show Source
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
Repository ID of ancestor child category.
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
SKU active property
-
fullImageURLs(optional):
array fullImageURLs
Full Image URLs of SKU.
-
largeImage(optional):
string
large image path of the SKU
-
largeImageURLs(optional):
array largeImageURLs
Large Image URLs of SKU.
-
listPrice(optional):
number
list price of the SKU
-
listPrices(optional):
object listPrices
list prices of the SKU in respective price list groups
-
mediumImageURLs(optional):
array mediumImageURLs
Medium Image URLs SKU.
-
primaryLargeImageURL(optional):
string
Primary Large Image URL of SKU.
-
primaryMediumImageURL(optional):
string
Primary Medium Image URL ID of SKU.
-
primarySmallImageURL(optional):
string
Primary Small Image URL of SKU.
-
primarySourceImageURL(optional):
string
Primary Source Image URL of SKU.
-
primaryThumbImageURL(optional):
string
Primary Source Image URL of SKU.
-
quantity(optional):
integer
quantity of the SKU
-
repositoryId(optional):
string
repository ID of the child SKU
-
salePrice(optional):
number
sale price of the SKU.
-
salePriceEndDate(optional):
string
sale price end date of the SKU
-
salePrices(optional):
object salePrices
sale prices of the SKU in respective price list groups
-
salePriceStartDate(optional):
string
sale price start date of the SKU.
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
-
shippingSurcharges(optional):
object shippingSurcharges
Extra handling costs for shipping the product in respective price list groups
-
smallImage(optional):
string
small image path of the product
-
smallImageURLs(optional):
array smallImageURLs
Small Image URLs of SKU.
-
sourceImageURLs(optional):
array sourceImageURLs
Source Image URLs of SKU.
-
thumbImageURLs(optional):
array thumbImageURLs
Thumb Image URLs of SKU.
-
thumbnailImage(optional):
string
thumbnail image path of the product
Nested Schema : listPrices
Type:
object
list prices of the SKU in respective price list groups
Show Source
-
plg1(optional):
number
list price of the SKU in plg1
-
plg2(optional):
number
list price of the SKU in plg2
Nested Schema : salePrices
Type:
object
sale prices of the SKU in respective price list groups
Show Source
-
plg1(optional):
number
sale price of the SKU in plg1
-
plg2(optional):
number
sale price of the SKU in plg2
Nested Schema : shippingSurcharges
Type:
object
Extra handling costs for shipping the product in respective price list groups
Show Source
-
plg1(optional):
number
Extra handling costs for shipping the product in plg1
-
plg2(optional):
number
Extra handling costs for shipping the product in plg2
Nested Schema : items
Type:
Show Source
object
-
name(optional):
string
Image name
-
path(optional):
string
image path
-
repositoryId(optional):
string
repository ID of the image
-
url(optional):
string
url path of the image
Nested Schema : items
Type:
Show Source
object
-
mapKeyPropertyAttribute(optional):
string
map key property
-
optionId(optional):
string
option ID
-
optionName(optional):
string
option Name
-
optionValueMap(optional):
object optionValueMap
Additional Properties Allowed: additionalPropertiesmapping of all option values with corresponding option value ids
Nested Schema : optionValueMap
Type:
object
Additional Properties Allowed
Show Source
mapping of all option values with corresponding option value ids
Show Source
-
optionValue(optional):
string
Option Value
-
optionValueId(optional):
integer
Option Value ID
Nested Schema : items
Type:
Show Source
object
-
fullImageURLs(optional):
array fullImageURLs
Full Image URLs of SKU.
-
largeImage(optional):
string
large image path of the SKU
-
largeImageURLs(optional):
array largeImageURLs
Large Image URLs of SKU.
-
listPrice(optional):
number
list price of the SKU
-
listPrices(optional):
object listPrices
list prices of the SKU in respective price list groups
-
mediumImageURLs(optional):
array mediumImageURLs
Medium Image URLs SKU.
-
primaryLargeImageURL(optional):
string
Primary Large Image URL of SKU.
-
primaryMediumImageURL(optional):
string
Primary Medium Image URL ID of SKU.
-
primarySmallImageURL(optional):
string
Primary Small Image URL of SKU.
-
primarySourceImageURL(optional):
string
Primary Source Image URL of SKU.
-
primaryThumbImageURL(optional):
string
Primary Source Image URL of SKU.
-
quantity(optional):
integer
quantity of the SKU
-
repositoryId(optional):
string
repository ID of the child SKU
-
salePrice(optional):
number
sale price of the SKU.
-
salePriceEndDate(optional):
string
sale price end date of the SKU
-
salePrices(optional):
object salePrices
sale prices of the SKU in respective price list groups
-
salePriceStartDate(optional):
string
sale price start date of the SKU.
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
-
shippingSurcharges(optional):
object shippingSurcharges
Extra handling costs for shipping the product in respective price list groups
-
smallImage(optional):
string
small image path of the product
-
smallImageURLs(optional):
array smallImageURLs
Small Image URLs of SKU.
-
sourceImageURLs(optional):
array sourceImageURLs
Source Image URLs of SKU.
-
thumbImageURLs(optional):
array thumbImageURLs
Thumb Image URLs of SKU.
-
thumbnailImage(optional):
string
thumbnail image path of the product
Nested Schema : listPrices
Type:
object
list prices of the SKU in respective price list groups
Show Source
-
plg1(optional):
number
list price of the SKU in plg1
-
plg2(optional):
number
list price of the SKU in plg2
Nested Schema : salePrices
Type:
object
sale prices of the SKU in respective price list groups
Show Source
-
plg1(optional):
number
sale price of the SKU in plg1
-
plg2(optional):
number
sale price of the SKU in plg2
Nested Schema : shippingSurcharges
Type:
object
Extra handling costs for shipping the product in respective price list groups
Show Source
-
plg1(optional):
number
Extra handling costs for shipping the product in plg1
-
plg2(optional):
number
Extra handling costs for shipping the product in plg2
Example Response (application/json)
{
"product":[
{
"dynamicPropertyMapLong":{
},
"largeImage":null,
"smallImage":null,
"upsellProductGroup":null,
"keywords":[
],
"endDate":null,
"derivedCatalogs":[
],
"custRatingCount":null,
"orderable":null,
"relatedProducts":null,
"orderLimit":null,
"onlineOnly":false,
"listPrices":null,
"dynamicUpsellProducts":null,
"type":null,
"seoMetaInfo":{
"seoDescription":"Vineyard Antique Arm Chair,Hand-carved walnut",
"repositoryId":"100003",
"seoTitle":"Vineyard Antique Arm Chair",
"seoKeywords":"Vineyard Antique Arm Chair,Dining Chairs,Lighting and Decor"
},
"largeImageURLs":[
"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=940&width=940"
],
"ancestorCategoryIds":[
],
"productInfos":{
},
"id":"xprod2119",
"brand":"Fisher's Colony",
"salePriceEndDate":null,
"height":null,
"defaultProductListingSku":null,
"assetable":false,
"primaryMediumImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=475&width=475",
"seoKeywordsDerived":"Vineyard Antique Arm Chair,Dining Chairs,Lighting and Decor",
"skuOptionsInfo":null,
"dynamicPropertyMapBigString":{
},
"active":true,
"weight":null,
"thumbImageURLs":[
"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=100&width=100"
],
"taxCode":"PC030100",
"creationDate":"2014-10-27T05:11:57.034Z",
"version":2,
"arrivalDate":null,
"route":"/vineyard-antique-arm-chair/product/xprod2119",
"catalogs":[
],
"mediumImageURLs":[
"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=475&width=475"
],
"primarySourceImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=300&width=300",
"parentCategory":null,
"primarySmallImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=300&width=300",
"sourceImageURLs":[
"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=300&width=300"
],
"avgCustRating":null,
"startDate":null,
"longDescription":"This 18th century antique reproduction arm chair features hand-carved walnut and spring cushion base. Upholstered in buttery soft print textile with a lovely vintage pattern.",
"template":null,
"primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=100&width=100",
"displayName":"Vineyard Antique Arm Chair",
"seoDescriptionDerived":"Vineyard Antique Arm Chair,Hand-carved walnut",
"description":"Hand-carved walnut",
"primaryFullImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg",
"salePrices":null,
"seoTitleDerived":"Vineyard Antique Arm Chair",
"productVariantOptions":[
{
"optionValueMap":{
"Silver":1,
"Neon":2,
"Black":0
},
"optionId":"color",
"mapKeyPropertyAttribute":"sku-camcorder_color",
"optionName":"color"
}
],
"primaryLargeImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=940&width=940",
"smallImageURLs":[
"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=300&width=300"
],
"itemAcl":null,
"shippingSurcharges":null,
"displayableSkuAttributes":[
],
"dynamicPropertyMapString":{
},
"siteIds":[
],
"thumbnailImage":null,
"discountable":true,
"computedCatalogs":[
],
"childSKUs":[
{
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"listPrices":null,
"salePrices":null,
"primaryFullImageURL":null,
"productListingSku":null,
"largeImageURLs":[
],
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"shippingSurcharges":null,
"thumbnailImage":null,
"salePriceEndDate":null,
"salePriceStartDate":null,
"images":[
],
"quantity":11,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"active":true,
"thumbImageURLs":[
],
"mediumImageURLs":[
],
"repositoryId":"xsku2119",
"shippingSurcharge":null,
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":219
}
],
"salePriceStartDate":null,
"catalogsRelatedProducts":[
],
"fixedRelatedProducts":[
],
"salePrice":null,
"fullImageURLs":[
"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg"
],
"length":null,
"upsellProducts":null,
"productImages":[
{
"path":"/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg",
"name":"/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg",
"repositoryId":"img_xprod2119_0",
"url":"http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg"
}
],
"variantValuesOrder":{
"color":[
"Spring Green",
"Cranberry",
"Marigold"
],
"size":[
"Small",
"Large",
"Medium"
]
},
"relatedProductGroup":null,
"auxiliaryMedia":{
},
"dateAvailable":"2014-10-27T05:11:57.034Z",
"width":null,
"repositoryId":"xprod2119",
"shippingSurcharge":null,
"ancestorCategories":[
],
"daysAvailable":0,
"dynamicPropertyMapDouble":{
},
"listPrice":219,
"dynamicRelatedProducts":null,
"fixedUpsellProducts":[
]
}
],
"skus":[
{
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"listPrices":null,
"salePrices":null,
"primaryFullImageURL":null,
"productListingSku":null,
"largeImageURLs":[
],
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"shippingSurcharges":null,
"thumbnailImage":null,
"salePriceEndDate":null,
"salePriceStartDate":null,
"images":[
],
"quantity":11,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"thumbImageURLs":[
],
"mediumImageURLs":[
],
"repositoryId":"xsku2119",
"shippingSurcharge":null,
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":219
}
]
}
Default Response
The error response:
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code