LogoLogo
Shopper APIs reference
Shopper APIs reference
  • Shopper APIs reference
  • OAuth
    • Tokens
    • Access tokens
  • Shoppers
    • Shoppers
    • Addresses
    • Payment options
  • Browse (product discovery)
    • Categories
    • Products
    • Product variations
    • Pricing
    • Inventory status
    • Financing
    • Offers
    • Purchase plan
    • Find a purchase plan
    • Authorize a purchase plan
  • Cart
    • Apply a shopper to a cart
    • Line items
    • Billing address
    • Shipping address
    • Payment methods
    • Shipping options
    • Web checkout
    • Submit a cart
    • Apply or detach payment methods
    • Apply a shipping option
    • Carts
    • Cart offers
    • API trigger offer
    • Resume cart
    • Third-party subscription engine
    • Tax registration
    • Price override
  • Orders
    • Orders
    • Order lookup
    • Order address
    • Returns
  • Subscriptions
    • Manage a subscription
    • Manage the subscription's renewal plan
    • Immediate midterm change
    • Payment
    • Address
    • Orders
    • Pending actions
    • Retrieve subscriptions
    • Subscription billing and shipping addresses
Powered by GitBook
On this page
  1. Browse (product discovery)

Offers

PreviousFinancingNextPurchase plan

Last updated 10 months ago

Get an offer by ID

get

To get an offer by ID, specify the ID of the offer in the {id} URI path parameter.

Path parameters
offerIdstringRequired

Provide the offer's identifier.

Query parameters
apiKeystringOptional

Provide your client identifier. The token query parameter takes precedence over apiKey.

tokenstringOptional

Provide the authorized or anonymous token for a shopper. The token query parameter takes precedence over the apiKey.

expandstringOptional

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.

fieldsstringOptional

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.

formatstringOptional

Select either XML or JSON as the format for the Authorize Shopper API. The default format is XML.

currencystringOptional

Specify the preferred currency for the pricing information returned for a product. This setting only works when you provide the apiKey parameter.

localestringOptional

Specify the preferred locale for the pricing information returned for products. This setting only works when you provide the apiKey parameter.

skipOfferArbitrationbooleanOptional

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.

Responses
200
Successful response.
application/json
Responseone of
or
401
* Invalid Token
application/json
404
* resource-not-found
application/json
get
GET /v1/shoppers/me/offers/{offerId} HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "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"
          }
        }
      ]
    },
    "categoryOffers": {},
    "offerBundleGroups": {
      "offerBundleGroup": [
        {
          "bundleGroupName": "Primary Group",
          "bundleType": "Mandatory",
          "minProductQuantity": 1,
          "maxProductQuantity": 100,
          "displayName": "Primary Group1",
          "description": "text",
          "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"
              }
            }
          }
        }
      ]
    }
  }
}

Get the product for the offer

get

To get the specific product for the specific offer, specify the offer ID in the {offerId} URI path parameter, and product ID in {productOfferId}. This API is incapable of retrieving information for Custom Bundle offer.

Path parameters
offerIdstringRequired

Provide the offer's identifier to limit the response to the products that are eligible for the offer.

productOfferIdstringRequired

Provide the product identifer. You must use the productId parameter with the offerId parameter. When you use these two parameters together, only the specified product appears in the response. You can only provide one product identifier. Multiple product identifiers are not supported.

Query parameters
apiKeystringOptional

Provide your client identifier. The token query parameter takes precedence over the apiKey.

tokenstringOptional

Provide the authorized or anonymous token for a shopper. The token query parameter takes precedence over the apiKey.

expandstringOptional

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.

fieldsstringOptional

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.

formatstringOptional

Override the default format of XML for the Authorize Shopper API. Valid values are XML and JSON.

currencystringOptional

Set the preferred currency for the pricing information returned for a product. Only works when using apiKey parameter.

localestringOptional

Set the preferred locale for the pricing information returned for products. Only works when using apiKey parameter.

skipOfferArbitrationbooleanOptional

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.

Responses
200
Successful response.
application/json
Responseone of
or
401
* Invalid Token * resource-not-found
application/json
get
GET /v1/shoppers/me/offers/{offerId}/product-offers/{productOfferId} HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "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"
    }
  }
}

Retrieve all offers for a product

get

To retrieve all available deals for a particular product, specify the ID of the product in the first {id} URI path parameter. The retrieved offers include:

  • All Always Triggered offers
  • All triggered and untriggered Promotional URL / External Triggered Offers
  • All triggered and untriggered Coupon Code Offers
Path parameters
productIdstringRequired

Provide the product identifier.

