Add new gift card

post

https://api.tilby.com/v2/giftcards

Gift Cards object that needs to be added. uuid is generated from BE. If you need to insert multiple Giftcards you can send and array of giftcards_body

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

code

string

code generated to redeem the gift card. if it is null, will be generated from BE as a barcode ean13. Must be unique.

currency

string

if it is not set, default currency of the shop will be used

initial_value

number

required

≥ 0.01

is_divisible

boolean

Defaults to false

used to say if the gift card can be used more then once. If it is not set, but type_uuid.is_divisible is set, then giftcards.is_divisible = type_uuid.is_divisible

notes

string

description of the giftcard

origin_environment

uuid

set by Be

origin_environment_only

boolean

Defaults to false

if it is true, can be used only from origin environment

origin_sale

uuid

origin sale generated from

type_uuid

uuid

uuid of the giftcards_types

uuid

uuidv4 must be unique if it is not set, backend will generated by default

valid_since

date-time

if it is not set will be the same as created_at

valid_until

date-time

if it is not set and type_uuid is set, then valid_until will be = days of giftcards_types.expire_after + Date.now(). Can not be less than valid_since

Responses

422

Error: Unprocessable Entity

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

201Returns the new gift card