curl --request POST \
--url https://apiv2.gomarketbox.com/v1/projects/{projectId}/bookings/{bookingId}/status \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"cancellationReason": "<string>",
"creditTreatment": "FORFEIT"
}
'import requests
url = "https://apiv2.gomarketbox.com/v1/projects/{projectId}/bookings/{bookingId}/status"
payload = {
"cancellationReason": "<string>",
"creditTreatment": "FORFEIT"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({cancellationReason: '<string>', creditTreatment: 'FORFEIT'})
};
fetch('https://apiv2.gomarketbox.com/v1/projects/{projectId}/bookings/{bookingId}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apiv2.gomarketbox.com/v1/projects/{projectId}/bookings/{bookingId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'cancellationReason' => '<string>',
'creditTreatment' => 'FORFEIT'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://apiv2.gomarketbox.com/v1/projects/{projectId}/bookings/{bookingId}/status"
payload := strings.NewReader("{\n \"cancellationReason\": \"<string>\",\n \"creditTreatment\": \"FORFEIT\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://apiv2.gomarketbox.com/v1/projects/{projectId}/bookings/{bookingId}/status")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cancellationReason\": \"<string>\",\n \"creditTreatment\": \"FORFEIT\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.gomarketbox.com/v1/projects/{projectId}/bookings/{bookingId}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cancellationReason\": \"<string>\",\n \"creditTreatment\": \"FORFEIT\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"projectId": "<string>",
"tenantId": "<string>",
"bookingId": "<string>",
"supplierId": "<string>",
"clientId": "<string>",
"bookingStartUtc": "2023-11-07T05:31:56Z",
"bookingEndUtc": "2023-11-07T05:31:56Z",
"bookingTz": "<string>",
"bookingLocalDate": "<string>",
"bookingLocalStartTime": "<string>",
"bookingLocalEndTime": "<string>",
"bookingLocalEndDate": "<string>",
"locationType": "PHYSICAL",
"locationId": "<string>",
"latitude": 123,
"longitude": 123,
"address": {
"addressOneLine": "10 Main St, Toronto, ON M5V 1A1, Canada",
"streetNumber": "10",
"streetName": "Main St",
"city": "Toronto",
"state": "ON",
"country": "CA",
"zipCode": "M5V 1A1",
"unitNumber": "4B"
},
"capacity": 1,
"participantCount": 1,
"waitlistCount": 1,
"isGroupBooking": true,
"status": "SCHEDULED",
"statusUpdatedAt": "2023-11-07T05:31:56Z",
"counts": {
"services": 1,
"notes": 1,
"participants": 1
},
"deleted": true,
"version": 1,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedBy": "<string>",
"seriesId": "<string>",
"occurrenceLocalDate": "<string>",
"isException": true,
"packageOrderItemId": "<string>",
"locale": "<string>",
"attribution": {
"searchId": "srch_01k7q3x9h4e8rb2d6m0z5a7c1n",
"sessionKey": "sess-example-01",
"surface": "results"
},
"statusUpdatedBy": "<string>",
"statusUpdatedByCapacity": "ADMIN",
"cancellationReason": "<string>",
"cancelledBy": "<string>",
"cancellationInitiatedBy": "CLIENT",
"cancellationReasonCode": "CLIENT_REQUESTED",
"creditTreatment": "RETURN",
"durationOverrideMinutes": 720,
"durationOverrideReason": "<string>"
}
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}Change a booking status
Moves the booking through its lifecycle. The status enum on the request body is the authoritative list of what a caller may ASK for — it is narrower than the status on the response, because SCHEDULED and DISPUTED are states a booking is put into by the platform and can only be observed, never requested.
Which of the settable statuses your key may actually use also depends on where the booking is now and on the capacity of the caller. An API key cannot resolve a dispute, and cannot reverse a settled booking back to AWAITING_CONFIRMATION: both decide between two accounts of what happened, and are reserved for an operator in the MarketBox console. Nor can it cancel a booking that is AWAITING_CONFIRMATION: the session has taken place, and cancelling it would void the supplier’s claim to be paid. Settle it instead (COMPLETED or a no-show).
NO_SHOW can no longer be SET. Use CLIENT_NO_SHOW or SUPPLIER_NO_SHOW, which record which side was absent; sending NO_SHOW returns a 400 naming the value. It remains a status a booking can CARRY and is still returned by every read: bookings recorded before the split keep it indefinitely and are not being migrated, because nobody ever recorded which party failed to show and we will not guess. A consumer switching exhaustively on booking status must keep handling it.
A transition the booking cannot make from where it currently stands is a 400 naming that current status, so a rejection tells you what to retry from. Returns 409 if the booking changed underneath you.
Cancelling releases the supplier time and settles the order item the booking drew on, atomically with the status change. For a PACKAGE session the credit goes back to the order item by default (quantityRemaining rises by the quantity the session used, and a CREDIT_REVERSAL transaction is recorded against the original CREDIT_REDEMPTION). Send creditTreatment: "FORFEIT" to keep the session spent instead — a late cancellation, say; "RETURN" states the default explicitly. A booking made against a single-session order item holds no reusable credit: cancelling it closes its allocation and returns no quantity, and sending creditTreatment for one is a 422 NO_SESSION_CREDIT with nothing cancelled. creditTreatment is only valid with CANCELLED. This route never moves money.
curl --request POST \
--url https://apiv2.gomarketbox.com/v1/projects/{projectId}/bookings/{bookingId}/status \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"cancellationReason": "<string>",
"creditTreatment": "FORFEIT"
}
'import requests
url = "https://apiv2.gomarketbox.com/v1/projects/{projectId}/bookings/{bookingId}/status"
payload = {
"cancellationReason": "<string>",
"creditTreatment": "FORFEIT"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({cancellationReason: '<string>', creditTreatment: 'FORFEIT'})
};
fetch('https://apiv2.gomarketbox.com/v1/projects/{projectId}/bookings/{bookingId}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apiv2.gomarketbox.com/v1/projects/{projectId}/bookings/{bookingId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'cancellationReason' => '<string>',
'creditTreatment' => 'FORFEIT'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://apiv2.gomarketbox.com/v1/projects/{projectId}/bookings/{bookingId}/status"
payload := strings.NewReader("{\n \"cancellationReason\": \"<string>\",\n \"creditTreatment\": \"FORFEIT\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://apiv2.gomarketbox.com/v1/projects/{projectId}/bookings/{bookingId}/status")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cancellationReason\": \"<string>\",\n \"creditTreatment\": \"FORFEIT\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.gomarketbox.com/v1/projects/{projectId}/bookings/{bookingId}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cancellationReason\": \"<string>\",\n \"creditTreatment\": \"FORFEIT\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"projectId": "<string>",
"tenantId": "<string>",
"bookingId": "<string>",
"supplierId": "<string>",
"clientId": "<string>",
"bookingStartUtc": "2023-11-07T05:31:56Z",
"bookingEndUtc": "2023-11-07T05:31:56Z",
"bookingTz": "<string>",
"bookingLocalDate": "<string>",
"bookingLocalStartTime": "<string>",
"bookingLocalEndTime": "<string>",
"bookingLocalEndDate": "<string>",
"locationType": "PHYSICAL",
"locationId": "<string>",
"latitude": 123,
"longitude": 123,
"address": {
"addressOneLine": "10 Main St, Toronto, ON M5V 1A1, Canada",
"streetNumber": "10",
"streetName": "Main St",
"city": "Toronto",
"state": "ON",
"country": "CA",
"zipCode": "M5V 1A1",
"unitNumber": "4B"
},
"capacity": 1,
"participantCount": 1,
"waitlistCount": 1,
"isGroupBooking": true,
"status": "SCHEDULED",
"statusUpdatedAt": "2023-11-07T05:31:56Z",
"counts": {
"services": 1,
"notes": 1,
"participants": 1
},
"deleted": true,
"version": 1,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedBy": "<string>",
"seriesId": "<string>",
"occurrenceLocalDate": "<string>",
"isException": true,
"packageOrderItemId": "<string>",
"locale": "<string>",
"attribution": {
"searchId": "srch_01k7q3x9h4e8rb2d6m0z5a7c1n",
"sessionKey": "sess-example-01",
"surface": "results"
},
"statusUpdatedBy": "<string>",
"statusUpdatedByCapacity": "ADMIN",
"cancellationReason": "<string>",
"cancelledBy": "<string>",
"cancellationInitiatedBy": "CLIENT",
"cancellationReasonCode": "CLIENT_REQUESTED",
"creditTreatment": "RETURN",
"durationOverrideMinutes": 720,
"durationOverrideReason": "<string>"
}
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}Authorizations
API key minted in the MarketBox dashboard. Scope is restricted to the projects you select at creation time. Every route needs the key's standard API access (*) except POST /v1/projects/{projectId}/events, which needs events:write; a key without * is refused with 403 CAPABILITY_NOT_GRANTED.
Path Parameters
Body
New status
CANCELLED only. What happens to a package session credit: RETURN (the default when omitted) puts the session back on the order item; FORFEIT keeps it spent. Sending it for a booking that is not a package session is a 422 NO_SESSION_CREDIT.
RETURN, FORFEIT "FORFEIT"