Voucher codes
Last updated
Was this helpful?
Last updated
Was this helpful?
Returns all voucher codes filtered by or other filter parameters. Note this operation uses and supports .
[PlatformAddress]/api/connector/v1/voucherCodes/getAll
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseIds
array of string
optional, max 1000 items
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
VoucherCodeIds
array of string
optional, max 1000 items
Unique identifiers of the voucher codes.
VoucherIds
array of string
required, max 1000 items
Unique identifiers of vouchers.
UpdatedUtc
optional, max length 3 months
Interval of voucher code's last update date and time.
Limitation
required
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
VoucherCodes
required, max 1000 items
Information about voucher codes used by customers.
Cursor
string
optional
Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
[PlatformAddress]/api/connector/v1/voucherCodes/add
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseId
string
optional
VoucherCodeParameters
required, max 1000 items
Voucher codes to be added.
VoucherId
string
required
Value
string
required, max length 128 characters
Value of voucher code used by customers.
ValidityStartUtc
string
optional
If specified, marks the beginning of interval in which the code can be used.
ValidityEndUtc
string
optional
If specified, marks the end of interval in which the code can be used.
VoucherCodes
required, max 1000 items
Information about voucher codes used by customers.
Cursor
string
optional
Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
Id
string
required
Unique identifier of the voucher code.
VoucherId
string
required
Value
string
optional
Value of voucher code used by customers.
ValidityStartUtc
string
optional
If specified, marks the beginning of interval in which the code can be used.
ValidityEndUtc
string
optional
If specified, marks the end of interval in which the code can be used.
CreatedUtc
string
optional
Creation date and time of the voucher in UTC timezone in ISO 8601 format.
UpdatedUtc
string
optional
Last update date and time of the voucher in UTC timezone in ISO 8601 format.
IsActive
boolean
required
Whether the voucher code is still active.
ActivityState
string
optional
Whether voucher code is active or deleted. Deprecated! Use IsActive
instead.
[PlatformAddress]/api/connector/v1/voucherCodes/delete
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseId
string
optional
VoucherCodeIds
array of string
required, max 1000 items
Unique identifiers of the voucher codes to be deleted.
array of
Adds voucher codes to the specified . Note this operation supports .
Unique identifier of the enterprise. Required when using , ignored otherwise.
array of
Unique identifier of the code belongs to.
array of
Unique identifier of the code belongs to.
Delete specified voucher codes. Note this operation supports .
Unique identifier of the enterprise. Required when using , ignored otherwise.