Core resources
Administration
Booking flow
Codes guests can enter for additional discounts
iduuid Unique identifier
organization_iduuid Identifier of the organization this coupon is defined in
created_attimestamp with time zone Creation timestamp
updated_attimestamp with time zone Last modification timestamp
deleted_attimestamp with time zone | nullTimestamp at which the coupon was deleted
codetext Coupon code
definitionjsonb Definition of the coupon
descriptiontext Description of the coupon
ftstsvector Full text search index
quotainteger | nullMaximum 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-05-11T04:44:44.024Z","updated_at": "2024-05-11T04:44:44.024Z","deleted_at": "2024-05-11T04:44:44.024Z","code": "","definition": {},"description": "","quota": 0,"scope": "global"}
idFilter<uuid>Unique identifier
organization_idFilter<uuid>Identifier of the organization this coupon is defined in
created_atFilter<timestamp with time zone>Creation timestamp
updated_atFilter<timestamp with time zone>Last modification timestamp
deleted_atFilter<timestamp with time zone>Timestamp at which the coupon was deleted
codeFilter<text>Coupon code
definitionFilter<jsonb>Definition of the coupon
descriptionFilter<text>Description of the coupon
ftsFilter<tsvector>Full text search index
quotaFilter<integer>Maximum number of times this coupon can be used
scopeFilter<"global" | "product" | "service" | "rent">Scope of the coupon
200A list of coupons with the selected columns
206Partial Content
GET/couponscurl -X GET "https://api.bookingmood.com/v1/coupons?select=*" \ -H "Authorization: Bearer YOUR_API_KEY"
Partial<Coupon>
| Array<Partial<Coupon>>201The newly created coupons with the selected columns
POST/couponscurl -X POST "https://api.bookingmood.com/v1/coupons" \ -H "Authorization: Bearer YOUR_API_KEY" \ -d '[]'
idFilter<uuid>Unique identifier
organization_idFilter<uuid>Identifier of the organization this coupon is defined in
created_atFilter<timestamp with time zone>Creation timestamp
updated_atFilter<timestamp with time zone>Last modification timestamp
deleted_atFilter<timestamp with time zone>Timestamp at which the coupon was deleted
codeFilter<text>Coupon code
definitionFilter<jsonb>Definition of the coupon
descriptionFilter<text>Description of the coupon
ftsFilter<tsvector>Full text search index
quotaFilter<integer>Maximum number of times this coupon can be used
scopeFilter<"global" | "product" | "service" | "rent">Scope of the coupon
204The deleted coupons with the selected columns
DELETE/couponscurl -X DELETE "https://api.bookingmood.com/v1/coupons" \ -H "Authorization: Bearer YOUR_API_KEY"
idFilter<uuid>Unique identifier
organization_idFilter<uuid>Identifier of the organization this coupon is defined in
created_atFilter<timestamp with time zone>Creation timestamp
updated_atFilter<timestamp with time zone>Last modification timestamp
deleted_atFilter<timestamp with time zone>Timestamp at which the coupon was deleted
codeFilter<text>Coupon code
definitionFilter<jsonb>Definition of the coupon
descriptionFilter<text>Description of the coupon
ftsFilter<tsvector>Full text search index
quotaFilter<integer>Maximum number of times this coupon can be used
scopeFilter<"global" | "product" | "service" | "rent">Scope of the coupon
Partial<Coupon>204The updated coupons with the selected columns
PATCH/couponscurl -X PATCH "https://api.bookingmood.com/v1/coupons" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{}'