Sign in
latestOpenAPI 3.0.02026-08-106054.4 KB

42536792b3f8

Create Offer

Create Offer

The Create Offer endpoint generates product offerings based on your business context and customer information. This endpoint uses a schema-driven approach to validate requests and returns one or more products with detailed pricing, product information, and content for display.

post/partners/{partner_code}/offers/

Query parameters

active_onlyboolean

When using a test API key, only return active offers

include_contentboolean

Include localized content in the response

extra_fieldsstring

Comma-separated list of specific extra fields to include. Available fields: tax, commission, benefits, surcharge

exclude_offer_idsstring

Comma-separated list of Offer Config IDs to exclude from the response

Request body

schemastring

Schema identifier for the offer type. If omitted, the default schema will be used (if one is configured). If no default schema is configured and this field is omitted, the request will fail with a validation error. Contact your Client Solutions Engineer (CSE) to confirm your schema configuration.

contextobject required

Business context data required for offer selection and pricing. The specific fields required will be defined through the offer schema with the Client Solutions Engineer (CSE).

Response

OK

idstring
session_idstring
offer_config_idstring
offer_schemastring
currencystring
errorsobject

Any errors encountered during offer creation