Overview
Error Handling

Methods

API Documentation (API Version bleed)

Coupon/Claim/

DESCRIPTION

API methods for interacting with Coupon claims

A coupon claim is an association of a coupon to a customer email address. A coupon has a limited number of claims. When a claim is redeemed, it is associated with an order, and will take various action on the account that the order was created for.

create

URL:

https://api.liquidweb.com/bleed/Coupon/Claim/create

Description:

creates a new coupon claim.

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'coupon_callout', 'coupon_landing_page', 'redeemableCategories', 'redeemableProducts', 'repetitions'
brandOne of: 'LiquidWeb', 'Storm'* Optional
  • Defaults to: LiquidWeb
claim_originThe value: 'order'
coupon_codeA 6 to 36 character coupon code* Required
emailA valid email address.* Required

Returns:

FieldTypeNotes
amountA positive integer value (i.e. 1 and up).
amount_unitOne of: 'dollars', 'percent'
codeA valid UUID (Universally Unique IDentifier).
coupon_codeA 6 to 36 character coupon code
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
emailA valid email address.
forceA boolean value (0 or 1).* Optional
methodOne of: 'fixed', 'percent', 'percent_mrc'
redeemedA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

details

URL:

https://api.liquidweb.com/bleed/Coupon/Claim/details

Description:

Return details about a coupon claim

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'coupon_callout', 'coupon_landing_page', 'redeemableCategories', 'redeemableProducts', 'repetitions'
codeA valid UUID (Universally Unique IDentifier).* Required if:
  • coupon_code is not given
  • email is not given
coupon_codeA 6 to 36 character coupon code* Required if:
  • code is not given
emailA valid email address.* Required if:
  • code is not given

Returns:

FieldTypeNotes
amountA positive integer value (i.e. 1 and up).
amount_unitOne of: 'dollars', 'percent'
codeA valid UUID (Universally Unique IDentifier).
coupon_codeA 6 to 36 character coupon code
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
emailA valid email address.
forceA boolean value (0 or 1).* Optional
methodOne of: 'fixed', 'percent', 'percent_mrc'
redeemedA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types