Special Offers
Overview
This resource represents Special Offers which are the Rental's price (as initial_price in Booking) modifiers, making it possible to provide special discounts during certain periods.
Parameters
- OAuth Scopes:
- public
- rates_write
| Name | Type | Read/Write | Description |
|---|---|---|---|
| account | Integer | Read | Account's ID related to the SpecialOffer |
| rental | Integer | Read | Rental's ID related to the SpecialOffer |
| id | Integer | Read | SpecialOffer's id. |
| discount | Float | Read | Special Offer's discount in percents. |
| name | Object | Read | SpecialOffer's name, list of locales described in enums section. |
| created_at | Time | Read | SpecialOffer's create time. |
| updated_at | Time | Read | SpecialOffer's update time. |
| start_date | Date | Read | SpecialOffer's start date. |
| end_date | Date | Read | SpecialOffer's end date. |
| Name | Type | Read/Write | Description | Constraints |
|---|---|---|---|---|
| account | Integer | Read | Account's ID related to the SpecialOffer | |
| rental | Integer | Read | Rental's ID related to the SpecialOffer | |
| id | Integer | Read | SpecialOffer's id | |
| discount | Float | Read/Write | Required. Special Offer's discount in percents. (between 1 and 100) | Required, must be between 1 (exclusive) and 100 (inclusive) |
| name | Object | Read | SpecialOffer's name, list of locales described in enums section | |
| name_locale | String | Write | SpecialOffer's name, used in write operations. Replace the locale with one of the locales described in enums section (e.g. name_en). Multiple of these attributes could be passed in the same operation, as long as they each have a unique locale (e.g name_en and name_fr) | Required for Account's default locale, maximum length: 25 |
| created_at | Time | Read | SpecialOffer's create time | |
| updated_at | Time | Read | SpecialOffer's update time | |
| start_date | Date | Read/Write | SpecialOffer's start date. | Required, must be before end_date, cannot be in the past |
| end_date | Date | Read/Write | SpecialOffer's end date. | Required, must be after start_date |
List special offers
List all special offers for a given account(s).
GET /special_offers
- OAuth Scopes:
- public
response.json
{
"links": {
"special_offers.rental": "https://www.bookingsync.com/api/v3/rentals/{special_offers.rental}"
},
"special_offers": [
{
"links": {
"rental": 1
},
"id": 1,
"name": {
"en": "Special offer for 1"
},
"start_date": "2025-04-21",
"end_date": "2025-04-28",
"discount": 10,
"created_at": "2025-03-31T17:52:12.721Z",
"updated_at": "2025-04-07T17:52:12.721Z"
}
]
}
Get a single special offer
Returns a single special offer identified by ID.
GET /special_offers/:special_offer_id
- OAuth Scopes:
- public
response.json
{
"links": {
"special_offers.rental": "https://www.bookingsync.com/api/v3/rentals/{special_offers.rental}"
},
"special_offers": [
{
"links": {
"rental": 1
},
"id": 1,
"name": {
"en": "Special offer for 1"
},
"start_date": "2025-04-21",
"end_date": "2025-04-28",
"discount": 10,
"created_at": "2025-03-31T17:52:12.722Z",
"updated_at": "2025-04-07T17:52:12.722Z"
}
]
}
Create a new special offer
Creates a special offer for given rental.
POST /rentals/:rental_id/special_offers
- OAuth Scopes:
- rates_write
request.json
{
"special_offers": [
{
"name_en": "Special offer for 1",
"start_date": "2025-04-21",
"end_date": "2025-04-28",
"discount": 10
}
]
}
response.json
{
"links": {
"special_offers.rental": "https://www.bookingsync.com/api/v3/rentals/{special_offers.rental}"
},
"special_offers": [
{
"links": {
"rental": 1
},
"id": 1,
"name": {
"en": "Special offer for 1"
},
"start_date": "2025-04-21",
"end_date": "2025-04-28",
"discount": 10,
"created_at": "2025-03-31T17:52:12.723Z",
"updated_at": "2025-04-07T17:52:12.723Z"
}
]
}
Update a special offer
Returns an updated special offer identified by ID.
PUT /special_offers/:special_offer
- OAuth Scopes:
- rates_write
request.json
{
"special_offers": [
{
"name_en": "Special offer for 1",
"start_date": "2025-04-21",
"end_date": "2025-04-28",
"discount": 10
}
]
}
response.json
{
"links": {
"special_offers.rental": "https://www.bookingsync.com/api/v3/rentals/{special_offers.rental}"
},
"special_offers": [
{
"links": {
"rental": 1
},
"id": 1,
"name": {
"en": "Special offer for 1"
},
"start_date": "2025-04-21",
"end_date": "2025-04-28",
"discount": 10,
"created_at": "2025-03-31T17:52:12.724Z",
"updated_at": "2025-04-07T17:52:12.724Z"
}
]
}
Destroy a special offer
Required OAuth scope: :rates_write
Returns empty response with 204 No Content status code on success.
DELETE /special_offers/:special_offer_id