docs
  1. Admin Api
  2. Resources
  3. Vouchers
  4. Update A Voucher

Update a voucher

Update an existing voucher

Rate Limit: 300 Max attempts within 1 minute.

Path Parameters

ParameterDetails
shopKey
  • required
string
Example:
ms
countryCode
  • required
string
Example:
de
voucherId
  • required
integer
Example:
1

Request body

required
ParameterDetails
id
  • readonly
integer
code
  • MinLength: 4
  • MaxLength: 20
string
constraints
object
isValidOnCampaigns
boolean
date
object
maxApplications
object
orderValue
object
criteria
object
key
string
Enum:
shopCategoryId
masterCategoryId
customerId
emailHash
brandId
productId
customerGroup
shopCountryId
type
string
Enum:
include
exclude
value
array
isApplicableToPromotions
boolean
name
  • required
string
status
string
Enum:
active
inactive
pending-review
archived
summary
string
type
  • required
string
Enum:
absolute
relative
value
  • required
number
Example:
0.1

Responses

200
Voucher was successfully updated.
application/json
Success
id
integer
code
string
object
Array of object
isApplicableToPromotions
boolean
namerequired
string
status
string
summary
string
typerequired
string
valuerequired
number
Example:
0.1
400
Bad Request
application/json
Error
401
Unauthorized
application/json
Error
404
Not Found
application/json
Error
PATCH/shops/{shopKey}/countries/{countryCode}/vouchers/{voucherId}

Request samples

Response samples

200
Voucher:
Content type: application/json
Provide Feedback