View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.

API reference Models

PromotionCodeSuggestionStyle

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

The kind of code `PromotionCodeSuggester` produces.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Memorable A marketing code a customer can read off a flyer and type at checkout, built from the promotion's own value, name, start date and scope, for example WELCOME10. Guessable by design.
Private A code for a single customer or a goodwill discount: a word, a hyphen and four characters drawn from a cryptographic random source, for example THANKS-K7Q2. Nothing in it comes from the promotion's own details, so it cannot be inferred from a flyer or a name. It is still a short bearer value: give the promotion a redemption limit rather than relying on the suffix to keep it private.

Fields

Field Type Description

This model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.