SuggestPromotionCodesInput
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
What the caller has filled in so far, from which promotion codes are suggested.
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.
Fields
| Field | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
merchantId
required |
string (uuid) | The merchant the promotion will belong to. When given, codes the merchant already uses
are left out of the suggestions. The caller must be authorized over the merchant.
Conditional: When MerchantId is not null.
nullable
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.
| ||||||||
excludePromotionId
required |
string (uuid) | The promotion being edited, so its own current code is not treated as taken.
nullable
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.
| ||||||||
style
required |
PromotionCodeSuggestionStyle PromotionCodeSuggestionStyle | Memorable marketing codes, or private single-use ones.
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.
| ||||||||
count
required |
integer (int32) | How many suggestions to return, between 1 and `MaxCount`.
min 1max 10
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.
| ||||||||
discountType
required |
PromotionDiscountType PromotionDiscountType | Whether the value is a percentage or a flat amount.
nullable
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.
| ||||||||
value
required |
number (double) | The percentage, or the flat amount.
nullable
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.
| ||||||||
currency
required |
string | The ISO 4217 currency, when the promotion has one.
nullable
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.
| ||||||||
name
required |
string | The operator-facing promotion name. Its first word may appear in a suggestion.
nullablemax length 128
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.
| ||||||||
startsAtUtc
required |
string (date-time) | When the promotion starts. The season and month in a suggestion are read from it.
nullable
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.
| ||||||||
appliesToScope
required |
PromotionAppliesToScope PromotionAppliesToScope | What the promotion applies to.
nullable
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.
| ||||||||
durationMode
required |
PromotionDurationMode PromotionDurationMode | How long the discount runs on a recurring charge.
nullable
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.
| ||||||||
durationCycles
required |
integer (int32) | How many billing cycles the discount runs for.
nullable
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.
|
This model has no documented fields.