Check a coupon code's status

Prev Next
Post
/couponList/checkCodeStatus

Returns FREE, LOCKED or NOT_FOUND only. The request identifies the list by couponListName within the authenticated customer. The supplied code is never returned. This operation does not reserve or consume a code.

Body parameters

List and coupon code to check.

object
couponListName
string Required

List name in the authenticated customer; case-insensitive, 3-50 characters.

code
string Required

Coupon code to look up; non-blank, at most 200 characters. Never returned in responses or errors.

Responses
200

FREE, LOCKED or NOT_FOUND.

string
400

InvalidParameterException / INVALID_PARAMETER: request body is missing, code is null or blank, code exceeds 200 characters, or couponListName length is outside 3-50 characters; MISSING_PARAMETER: couponListName is omitted.
NoSuchObjectException / NO_SUCH_OBJECT: no list with this name exists in the authenticated customer. An absent code in an accessible list returns the successful status NOT_FOUND instead.
UnexpectedErrorException / PERMISSION_DENIED: caller lacks read access to this list. Errors never include the submitted coupon code.

object
errorActor
string
errorCode
string
message
string
500

UnexpectedErrorException / UNEXPECTED_ERROR: a backend operation failed; errorActor is SERVER. Errors never include the submitted coupon code.

object
errorActor
string
errorCode
string
message
string