Query parameters
apiKeystringOptional

Provide your client identifier. The token query parameter takes precedence over apiKey.

tokenstringOptional

Provide the authorized or anonymous token for a shopper. The token query parameter takes precedence over the apiKey.

expandstringOptional

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.

fieldsstringOptional

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.

pageNumberstringOptional

Specify the page to display from the result pages.

pageSizestringOptional

Specify the maximum number of items to include in each page.

formatstringOptional

Override the default format of XML for the Authorize Shopper API. Valid values are XML and JSON.

currencystringOptional

Set the preferred currency for the pricing information returned for a product. Only works when using apiKey parameter.

localestringOptional

Set the preferred locale for the pricing information returned for products. Only works when using apiKey parameter.

skipOfferArbitrationbooleanOptional

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.

Responses
200
Successful response.
application/json
Responseone of
or
401
* Invalid Token
application/json
get
GET /v1/shoppers/me/products/{productId}/offers HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "offers": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/offers",
    "offer": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709",
        "name": "Home Page Security & Backup Recovery Features",
        "trigger": "Always Triggered",
        "productOffers": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709/product-offers"
        },
        "categoryOffers": {},
        "offerBundleGroups": {
          "offerBundleGroup": [
            {
              "bundleGroupName": "Primary Group",
              "bundleType": "Mandatory",
              "minProductQuantity": 1,
              "maxProductQuantity": 100,
              "displayName": "Primary Group1",
              "description": "text",
              "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"
                  }
                }
              }
            }
          ]
        }
      }
    ],
    "totalResults": 1,
    "totalResultPages": 1
  }
}

Retrieve all offers for a given POP for a product

get

To retrieve all offers for a given point-of-promotion (POP) for a product:

  1. Specify the product ID in the first {id} URI path parameter.
  2. Specify the point-of-promotion (POP) name in the second {popName} URI path parameter.

The retrieved offers include:

  • All Always Triggered offers
  • All Promotional URL / External Triggered Offers) even if it’s not triggered

The retrieved offers do not include the following:

  • Coupon Code offers, even the coupon code offer, have been triggered
Path parameters
productIdstringRequired

Provide the product identifier.

popNamestringRequired

Provide the name of the point of Promotion (POP).

Query parameters
apiKeystringOptional

Provide your client identifier. The token query parameter takes precedence over apiKey.

tokenstringOptional

Provide the authorized or anonymous token for a shopper. The token query parameter takes precedence over the apiKey.

expandstringOptional

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.

fieldsstringOptional

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.

pageNumberstringOptional

Specify the page to display from the result pages.

pageSizestringOptional

Specify the maximum number of items to include in each page.

formatstringOptional

Select either XML or JSON as the format for the Authorize Shopper API. The default format is XML.

currencystringOptional

Set the preferred currency for the pricing information returned for a product. Only works when using apiKey parameter.

localestringOptional

Set the preferred locale for the pricing information returned for products. Only works when using apiKey parameter.

skipOfferArbitrationbooleanOptional

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.

Responses
200
Successful response.
application/json
Responseone of
or
401
* Invalid Token
application/json
get
GET /v1/shoppers/me/products/{productId}/point-of-promotions/{popName}/offers HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "offers": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/offers",
    "offer": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709",
        "name": "Home Page Security & Backup Recovery Features",
        "trigger": "Always Triggered",
        "productOffers": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709/product-offers"
        },
        "categoryOffers": {},
        "offerBundleGroups": {
          "offerBundleGroup": [
            {
              "bundleGroupName": "Primary Group",
              "bundleType": "Mandatory",
              "minProductQuantity": 1,
              "maxProductQuantity": 100,
              "displayName": "Primary Group1",
              "description": "text",
              "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"
                  }
                }
              }
            }
          ]
        }
      }
    ],
    "totalResults": 1,
    "totalResultPages": 1
  }
}

Retrieve all offers of a specific POP

get

To retrieve all offers with the specified point-of-promotion (POP), specify the name of the point-of-promotion (POP) in the second {popName} URI path parameter.

The retrieved offers include the following:

  • All Always Triggered offers
  • All Promotional URL / External Triggered Offers) even if it’s not triggered

The retrieved offers do not include the following:

  • Coupon Code offers, even the coupon code offer, have been triggered
Path parameters
popNamestringRequired

Provide the name of the point of Promotion (POP).

Query parameters
apiKeystringOptional

Provide your client identifier. The token query parameter takes precedence over apiKey.

tokenstringOptional

Provide the authorized or anonymous token for a shopper. The token query parameter takes precedence over the apiKey.

expandstringOptional

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.

