offers reference

This reference follows the current server implementation. Use the SDK for customer flows; it manages identity proof and retries. Authentication and errors apply to every endpoint. Types below describe JSON: dates are ISO strings, ? means optional, and null differs from an omitted field. Responses may include additional fields. Schemas also enforce constraints that TypeScript cannot express; download the request JSON Schemas. Named response types are defined in the data model reference.

POST /v1/offers/:offerIdentifier/redemption-link

Authentication: Public or secret app API key; customer/session proof is still required wherever the operation acts on an identity.

Path parameters: offerIdentifier (string). Every target must belong to the authenticated app or workspace.

Request

Send JSON with Content-Type: application/json. Where multiple shapes are shown, the handler selects the applicable operation or validates nested input.

unknown

string

Response

JSON response shape

ProductOfferRedemptionLinkResponse

Errors: validation/authentication failures use the common error envelope. A missing or inaccessible target returns an error; never interpret it as an empty successful result.

Implementation · Handler: handleClaimProductOffer.

POST /v1/offers/:offerIdentifier/redemption-presentation

Authentication: Public or secret app API key; customer/session proof is still required wherever the operation acts on an identity.

Path parameters: offerIdentifier (string). Every target must belong to the authenticated app or workspace.

Request

Send JSON with Content-Type: application/json. Where multiple shapes are shown, the handler selects the applicable operation or validates nested input.

unknown

Response

JSON response shape

{ acknowledged: true;
  }

Errors: validation/authentication failures use the common error envelope. A missing or inaccessible target returns an error; never interpret it as an empty successful result.

Implementation · Handler: handleAcknowledgeProductOfferPresentation.