Sign in

v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Gift Cards

Add gift card

Create a new gift card. Vrio will generate a gift card code that can be used when processing orders.

post/gift_cards

Request body

gift_card_totalstring required

Set the total amount for a gift card.

date_expirestring date-time

Set an expiration date for the gift card.

gift_card_notesstring

Apply note to the history for this gift card.

Example request

{
  "date_expire": "2023-04-01 00:00:00"
}

Response

OK

gift_card_idinteger
customer_idinteger nullable
gift_card_codestring
gift_card_totalstring
gift_card_balancestring
gift_card_activeboolean
date_expirestring date-time nullable
date_createdstring date-time
created_byinteger
date_modifiedstring date-time
modified_byinteger
gift_card_notesstring nullable

Example response

{
  "date_expire": "2023-04-01 00:00:00",
  "date_created": "2023-04-01 00:00:00",
  "date_modified": "2023-04-01 00:00:00"
}