fieldsstringOptional

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.

pageNumberstringOptional

Specify the page to display from the result pages.

pageSizestringOptional

Specify the maximum number of items to include in each page.

formatstringOptional

Select either XML or JSON as the format for the Authorize Shopper API. The default format is XML.

currencystringOptional

Set the preferred currency for the pricing information returned for a product. Only works when using apiKey parameter.

localestringOptional

Set the preferred locale for the pricing information returned for products. Only works when using apiKey parameter.

skipOfferArbitrationbooleanOptional

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.

Responses
200
Successful response.
application/json
Responseone of
or
401
* Invalid Token
application/json
get
GET /v1/shoppers/me/point-of-promotions/{popName}/offers HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "offers": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/SiteMerchandising_HomePageStoreSpecials/offers",
    "offer": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709",
        "name": "Home Page Security & Backup Recovery Features",
        "trigger": "Always Triggered",
        "productOffers": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709/product-offers"
        },
        "categoryOffers": {},
        "offerBundleGroups": {
          "offerBundleGroup": [
            {
              "bundleGroupName": "Primary Group",
              "bundleType": "Mandatory",
              "minProductQuantity": 1,
              "maxProductQuantity": 100,
              "displayName": "Primary Group1",
              "description": "text",
              "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"
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

Retrieve all offers

get

Retrieve all offers, including:

  • Trigger type is Always Triggered offers
  • Trigger type is User Triggered (Promotional URL / External Triggered Offers) and has been triggered
  • Trigger type is User Triggered (Coupon Code) and has been triggered
Query parameters
apiKeystringOptional

Provide your client identifier. The token query parameter takes precedence over apiKey.

tokenstringOptional

Provide the authorized or anonymous token for a shopper. The token query parameter takes precedence over the apiKey.

expandstringOptional

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.

fieldsstringOptional

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.

pageNumberstringOptional

Specify the page to display from the result pages.

pageSizestringOptional

Specify the maximum number of items to include in each page.

formatstringOptional

Override the default format of XML for the Authorize Shopper API. Valid values are XML and JSON.

currencystringOptional

Set the preferred currency for the pricing information returned for a product. Only works when using apiKey parameter.

localestringOptional

Set the preferred locale for the pricing information returned for products. Only works when using apiKey parameter.

skipOfferArbitrationbooleanOptional

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.

Responses
200
Successful response.
application/json
Responseone of
or
401
* Invalid Token
application/json
get
GET /v1/shoppers/me/offers HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "offers": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/offers",
    "offer": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709",
        "name": "Home Page Security & Backup Recovery Features",
        "trigger": "Always Triggered",
        "productOffers": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709/product-offers"
        },
        "categoryOffers": {},
        "offerBundleGroups": {
          "offerBundleGroup": [
            {
              "bundleGroupName": "Primary Group",
              "bundleType": "Mandatory",
              "minProductQuantity": 1,
              "maxProductQuantity": 100,
              "displayName": "Primary Group1",
              "description": "text",
              "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"
                  }
                }
              }
            }
          ]
        }
      }
    ],
    "totalResults": 1,
    "totalResultPages": 1
  }
}

Get all products for the offer

get

To get all products for the specific offer, specify the ID of the offer in the {offerId} URI path parameter. This API is incapable of retrieving information for Custom Bundle offer.

Path parameters
offerIdstringRequired

Provide the offer's identifier to limit the response to the products that are eligible for the offer.

Query parameters
apiKeystringOptional

Provide your client identifier. The token query parameter takes precedence over the apiKey.

tokenstringOptional

Provide the authorized or anonymous token for a shopper. The token query parameter takes precedence over the apiKey.

expandstringOptional

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.

fieldsstringOptional

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.

formatstringOptional

Override the default format of XML for the Authorize Shopper API. Valid values are XML and JSON.

currencystringOptional

Set the preferred currency for the pricing information returned for a product. Only works when using apiKey parameter.

localestringOptional

Set the preferred locale for the pricing information returned for products. Only works when using apiKey parameter.

skipOfferArbitrationbooleanOptional

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.

Responses
200
Successful response.
application/json
Responseone of
or
401
* Invalid Token
application/json
get
GET /v1/shoppers/me/offers/{offerId}/product-offers HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "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://drh-sys-ora.img.digitalriver.com/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"
        }
      }
    ]
  }
}
  • GETGet an offer by ID
  • GETGet the product for the offer
  • GETRetrieve all offers for a product
  • GETRetrieve all offers for a given POP for a product
  • GETRetrieve all offers of a specific POP
  • GETRetrieve all offers
  • GETGet all products for the offer