v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-149189107.8 KB

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

post/2026-02-05/getOffer

Request body

offerIdstring required

The unique identifier of the offer to retrieve.

Response

Success

offerIdstring required

The unique identifier of the offer.

catalogstring required

The name of the catalog that the offer belongs to.

offerNamestring

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

agreementProposalIdstring required

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

expirationTimestring date-time

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

availableFromTimestring date-time

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

replacementAgreementIdstring

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