Get free, locked and total coupon code counts

Prev Next
Get
/couponList/getCounts

Matches coupon list overview availability: free is the number of codes with no lock ID minus outstanding sendout reservation amounts, with a minimum of zero. Locked includes code locks and outstanding reservations, capped at the total number of stored codes. Total is the number of stored codes and equals free plus locked. Reservations exceeding available codes result in free = 0 and locked = total.

Query parameters
couponListName
stringRequired

List name in the authenticated customer; case-insensitive.

Responses
200

Free, locked and total coupon code counts.

object
free
integer (int64)
locked
integer (int64)
total
integer (int64)
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