Overview
Error Handling

Methods

API Documentation (API Version bleed)

Coupon/

DESCRIPTION

API methods for interacting with Coupons

A coupon tracks campaigns of discounts on products, or rebates given on order of certain items. A coupon applies to specific product categories, and is limited in the number of customers that may claim one.

claim

URL:

https://api.liquidweb.com/bleed/Coupon/claim

Description:

Claim a coupon

Parameters:

ParameterTypeNotes
brandOne of: 'LiquidWeb', 'Storm'* Optional
  • Defaults to: LiquidWeb
claim_originThe value: 'order'
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/details

Description:

Return details about a coupon

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'categories', 'products'
codeA 6 to 36 character coupon code* Required

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
amountA positive integer value (i.e. 1 and up).
amount_unitOne of: 'dollars', 'percent'
availableA boolean value (0 or 1).
calloutA string of text, containing no newlines or other control characters.
codeA 6 to 36 character coupon code
customer_typeOne of: 'all', 'existing', 'new'
internalA boolean value (0 or 1).
landing_pageA correctly formed absolute path* Optional
methodOne of: 'fixed', 'offset', 'percent', 'percent_mrc'
nameA string of text, containing no newlines or other control characters.
repetitionsA positive integer value (i.e. 1 and up).* Required if:
  • method is set to 'percent'

Possible Errors:

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