Core resources
Administration
Booking flow
Codes guests can enter for additional discounts
id
uuid
Unique identifier
organization_id
uuid
Identifier of the organization this coupon is defined in
created_at
timestamp with time zone
Creation timestamp
updated_at
timestamp with time zone
Last modification timestamp
deleted_at
timestamp with time zone | null
Timestamp at which the coupon was deleted
code
text
Coupon code
definition
jsonb
Definition of the coupon
description
text
Description of the coupon
fts
tsvector
Full text search index
quota
integer | null
Maximum number of times this coupon can be used
scope
"global" | "product" | "service" | "rent"
Scope of the coupon
{"id": "00000000-0000-0000-0000-000000000000","organization_id": "00000000-0000-0000-0000-000000000000","created_at": "2024-09-08T01:30:47.256Z","updated_at": "2024-09-08T01:30:47.256Z","deleted_at": "2024-09-08T01:30:47.256Z","code": "","definition": {},"description": "","quota": 0,"scope": "global"}
id
Filter<uuid>
Unique identifier
organization_id
Filter<uuid>
Identifier of the organization this coupon is defined in
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
deleted_at
Filter<timestamp with time zone>
Timestamp at which the coupon was deleted
code
Filter<text>
Coupon code
definition
Filter<jsonb>
Definition of the coupon
description
Filter<text>
Description of the coupon
fts
Filter<tsvector>
Full text search index
quota
Filter<integer>
Maximum number of times this coupon can be used
scope
Filter<"global" | "product" | "service" | "rent">
Scope of the coupon
200
A list of coupons with the selected columns
206
Partial Content
GET
/coupons
curl -X GET "https://api.bookingmood.com/v1/coupons?select=*" \ -H "Authorization: Bearer YOUR_API_KEY"
Partial<Coupon>
| Array<Partial<Coupon>>
201
The newly created coupons with the selected columns
POST
/coupons
curl -X POST "https://api.bookingmood.com/v1/coupons" \ -H "Authorization: Bearer YOUR_API_KEY" \ -d '[]'
id
Filter<uuid>
Unique identifier
organization_id
Filter<uuid>
Identifier of the organization this coupon is defined in
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
deleted_at
Filter<timestamp with time zone>
Timestamp at which the coupon was deleted
code
Filter<text>
Coupon code
definition
Filter<jsonb>
Definition of the coupon
description
Filter<text>
Description of the coupon
fts
Filter<tsvector>
Full text search index
quota
Filter<integer>
Maximum number of times this coupon can be used
scope
Filter<"global" | "product" | "service" | "rent">
Scope of the coupon
204
The deleted coupons with the selected columns
DELETE
/coupons
curl -X DELETE "https://api.bookingmood.com/v1/coupons" \ -H "Authorization: Bearer YOUR_API_KEY"
id
Filter<uuid>
Unique identifier
organization_id
Filter<uuid>
Identifier of the organization this coupon is defined in
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
deleted_at
Filter<timestamp with time zone>
Timestamp at which the coupon was deleted
code
Filter<text>
Coupon code
definition
Filter<jsonb>
Definition of the coupon
description
Filter<text>
Description of the coupon
fts
Filter<tsvector>
Full text search index
quota
Filter<integer>
Maximum number of times this coupon can be used
scope
Filter<"global" | "product" | "service" | "rent">
Scope of the coupon
Partial<Coupon>
204
The updated coupons with the selected columns
PATCH
/coupons
curl -X PATCH "https://api.bookingmood.com/v1/coupons" \ -H "Authorization: Bearer YOUR_API_KEY" \ -d '{}'