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

GetOffer

Provides details about an offer, such as the pricing model, seller of record, availability dates, badges, and associated products.

Request Syntax


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

{
   "locale": "string",
   "offerId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

offerId

The unique identifier of the offer 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

{
   "agreementProposalId": "string",
   "associatedEntities": [ 
      { 
         "offerSet": { 
            "offerSetId": "string",
            "sellerOfRecord": { 
               "displayName": "string",
               "sellerProfileId": "string"
            }
         },
         "product": { 
            "manufacturer": { 
               "displayName": "string",
               "sellerProfileId": "string"
            },
            "productId": "string",
            "productName": "string"
         }
      }
   ],
   "availableFromTime": number,
   "badges": [ 
      { 
         "badgeType": "string",
         "displayName": "string"
      }
   ],
   "catalog": "string",
   "expirationTime": number,
   "locale": "string",
   "offerId": "string",
   "offerName": "string",
   "pricingModel": { 
      "displayName": "string",
      "pricingModelType": "string"
   },
   "replacementAgreementId": "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.

agreementProposalId

An encoded string to be passed by the acceptor of the terms when creating an agreement.

Type: String

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

Pattern: [A-Za-z0-9_/-]+

associatedEntities

The products and offer sets associated with this offer.

Type: Array of OfferAssociatedEntity objects

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

badges

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

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 belongs to.

Type: String

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

Pattern: [\w\-]+

offerId

The unique identifier of the offer.

Type: String

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

Pattern: [\w\-]+

pricingModel

The pricing model that determines how buyers are charged, such as usage-based, contract, BYOL, or free.

Type: PricingModel object

sellerOfRecord

The entity responsible for selling the product under this offer.

Type: SellerInformation object

availableFromTime

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

Type: Timestamp

expirationTime

The date and time until when the offer can be procured. This value is null for offers that never expire.

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}

offerName

The display name of the offer. This is free-form text provided by the seller.

Type: String

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

replacementAgreementId

The identifier of the existing agreement that this offer would replace. Enables agreement-based offer functionality.

Type: String

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

Pattern: [A-Za-z0-9_/-]+

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