Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetOfferSet

Provides details about an offer set, which is a bundle of offers across multiple products. Includes the seller, availability dates, buyer notes, and associated product-offer pairs.

Request Syntax


POST /2026-02-05/getOfferSet HTTP/1.1
Content-type: application/json

{
   "locale": "string",
   "offerSetId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

offerSetId

The unique identifier of the offer set to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\w\-]+

Required: Yes

locale

A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See Locale for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^;,]+(\s*,\s*[^;,]+){0,1}

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "associatedEntities": [ 
      { 
         "offer": { 
            "offerId": "string",
            "offerName": "string",
            "sellerOfRecord": { 
               "displayName": "string",
               "sellerProfileId": "string"
            }
         },
         "product": { 
            "manufacturer": { 
               "displayName": "string",
               "sellerProfileId": "string"
            },
            "productId": "string",
            "productName": "string"
         }
      }
   ],
   "availableFromTime": number,
   "badges": [ 
      { 
         "badgeType": "string",
         "displayName": "string"
      }
   ],
   "buyerNotes": "string",
   "catalog": "string",
   "expirationTime": number,
   "locale": "string",
   "offerSetId": "string",
   "offerSetName": "string",
   "sellerOfRecord": { 
      "displayName": "string",
      "sellerProfileId": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

associatedEntities

The products and offers included in this offer set.

Type: Array of OfferSetAssociatedEntity objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

badges

Badges indicating special attributes of the offer set, such as private pricing or future dated.

Type: Array of PurchaseOptionBadge objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

catalog

The name of the catalog that the offer set belongs to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\w\-]+

offerSetId

The unique identifier of the offer set.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\w\-]+

sellerOfRecord

The entity responsible for selling the products under this offer set.

Type: SellerInformation object

availableFromTime

The date and time when the offer set became available to the buyer.

Type: Timestamp

buyerNotes

Detailed information about the offer set that helps buyers understand its purpose and contents.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

expirationTime

The date and time when the offer set expires and is no longer available for procurement.

Type: Timestamp

locale

The locale of the returned content. Indicates whether the response contains content in the requested locale, or fell back to the default locale. See Locale for details.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^;,]+(\s*,\s*[^;,]+){0,1}

offerSetName

The display name of the offer set.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*\S.*

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

reason: The reason that the input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400