Ask for availability
POST/availability-requests
Before you hold the customer's card, ask whether the slot can be booked and for how much. This creates no booking and reserves nothing.
status | HTTP | What to do |
|---|---|---|
confirmed | 201 | Hold expectedPayment.amount on the card and report it before expiresAt. |
pending | 202 | The activity needs All Out's confirmation. Do not hold yet. The answer comes by the availability_request.updated webhook; you can also read the request. |
unavailable | All Out said no. reason is written for you to show and alternatives lists other times to offer. | |
expired | The confirmation lapsed before a hold was reported. Make a new request. |
Sending the same partnerRequestReference again with the same details returns the same
request with HTTP 200. The same reference with different details is 409 REFERENCE_CONFLICT
(checked like a new request first, so 400 or 404 can come before it).
A confirmation given at once lasts 30 minutes; expiresAt always tells you. A confirmation is
not a reservation: if the provider closes the time, or the time passes, before your hold is
reported, the hold is refused (409 AVAILABILITY_EXPIRED) and no booking is made.
Other times. For an activity All Out confirms by hand, a "no" can come with alternatives.
To take one, send a new request with a new partnerRequestReference and that startTime, for the
same activity, option and party. It is confirmed at once (201), carries alternativeOf, and the
offer stands until alternativesExpireAt. Each offered time can be taken once.
Request
Responses
- 200
- 201
- 202
- 400
- 401
- 403
- 404
- 409
- 413
- 422
- 429
- 503
The same partnerRequestReference was sent again with the same details.
Confirmed at once.
Waiting for All Out's confirmation.
A field is missing or wrong. The message names it. Fix the request.
No token, an expired token, or wrong credentials (UNAUTHORIZED). Get a new token.
Your account is suspended (PARTNER_DISABLED), whatever token you hold. Contact All Out.
Not yours, not assigned to you, or does not exist (NOT_FOUND). Also a path or method that does not exist.
A conflict with the current state. error.code is one of REFERENCE_CONFLICT, AVAILABILITY_NOT_CONFIRMED,
AVAILABILITY_EXPIRED, PAYMENT_REFERENCE_CONFLICT, IDEMPOTENCY_CONFLICT, INVALID_PAYMENT_TRANSITION or
CANCELLATION_NOT_ALLOWED. See the error codes guide.
The JSON body is larger than 100 KB, or a document picture is larger than 5 MB (INVALID_REQUEST).
This activity cannot be priced right now (UNPRICEABLE). Contact All Out.
Too many requests (RATE_LIMITED). Wait the seconds in the Retry-After header.
Response Headers
Seconds to wait.
The service did not answer (UNAVAILABLE). The outcome may be unknown. Retry with the same Idempotency-Key, or read the booking.