Voucher

Get a Voucher.

get/api/v1/Voucher/{code}

Request

  • Base URL: https://api.cin7.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.cin7.com/api/v1/Voucher/{code}
  • Auth: none declared

Path parameters

codestring required

Response

OK

createdDatestring date-time

Voucher Created Date

statusstring nullable

Status - Active: voucher has balance, Inactive: already fully redeemed

codestring nullable

Voucher Code

typestring nullable

Voucher Type

descriptionstring nullable

Promotion Description

expiryDatestring date-time

Voucher Expiry Date

amountnumber double

Voucher Amount

customerIDinteger

Customer ID of which voucher is assigned to

customerEmailstring nullable

Customer Email of which voucher is assigned to

redeemedCountinteger

Count on how many times the voucher has been redeemed. Only makes sense when RedeemedCountLimit=1

redeemedCountLimitinteger

Limit on how many times the voucher can be fully redeemed, should always be 1 unless modified from backend. Cin7 vouchers don't have limit counts on partial redemptions as long as they have balance left.

redeemedAmountnumber double

Voucher Redeemed Amount

Changes

No recorded changes to this operation across all 1 revision of this API.