1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Store
  4. Orders

getGiftWithPurchaseChoices

get

/ccstore/v1/orders/getGiftWithPurchaseChoices

Get Gift With Purchase Choices. Get all of the products and skus available for selection for a gift with purchase gift. Optionally takes the x-ccasset-language headers to get translated content in another language. Also it can have optional X-CCOrganization header which is a JSON field to specify current Organization context of logged in user.

Request

Supported Media Types
  • application/json
Query Parameters
giftWithPurchaseDetail
Type: string
Required: true
the gift detail of the free gift. This is typically a product or a sku Id
giftWithPurchaseType
Type: string
Required: true
the gift type of the free gift. For example product or sku
Header Parameters
X-CCOrganization
Type: string
Current organization context of the logged in user

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getGiftWithPurchaseChoices_response
Nested Schema : product
Type: object
The details of the product.
Nested Schema : skus
Type: array
list of gift options
Nested Schema : ancestorCategories
Type: array
Array of category objects.
Nested Schema : ancestorCategoryIds
Type: array
ancestor category ids
Nested Schema : childSKUs
Type: array
List of SKU's for the product
Nested Schema : derivedCatalogs
Type: array
Derived Catalogs.
Nested Schema : fullImageURLs
Type: array
full image url paths
Nested Schema : keywords
Type: array
keywords for the product
Nested Schema : largeImageURLs
Type: array
large image urls
Nested Schema : listPrices
Type: object
list prices of the product in respective price list groups
Nested Schema : mediumImageURLs
Type: array
medium image urls path
Nested Schema : productImages
Type: array
Details of the product images
Nested Schema : productVariantOptions
Type: array
Objects containing product's variant options details if available for the product.
Nested Schema : salePrices
Type: object
sale prices of the product in respective price list groups
Nested Schema : seoMetaInfo
Type: object
Seo meta info for product.
Nested Schema : shippingSurcharges
Type: object
Extra handling costs for shipping the product in respective price list groups
Nested Schema : smallImageURLs
Type: array
small image url paths
Nested Schema : sourceImageURLs
Type: array
source image urls of the product
Nested Schema : thumbImageURLs
Type: array
thumb image urls of the product
Nested Schema : variantValuesOrder
Type: object
Object having various variant property as key and ordered values array as the value.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : fullImageURLs
Type: array
Full Image URLs of SKU.
Nested Schema : largeImageURLs
Type: array
Large Image URLs of SKU.
Nested Schema : listPrices
Type: object
list prices of the SKU in respective price list groups
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs SKU.
Nested Schema : salePrices
Type: object
sale prices of the SKU in respective price list groups
Nested Schema : shippingSurcharges
Type: object
Extra handling costs for shipping the product in respective price list groups
Nested Schema : smallImageURLs
Type: array
Small Image URLs of SKU.
Nested Schema : sourceImageURLs
Type: array
Source Image URLs of SKU.
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of SKU.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : optionValueMap
Type: object
mapping of all option values with corresponding option value ids
Nested Schema : items
Type: object
Nested Schema : fullImageURLs
Type: array
Full Image URLs of SKU.
Nested Schema : largeImageURLs
Type: array
Large Image URLs of SKU.
Nested Schema : listPrices
Type: object
list prices of the SKU in respective price list groups
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs SKU.
Nested Schema : salePrices
Type: object
sale prices of the SKU in respective price list groups
Nested Schema : shippingSurcharges
Type: object
Extra handling costs for shipping the product in respective price list groups
Nested Schema : smallImageURLs
Type: array
Small Image URLs of SKU.
Nested Schema : sourceImageURLs
Type: array
Source Image URLs of SKU.
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of SKU.
Example 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,
            "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,
            "parentCategoriesForCatalog":{
            },
            "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
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{
  "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,
    "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,
    "parentCategoriesForCatalog": {},
    "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
  }]
}