Update a voucher

post

https://demo.app.viberetail.com/index.php/api/v1/vouchers/{voucher_id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

voucher_id

string

required

voucher id or voucher code to update

Body Params

Voucher fields to update

customer_id

integer

required

Person id of the customer the voucher is issued to

restriction_type

string

enum

Defaults to item

What the voucher may be applied to

Allowed:

item_id

integer

Required when restriction_type is "item"

item_variation_id

integer

Optional specific variation of the item

category_id

integer

Required when restriction_type is "category"

tag_id

integer

Required when restriction_type is "tag"

voucher_value

float

Monetary value of the voucher

expiry_date

string

Optional expiry date/time (any strtotime-parseable format). Null means no expiry.

comment

string

Internal note

voucher_code

string

Optional. Auto-generated (VCH-XXXXXXXXXX) when omitted.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

Invalid voucher ID supplied

404

Voucher not found

405

Validation exception

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully updated voucher