Shopping test requests
Test your handling of possible shopping error states.
Important notes
- To send a test request for the Rapid Shopping API method, include an additional HTTP header named test in your booking request and use the appropriate value from the tables below.
- Failing to send a test header or sending an invalid test header will cause the shopping to be processed live.
- Using a test header returns a static 'canned' response. Therefore, rates/content etc. returned may not be relevant with the properties being tested.
- A Price Check token or link returned from a Shop request using a test header should not be reused in a stubbed Price Check request. Attempting to reuse that token or link may result in 400
invalid_input. - For Rapid Price Check when using a test header, the request should be formatted as
/properties/{property_id}/rooms/{room_id}/rates/{rate_id}. - When a valid test header value is included, the
property_id,room_id, andrate_iddo not need to come from a previous Shop response. Any numeric values can be used to return the canned Price Check response.
Shop
| Test header value | HTTP code and response | Status |
|---|---|---|
standard | 200 - Standard response | available |
no_availability | 200 - Standard response | sold_out |
unknown_internal_error | 500 - Internal error | N/A |
service_unavailable | 503 - Service unavailable error | N/A |
marketing_fee_details | 200 - Standard response | available |
Price Check
| Test header value | HTTP code and response | Status |
|---|---|---|
available | 200 - Standard response | available |
price_changed | 200 - Standard response | price_changed |
sold_out | 200 - Standard response | sold_out |
unknown_internal_error | 500 - Internal error | NA |
service_unavailable | 503 - Service unavailable error | NA |
marketing_fee_details | 200 - Standard response | available |
Deposit policy
| Test header value | HTTP code and response |
|---|---|
all | 200 - Standard response with all options |
night | 200 - Standard night-based deposit response |
amount | 200 - Standard amount-based deposit response |
percent | 200 - Standard percentage-based deposit response |
remainder | 200 - Standard remainder-based deposit response |
unknown_internal_error | 500 - Internal error |
service_unavailable | 503 - Service unavailable error |
For more information on HTTP error codes see common error responses.