Sign in
latestOpenAPI 3.0.02026-08-101013821017.9 KB

4b69392f93b9

Offers

Retrieve all offers

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
get/v1/shoppers/me/offers

Query parameters

apiKeystring

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

tokenstring

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

expandstring

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.

fieldsstring

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.

pageNumberstring

Specify the page to display from the result pages.

pageSizestring

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

formatstring

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

currencystring

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

localestring

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

skipOfferArbitrationboolean

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.

OR