Offers
Last updated
Shopper APIs reference
Last updated
To get an offer by ID, specify the ID of the offer in the {id} URI path parameter.
/v1/shoppers/me/offers/{offerId}
Provide the offer's identifier.
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.
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.
/v1/shoppers/me/offers/{offerId}/product-offers/{productOfferId}
Provide the offer's identifier to limit the response to the products that are eligible for the offer.
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.
Provide your client identifier. The token query parameter takes precedence over the 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.
Override the default format of XML for the Authorize Shopper API. Valid values are XML and JSON.
Set the preferred currency for the pricing information returned for a product. Only works when using apiKey parameter.
Set the preferred locale for the pricing information returned for products. Only works when using 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.
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:
/v1/shoppers/me/products/{productId}/offers
Provide the product identifier.
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.
Specify the page to display from the result pages.
Specify the maximum number of items to include in each page.
Override the default format of XML for the Authorize Shopper API. Valid values are XML and JSON.
Set the preferred currency for the pricing information returned for a product. Only works when using apiKey parameter.
Set the preferred locale for the pricing information returned for products. Only works when using 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.
To retrieve all offers for a given point-of-promotion (POP) for a product:
The retrieved offers include:
The retrieved offers do not include the following:
/v1/shoppers/me/products/{productId}/point-of-promotions/{popName}/offers
Provide the product identifier.
Provide the name of the point of Promotion (POP).
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.
Specify the page to display from the result pages.
Specify the maximum number of items to include in each page.
Select either XML or JSON as the format for the Authorize Shopper API. The default format is XML.
Set the preferred currency for the pricing information returned for a product. Only works when using apiKey parameter.
Set the preferred locale for the pricing information returned for products. Only works when using 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.
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:
The retrieved offers do not include the following:
/v1/shoppers/me/point-of-promotions/{popName}/offers
Provide the name of the point of Promotion (POP).
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.
Specify the page to display from the result pages.
Specify the maximum number of items to include in each page.
Select either XML or JSON as the format for the Authorize Shopper API. The default format is XML.
Set the preferred currency for the pricing information returned for a product. Only works when using apiKey parameter.
Set the preferred locale for the pricing information returned for products. Only works when using 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.
Retrieve all offers, including:
/v1/shoppers/me/offers
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.
Specify the page to display from the result pages.
Specify the maximum number of items to include in each page.
Override the default format of XML for the Authorize Shopper API. Valid values are XML and JSON.
Set the preferred currency for the pricing information returned for a product. Only works when using apiKey parameter.
Set the preferred locale for the pricing information returned for products. Only works when using 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.
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.
/v1/shoppers/me/offers/{offerId}/product-offers
Provide the offer's identifier to limit the response to the products that are eligible for the offer.
Provide your client identifier. The token query parameter takes precedence over the 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.
Override the default format of XML for the Authorize Shopper API. Valid values are XML and JSON.
Set the preferred currency for the pricing information returned for a product. Only works when using apiKey parameter.
Set the preferred locale for the pricing information returned for products. Only works when using 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.