API Reference

Update coupon.

put
https://api.wrappedgiftcards.com/api/WebStoreCoupon/Update/

Replaces the coupon's writable fields. Code can be changed but must remain unique on the account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Coupon identifier.

Body Params

Replacement values.

Create-coupon or update-coupon request.

string
required
length ≥ 1

Redeemable code. Uppercased server-side.

string
required
length ≥ 1

Discount type: Percent or FixedAmount.

double
required

Discount amount. Percent value or fixed amount in the account's currency.

string | null

Optional description.

appliesToProductIds
array of strings | null

Product IDs the coupon is restricted to. Empty or omitted means all products.

appliesToProductIds
int32

Minimum number of gift cards in the order (default 1).

double | null

Minimum order total for the coupon to apply. Omit for no minimum.

string | null

Status: Active, Disabled, Expired or Deleted. Defaults to Active.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Code, invalid DiscountType/Status, or Amount not greater than zero.

x-api-key.

Updated about 1 month ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated about 1 month ago

Did this page help you?