Offerings
Search for offerings
Use this endpoint to search for different offering types.
get/shop/offering-search
Query parameters
offering_typeOfferingType[]
Filter by specific offering types.
[ "appointment" ]
practitioner_idstring[]
Filter by specific practitioner IDs.
querystring
Provide a search query to match offerings against.
site_idstring uuid required
The site ID the offerings belong to.
pageinteger
The page to retrieve results from
per_pageinteger
The number of results to return per page
sort'name'
How to order the results.
Response
Successfully retrieved offerings.
Example response
{
"data": [
{
"offering_type": "appointment"
}
],
"meta": {
"from": 1,
"to": 2,
"total": 2,
"current_page": 1,
"last_page": 2,
"per_page": 15,
"path": "http://example.com/api"
},
"links": {
"first": "http://example.com?page=1",
"next": "https://example.com?page=3",
"prev": "https://example.com?page=1",
"last": "https://example.com?page=4"
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.