curl --request POST \
--url https://apiv2.gomarketbox.com/v1/projects/{projectId}/suppliers/me/bookings/{bookingId}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"reasonCode": "SUPPLIER_UNAVAILABLE",
"note": "Pool closed for maintenance that morning."
}
'import requests
url = "https://apiv2.gomarketbox.com/v1/projects/{projectId}/suppliers/me/bookings/{bookingId}/cancel"
payload = {
"reasonCode": "SUPPLIER_UNAVAILABLE",
"note": "Pool closed for maintenance that morning."
}
headers = {
"x-api-key": "<api-key>",
"Authorization": "Bearer <token>",
"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>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
reasonCode: 'SUPPLIER_UNAVAILABLE',
note: 'Pool closed for maintenance that morning.'
})
};
fetch('https://apiv2.gomarketbox.com/v1/projects/{projectId}/suppliers/me/bookings/{bookingId}/cancel', 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}/suppliers/me/bookings/{bookingId}/cancel",
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([
'reasonCode' => 'SUPPLIER_UNAVAILABLE',
'note' => 'Pool closed for maintenance that morning.'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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}/suppliers/me/bookings/{bookingId}/cancel"
payload := strings.NewReader("{\n \"reasonCode\": \"SUPPLIER_UNAVAILABLE\",\n \"note\": \"Pool closed for maintenance that morning.\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Authorization", "Bearer <token>")
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}/suppliers/me/bookings/{bookingId}/cancel")
.header("x-api-key", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reasonCode\": \"SUPPLIER_UNAVAILABLE\",\n \"note\": \"Pool closed for maintenance that morning.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.gomarketbox.com/v1/projects/{projectId}/suppliers/me/bookings/{bookingId}/cancel")
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["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reasonCode\": \"SUPPLIER_UNAVAILABLE\",\n \"note\": \"Pool closed for maintenance that morning.\"\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"
}Cancel one of the signed-in supplier’s bookings
The supplier cancels their own booking, exactly as from the MarketBox dashboard: only a SCHEDULED booking, only when its service lets suppliers cancel (403 PARTICIPANT_ACTION_DISABLED), and only outside the service’s notice window (409 NOTICE_WINDOW_PASSED). Recorded as supplier-initiated, by the signed-in person; a package session goes back on the package; no refund is made. The client and the business are emailed. A booking that is not the supplier’s is a 404, indistinguishable from a missing one. Requires the API key and the supplier’s user token.
curl --request POST \
--url https://apiv2.gomarketbox.com/v1/projects/{projectId}/suppliers/me/bookings/{bookingId}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"reasonCode": "SUPPLIER_UNAVAILABLE",
"note": "Pool closed for maintenance that morning."
}
'import requests
url = "https://apiv2.gomarketbox.com/v1/projects/{projectId}/suppliers/me/bookings/{bookingId}/cancel"
payload = {
"reasonCode": "SUPPLIER_UNAVAILABLE",
"note": "Pool closed for maintenance that morning."
}
headers = {
"x-api-key": "<api-key>",
"Authorization": "Bearer <token>",
"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>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
reasonCode: 'SUPPLIER_UNAVAILABLE',
note: 'Pool closed for maintenance that morning.'
})
};
fetch('https://apiv2.gomarketbox.com/v1/projects/{projectId}/suppliers/me/bookings/{bookingId}/cancel', 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}/suppliers/me/bookings/{bookingId}/cancel",
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([
'reasonCode' => 'SUPPLIER_UNAVAILABLE',
'note' => 'Pool closed for maintenance that morning.'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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}/suppliers/me/bookings/{bookingId}/cancel"
payload := strings.NewReader("{\n \"reasonCode\": \"SUPPLIER_UNAVAILABLE\",\n \"note\": \"Pool closed for maintenance that morning.\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Authorization", "Bearer <token>")
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}/suppliers/me/bookings/{bookingId}/cancel")
.header("x-api-key", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reasonCode\": \"SUPPLIER_UNAVAILABLE\",\n \"note\": \"Pool closed for maintenance that morning.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.gomarketbox.com/v1/projects/{projectId}/suppliers/me/bookings/{bookingId}/cancel")
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["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reasonCode\": \"SUPPLIER_UNAVAILABLE\",\n \"note\": \"Pool closed for maintenance that morning.\"\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"
}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
Why