External OPS API (2.0.0)

Download OpenAPI specification:Download

E-mail: dev@bode.co

This is an API that can be leveraged by any external consumer

statistics

Endpoints dedicated to returning statistical values

Returns revenue of nights booked at given date

path Parameters

propertyId

required

integer <int64>

Example: 6366

Cloudbeds property identifier

query Parameters

at	string <date> Example: at=2019-01-02 Date of reservation creation (booked at)
from	string <date> Example: from=2019-05-01 When used together with "to", it limits revenue returned to only nights within from..to range
to	string <date> Example: to=2019-05-10 When used together with "from", it limits revenue returned to only nights within from..to range

Responses

200

Statistic was returned successfully

400

Bad request - most likely due to missing query parameters

get /properties/{propertyId}/revenue_booked

Production OPS API

https://ops.bodeapp.com/v2/properties/{propertyId}/revenue_booked

Staging OPS API

https://bode-ops-app-staging.herokuapp.com/v2/properties/{propertyId}/revenue_booked

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
{"type": "statistics",
"id": "revenue_booked",
"attributes": 
{"value": 1900.5
}
}
}

Returns revenue target for reservations

path Parameters

propertyId

required

integer <int64>

Example: 6366

Cloudbeds property identifier

query Parameters

year required	integer Example: year=2022 Year target applies to
month	integer (monthNumber) [ 1 .. 12 ] Example: month=2 Month target applies to

Responses

200

Statistic was returned successfully

400

Bad request - most likely due to missing query parameters

get /properties/{propertyId}/rooms_revenue_target

Production OPS API

https://ops.bodeapp.com/v2/properties/{propertyId}/rooms_revenue_target

Staging OPS API

https://bode-ops-app-staging.herokuapp.com/v2/properties/{propertyId}/rooms_revenue_target

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
{"type": "statistics",
"id": "rooms_revenue_target",
"attributes": 
{"value": 1900.5
}
}
}

Returns revenue target for food and beverage

path Parameters

propertyId

required

integer <int64>

Example: 6366

Cloudbeds property identifier

query Parameters

year required	integer Example: year=2022 Year target applies to
month	integer (monthNumber) [ 1 .. 12 ] Example: month=2 Month target applies to

Responses

200

Statistic was returned successfully

400

Bad request - most likely due to missing query parameters

get /properties/{propertyId}/fab_revenue_target

Production OPS API

https://ops.bodeapp.com/v2/properties/{propertyId}/fab_revenue_target

Staging OPS API

https://bode-ops-app-staging.herokuapp.com/v2/properties/{propertyId}/fab_revenue_target

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
{"type": "statistics",
"id": "fab_revenue_target",
"attributes": 
{"value": 1900.5
}
}
}

Returns global revenue target (rooms + food and beverage)

path Parameters

propertyId

required

integer <int64>

Example: 6366

Cloudbeds property identifier

query Parameters

year required	integer Example: year=2022 Year target applies to
month	integer (monthNumber) [ 1 .. 12 ] Example: month=2 Month target applies to

Responses

200

Statistic was returned successfully

400

Bad request - most likely due to missing query parameters

get /properties/{propertyId}/revenue_target

Production OPS API

https://ops.bodeapp.com/v2/properties/{propertyId}/revenue_target

Staging OPS API

https://bode-ops-app-staging.herokuapp.com/v2/properties/{propertyId}/revenue_target

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
{"type": "statistics",
"id": "revenue_target",
"attributes": 
{"value": 1900.5
}
}
}

Returns shopify revenue

Returns shopify revenue. When no parameters are provided, it returns total shoopify revenue for given property.

path Parameters

propertyId

required

integer <int64>

Example: 6366

Cloudbeds property identifier

query Parameters

at	string <date> Example: at=2019-01-02 Filters shopify revenue to one received certain day. Parameter cannot be used together with from/to
from	string <date> Example: from=2019-05-01 Filters shopify revenue to one received after and including given day. Parameter cannot be used together with "at"
to	string <date> Example: to=2019-05-10 Filters shopify revenue to one received before and including given day. Parameter cannot be used together with "at"

Responses

200

Statistic was returned successfully

400

Bad request - most likely due to missing query parameters

get /properties/{propertyId}/shopify_revenue

Production OPS API

https://ops.bodeapp.com/v2/properties/{propertyId}/shopify_revenue

Staging OPS API

https://bode-ops-app-staging.herokuapp.com/v2/properties/{propertyId}/shopify_revenue

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
{"type": "statistics",
"id": "shopify_revenue",
"attributes": 
{"value": 1900.5
}
}
}