4b69392f93b9
Get an offer by ID
To get an offer by ID, specify the ID of the offer in the {id} URI path parameter.
Path parameters
Provide the offer's identifier.
Query parameters
Provide your client identifier. The token query parameter takes precedence over apiKey.
Provide the authorized or anonymous token for a shopper. The token query parameter takes precedence over the apiKey.
Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.
Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.
Select either XML or JSON as the format for the Authorize Shopper API. The default format is XML.
Specify the preferred currency for the pricing information returned for a product. This setting only works when you provide the apiKey parameter.
Specify the preferred locale for the pricing information returned for products. This setting only works when you provide the apiKey parameter.
Bypass offer arbitration. Global Commerce default behavior is to apply best Global Commerce Merchandising offer for shopper. So if there is an offer better than the one you specified, the best offer will be applied. Set this value true to skip the Global Commerce Merchandising offer arbitration.
Response
Successful response.
Example response
{
"offer": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709",
"id": 154344709,
"name": "Home Page Security & Backup Recovery Features",
"policyName": "Semi-Tight Bundle Policy",
"type": "FeatureProducts",
"image": "https://drh1.img.digitalriver.com/DRHM/Storefront/Site/demosft1/images/promo/security_header.gif",
"trigger": "Always Triggered",
"salesPitch": [
"[\"Header Message\",\"Footer Message\",\"Sales Pitch Extra Info\",\"Sales Pitch Extra Info 2\"]"
],
"productOffers": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709/product-offers",
"productOffer": [
{
"uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709/product-offers/64358400",
"id": 64358400,
"product": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358400",
"displayName": "Class III",
"thumbnailImage": "https://drh1.img.digitalriver.com/DRHM/Storefront/Company/demosft1/images/product/thumbnail/classIIIThumb_v2.jpg"
},
"pricing": {
"listPrice": {
"currency": "USD",
"value": "19.99"
},
"salePriceWithQuantity": {
"currency": "USD",
"value": "19.99"
},
"formattedListPrice": "$39.99",
"formattedSalePriceWithQuantity": "$38.99",
"listPriceIncludesTax": "false"
}
}
]
},
"offerBundleGroups": {
"offerBundleGroup": [
{
"bundleGroupName": "Primary Group",
"bundleType": "Mandatory",
"minProductQuantity": 1,
"maxProductQuantity": 100,
"displayName": "Primary Group1",
"productOffers": {
"productOffer": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709/product-offers/64358400",
"id": 64358400,
"product": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358400",
"displayName": "Class III",
"thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/thumbnail/classIIIThumb_v2.jpg"
},
"addProductToCart": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=64578500&offerId=154344709",
"cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=64578500&offerId=154344709"
},
"salesPitch": "For testing purposes",
"image": "https://drh-sys-ora.img.digitalriver.com/Storefront/Site/demosft1/images/promo/business_header.gif",
"pricing": {
"listPrice": {
"currency": "USD",
"value": "19.99"
},
"salePriceWithQuantity": {
"currency": "USD",
"value": "19.99"
},
"formattedListPrice": "$39.99",
"formattedSalePriceWithQuantity": "$38.99",
"listPriceIncludesTax": "false"
}
}
}
}
]
}
}
}