GET

List Policy Snapshots By Booking Ids


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of booking policy snapshots by booking IDs.

Permissions
Manage Bookings Services and Settings
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Public Data
Read Bookings - Including Participants
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/_api/booking-policy-snapshots/v1/policy-snapshots

Query Params
bookingIdsArray <string>Required

List of booking IDs to retrieve policy snapshots for.

Response Object
bookingPolicySnapshotsArray <BookingPolicySnapshot>

Retrieved booking Policy snapshots.

List policy snapshots by booking IDs
Request
cURL
curl -X GET \ 'https://www.wixapis.com/_api/booking-policy-snapshots/v1/policy-snapshots?bookingIds=353aa3b7-00ef-42bd-86ff-720d7ef60443' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "booking_policy_snapshots": [ { "id": "c82a3f42-7605-4e24-91f5-7517ae189b7d", "booking_id": "353aa3b7-00ef-42bd-86ff-720d7ef60443", "policy": { "id": "7f31c2b3-9e6e-4b5f-b589-d524f1b3c872", "revision": 5, "created_date": "2024-01-10T10:30:00Z", "updated_date": "2024-05-20T15:45:00Z", "name": "Standard Booking Policy", "custom_policy_description": { "enabled": true, "description": "This is the standard booking policy description." }, "default": true, "cancellation_policy": { "enabled": true, "limit_latest_cancellation": false, "latest_cancellation_in_minutes": 1440 }, "reschedule_policy": { "enabled": true, "limit_latest_reschedule": false, "latest_reschedule_in_minutes": 1440 }, "cancellation_fee_policy": { "enabled": true, "cancellation_windows": [ { "amount": { "value": "10", "currency": "USD", "formatted_value": null }, "start_in_minutes": 1440 } ] }, "save_credit_card_policy": { "enabled": true } }, "created_date": "2024-06-15T10:45:00Z" } ] }
Errors
404Not Found

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?