Get coupon list metadata and counts

Prev Next
Get
/couponList/get

Includes previewText, defaultText and reminder settings. A null remindThreshold means reminders are disabled; zero means remind when empty. Preview text defaults to the list name followed by _previewCoupon when unset or empty. Counts include outstanding sendout reservations as locked. No code values are returned.

Query parameters
couponListName
stringRequired

List name in the authenticated customer; case-insensitive.

Responses
200

Coupon list metadata and code counts.

Expand All
object
id
integer (int64)
name
string
description
string
previewText
string
defaultText
string
archived
boolean
Defaultfalse
updated
integer (int64)
counts
object (CouponCodeSummary)
free
integer (int64)
locked
integer (int64)
total
integer (int64)
reminderEnabled
boolean
Defaultfalse
remindThreshold
integer (int64)
additionalReminderEmail
string
400

InvalidParameterException / MISSING_PARAMETER: couponListName is omitted; INVALID_PARAMETER: name length must be 3-50 characters.
NoSuchObjectException / NO_SUCH_OBJECT: no list with this name exists in the authenticated customer.
UnexpectedErrorException / PERMISSION_DENIED: caller lacks read access to this list.

object
errorActor
string
errorCode
string
message
string
500

UnexpectedErrorException / UNEXPECTED_ERROR: a backend operation failed; errorActor is SERVER.

object
errorActor
string
errorCode
string
message
string