---
title: "Get an offer by ID"
method: GET
path: "/v1/shoppers/me/offers/{offerId}"
tags: ["Offers"]
---

# Get an offer by ID

`GET /v1/shoppers/me/offers/{offerId}`

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

## Path parameters

- `offerId` string, required

## Query parameters

- `apiKey` string
- `token` string
- `expand` string
- `fields` string
- `format` string
- `currency` string
- `locale` string
- `skipOfferArbitration` boolean

## Response `200`

Successful response.

- union
  - DefaultOffer
    - `offer` object
      - `uri` string
      - `id` integer
      - `name` string
      - `policyName` string — The bundle policy for bundle offers outlines the relationship between parent and child products within the bundle. For example:Semi-Tight, Loose, Tight.
      - `type` string
      - `image` string
      - `trigger` string — The offer trigger determines how the offer is activated or redeemed by shoppers, possible values are: User Triggered, Always Triggered. * Always Triggered: The offer is available to any shopper on your store. Shoppers simply have to meet the conditions you set up in the offer for the offer to be triggered and redeemed by shoppers. * User Triggered: To be redeemed when shopper taking additional actions on their part, for example click a link, enter a coupon code.
      - `salesPitch` string[] — Text or content appeared above the product image and information in the offer content.
      - `productOffers` object — Product information of the offer. The productOffer objects for Custom Bundle offer are placed within the offerBundleGroup object.
        - `uri` string
        - `productOffer` object[]
          - `uri` string
          - `id` integer
          - `product` object
            - `uri` string
            - `displayName` string
            - `thumbnailImage` string
          - `pricing` object
            - `listPrice` DefaultCurrency
              - …
            - `salePriceWithQuantity` DefaultCurrency
              - …
            - `formattedListPrice` string
            - `formattedSalePriceWithQuantity` string
            - `listPriceIncludesTax` string
      - `categoryOffers` object — Category information of the offer.
      - `offerBundleGroups` object — Data and items associated with the custom bundle offer groups.
        - `offerBundleGroup` OfferBundleGroup[]
          - `bundleGroupName` string — The group is named based on a sequence, beginning with "Primary," followed by "Secondary," and, if needed, "Third."
          - `bundleType` 'Mandatory' | 'Optional' — Mandatory means shopper should pick up at least N products in a group. Optional has no minimum amount restriction.
          - `minProductQuantity` integer — The quantity that the shopper must by at least.
          - `maxProductQuantity` integer — The quantity that the shopper can by at most.
          - `displayName` string — The name of the offer.
          - `description` string — The description of the offer.
          - `productOffers` DefaultProductOffer
            - `productOffer` object
              - …
  - ExpandedOffer
    - `offer` ExpandedOfferComponent
      - `uri` string
      - `id` integer
      - `name` string
      - `policyName` string — The bundle policy for bundle offers outlines the relationship between parent and child products within the bundle. For example:Semi-Tight, Loose, Tight.
      - `type` string
      - `image` string
      - `trigger` string — The offer trigger determines how the offer is activated or redeemed by shoppers, possible values are: User Triggered, Always Triggered. * Always Triggered: The offer is available to any shopper on your store. Shoppers simply have to meet the conditions you set up in the offer for the offer to be triggered and redeemed by shoppers. * User Triggered: To be redeemed when shopper taking additional actions on their part, for example click a link, enter a coupon code.
      - `salesPitch` string[] — Text or content appeared above the product image and information in the offer content.
      - `customAttributes` DefaultCustomAttributes
        - `attribute` object[]
          - `name` string
          - `value` string
          - `type` string
      - `productOffers` ExpandedProductOffersComponent — Product information of the offer. The productOffer objects for Custom Bundle offers are placed within the offerBundleGroup object.
        - `uri` string
        - `productOffer` object[]
          - `uri` string
          - `id` integer
          - `product` object
            - `uri` string
            - `id` integer
            - `name` string
            - `displayName` string
            - `shortDescription` string
            - `longDescription` string
            - `productType` string
            - `sku` string
            - `externalReferenceId` string
            - `companyId` string
            - `displayableProduct` string
            - `purchasable` string
            - `manufacturerName` string
            - `manufacturerPartNumber` string
            - `minimumQuantity` string — The quantity that the shopper must buy at least.
            - `maximumQuantity` string — The quantity that the shopper can buy at most.
            - `thumbnailImage` string
            - `productImage` string
            - `keywords` string — The words shopper can enter in a search engine to search the product.
            - `baseProduct` string — Whether this product is a base product.
            - `customAttributes` DefaultCustomAttributes
              - …
            - `inventoryStatus` object
              - …
          - `addProductToCart` object
            - `uri` string
            - `cartUri` string
          - `salesPitch` string — Text or content appeared above the product image and information in the offer content.
          - `image` string
          - `pricing` object
            - `listPrice` DefaultCurrency
              - …
            - `listPriceWithQuantity` DefaultCurrency
              - …
            - `salePriceWithQuantity` DefaultCurrency
              - …
            - `formattedListPrice` string
            - `formattedListPriceWithQuantity` string
            - `formattedSalePriceWithQuantity` string
            - `totalDiscountWithQuantity` DefaultCurrency
              - …
            - `formattedTotalDiscountWithQuantity` string
            - `listPriceIncludesTax` string
            - `discountDescription` string
            - `tax` object
              - …
      - `categoryOffers` object — Category information of the offer.
      - `offerBundleGroups` object — Data and items associated with the Custom Bundle offer groups.
        - `offerBundleGroup` OfferBundleGroup[]
          - `bundleGroupName` string — The group is named based on a sequence, beginning with "Primary," followed by "Secondary," and, if needed, "Third."
          - `bundleType` 'Mandatory' | 'Optional' — Mandatory means shopper should pick up at least N products in a group. Optional has no minimum amount restriction.
          - `minProductQuantity` integer — The quantity that the shopper must by at least.
          - `maxProductQuantity` integer — The quantity that the shopper can by at most.
          - `displayName` string — The name of the offer.
          - `description` string — The description of the offer.
          - `productOffers` DefaultProductOffer
            - `productOffer` object
              - …

## Other responses

- `401` — * Invalid Token
- `404` — * resource-not-found

---

[API](https://skmtc.net/digitalriver/apis/commerce-api-suite-shopper-apis.md) · [All operations](https://skmtc.net/digitalriver/apis/commerce-api-suite-shopper-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalriver/commerce-api-suite-shopper-apis/revisions/4b69392f93b9/schema)