getVouchers

Operation Id:
vouchers/vouchers/get [Official Documentaction]
Methods

  • vouchers Array<Object>
  • voucherTypeId Integer
  • name String
  • status 'all'|'used'|'unused'|'unverified'
  • generetedFromAffiliateProgram 'all'|'y'|'n'
  • noteContain String
  • balanceFrom Number
  • balanceTo Number
  • expirationDateFrom String
  • expirationDateTo String
  • issueDateFrom String
  • issueDateTo String
  • usageDateFrom String
  • usageDateTo String
  • resultsPage Integer
  • resultsLimit Integer
  • ids values: number|string|number[]|string[]
  • numbers values: number|string|number[]|string[]
Examples

This function retrieves the status of all vouchers.

const result = await idosellRequest.getVouchers
	.status("all")
	.exec()

This function retrieves the voucher IDs associated with the specified user ID.

const result = await idosellRequest.getVouchers
	.ids([1477570721])
	.exec()

This function returns all vouchers that were issued between December 1, 2023 and December 31, 2023.

const result = await idosellRequest.getVouchers
	.issued("2023-12-01","2023-12-31")
	.exec()

This function retrieves any vouchers that will expire between December 1, 2023, and December 31, 2023.

const result = await idosellRequest.getVouchers
	.expires("2023-12-01","2023-12-31")
	.exec()

This function retrieves the number of used vouchers between the dates "2023-12-01" and "2023-12-31".

const result = await idosellRequest.getVouchers
	.used("2023-12-01","2023-12-31")
	.exec()