API Reference
  1. Vibe API
  2. vouchers

Redeem a voucher against a sale

post
https://demo.app.viberetail.com/index.php/api/v1/vouchers/redeem

Marks an active voucher as redeemed and links it to a sale. The voucher must be active, unexpired, and owned by the given customer (customer_id is required). NOTE: sale_id is supplied by the caller and is not verified against an existing sale record.

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

Voucher code and the sale_id to redeem it against

string
required
integer
required

Sale the voucher is redeemed against (not verified against an existing sale)

integer
required

Required. The voucher must belong to this customer or redemption is rejected.

integer

Optional person id to attribute the redemption to. Defaults to the API key's user.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Missing required fields

Updated about 2 months ago

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

Updated about 2 months ago

Did this page help you?