Remove an order item
curl --request DELETE \
--url https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders/{orderId}/items/{orderItemId} \
--header 'x-api-key: <api-key>'import requests
url = "https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders/{orderId}/items/{orderItemId}"
headers = {"x-api-key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};
fetch('https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders/{orderId}/items/{orderItemId}', 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}/orders/{orderId}/items/{orderItemId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders/{orderId}/items/{orderItemId}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders/{orderId}/items/{orderItemId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders/{orderId}/items/{orderItemId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"order": {
"projectId": "<string>",
"tenantId": "<string>",
"orderId": "<string>",
"clientId": "<string>",
"currency": "<string>",
"subtotal": {
"amount": 1,
"currency": "<string>"
},
"tax": {
"amount": 1,
"currency": "<string>"
},
"total": {
"amount": 1,
"currency": "<string>"
},
"amountPaid": {
"amount": 1,
"currency": "<string>"
},
"amountRefunded": {
"amount": 1,
"currency": "<string>"
},
"status": "DRAFT",
"statusUpdatedAt": "2023-11-07T05:31:56Z",
"deleted": true,
"version": 1,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedBy": "<string>",
"feeTotal": {
"amount": 1,
"currency": "<string>"
},
"cancellationReason": "<string>",
"cancelledBy": "<string>",
"paymentMethod": "STRIPE",
"settledAt": "2023-11-07T05:31:56Z",
"amountComped": {
"amount": 1,
"currency": "<string>"
},
"pricingRegion": {
"country": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"locale": "<string>",
"attribution": {
"searchId": "srch_01k7q3x9h4e8rb2d6m0z5a7c1n",
"sessionKey": "sess-example-01",
"surface": "results"
}
},
"items": [
{
"projectId": "<string>",
"orderId": "<string>",
"orderItemId": "<string>",
"skuType": "SINGLE_SESSION",
"serviceId": "<string>",
"offeringId": "<string>",
"quantity": 1,
"quantityAllocated": 1,
"quantityRemaining": 1,
"unitPrice": {
"amount": 1,
"currency": "<string>"
},
"lineTotal": {
"amount": 1,
"currency": "<string>"
},
"deleted": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedBy": "<string>",
"packageId": "<string>",
"taxSnapshot": {
"taxable": true,
"taxPercentage": 1
},
"feeSnapshot": [
{
"feeId": "fee_booking",
"name": {
"en": "Booking fee"
},
"calculation": "FLAT",
"amount": 2500,
"percentage": 5,
"taxable": false
}
],
"businessModelId": "<string>",
"label": {},
"priceRuleId": "<string>",
"priceScope": "DEFAULT",
"priceSource": "RULE",
"taxExemptReason": "NO_RATE",
"expiresAt": "2023-11-07T05:31:56Z"
}
],
"summary": {
"currency": "<string>",
"lines": [
{
"orderItemId": "<string>",
"label": {},
"skuType": "SINGLE_SESSION",
"quantity": 1,
"unitPrice": {
"amount": 1,
"currency": "<string>"
},
"lineTotal": {
"amount": 1,
"currency": "<string>"
},
"tax": {
"amount": 1,
"currency": "<string>"
},
"taxable": true,
"priceRuleId": "<string>",
"priceScope": "DEFAULT"
}
],
"fees": [
{
"feeId": "<string>",
"businessModelId": "<string>",
"name": {},
"calculation": "FLAT",
"basis": {
"amount": 1,
"currency": "<string>"
},
"amount": {
"amount": 1,
"currency": "<string>"
},
"tax": {
"amount": 1,
"currency": "<string>"
},
"taxable": true,
"percentage": 123
}
],
"feeTotal": {
"amount": 1,
"currency": "<string>"
},
"subtotal": {
"amount": 1,
"currency": "<string>"
},
"taxTotal": {
"amount": 1,
"currency": "<string>"
},
"total": {
"amount": 1,
"currency": "<string>"
},
"amountPaid": {
"amount": 1,
"currency": "<string>"
},
"amountRefunded": {
"amount": 1,
"currency": "<string>"
},
"amountDue": {
"amount": 1,
"currency": "<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"
}Orders
Remove an order item
Drops the line and returns the order with its recalculated totals. Removing a PACKAGE line does not retract bookings already drawn from it, so check GET /orders/{orderId}/package-bookings?orderItemId= before removing one that has been booked against.
DELETE
/
v1
/
projects
/
{projectId}
/
orders
/
{orderId}
/
items
/
{orderItemId}
Remove an order item
curl --request DELETE \
--url https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders/{orderId}/items/{orderItemId} \
--header 'x-api-key: <api-key>'import requests
url = "https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders/{orderId}/items/{orderItemId}"
headers = {"x-api-key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};
fetch('https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders/{orderId}/items/{orderItemId}', 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}/orders/{orderId}/items/{orderItemId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders/{orderId}/items/{orderItemId}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders/{orderId}/items/{orderItemId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders/{orderId}/items/{orderItemId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"order": {
"projectId": "<string>",
"tenantId": "<string>",
"orderId": "<string>",
"clientId": "<string>",
"currency": "<string>",
"subtotal": {
"amount": 1,
"currency": "<string>"
},
"tax": {
"amount": 1,
"currency": "<string>"
},
"total": {
"amount": 1,
"currency": "<string>"
},
"amountPaid": {
"amount": 1,
"currency": "<string>"
},
"amountRefunded": {
"amount": 1,
"currency": "<string>"
},
"status": "DRAFT",
"statusUpdatedAt": "2023-11-07T05:31:56Z",
"deleted": true,
"version": 1,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedBy": "<string>",
"feeTotal": {
"amount": 1,
"currency": "<string>"
},
"cancellationReason": "<string>",
"cancelledBy": "<string>",
"paymentMethod": "STRIPE",
"settledAt": "2023-11-07T05:31:56Z",
"amountComped": {
"amount": 1,
"currency": "<string>"
},
"pricingRegion": {
"country": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"locale": "<string>",
"attribution": {
"searchId": "srch_01k7q3x9h4e8rb2d6m0z5a7c1n",
"sessionKey": "sess-example-01",
"surface": "results"
}
},
"items": [
{
"projectId": "<string>",
"orderId": "<string>",
"orderItemId": "<string>",
"skuType": "SINGLE_SESSION",
"serviceId": "<string>",
"offeringId": "<string>",
"quantity": 1,
"quantityAllocated": 1,
"quantityRemaining": 1,
"unitPrice": {
"amount": 1,
"currency": "<string>"
},
"lineTotal": {
"amount": 1,
"currency": "<string>"
},
"deleted": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedBy": "<string>",
"packageId": "<string>",
"taxSnapshot": {
"taxable": true,
"taxPercentage": 1
},
"feeSnapshot": [
{
"feeId": "fee_booking",
"name": {
"en": "Booking fee"
},
"calculation": "FLAT",
"amount": 2500,
"percentage": 5,
"taxable": false
}
],
"businessModelId": "<string>",
"label": {},
"priceRuleId": "<string>",
"priceScope": "DEFAULT",
"priceSource": "RULE",
"taxExemptReason": "NO_RATE",
"expiresAt": "2023-11-07T05:31:56Z"
}
],
"summary": {
"currency": "<string>",
"lines": [
{
"orderItemId": "<string>",
"label": {},
"skuType": "SINGLE_SESSION",
"quantity": 1,
"unitPrice": {
"amount": 1,
"currency": "<string>"
},
"lineTotal": {
"amount": 1,
"currency": "<string>"
},
"tax": {
"amount": 1,
"currency": "<string>"
},
"taxable": true,
"priceRuleId": "<string>",
"priceScope": "DEFAULT"
}
],
"fees": [
{
"feeId": "<string>",
"businessModelId": "<string>",
"name": {},
"calculation": "FLAT",
"basis": {
"amount": 1,
"currency": "<string>"
},
"amount": {
"amount": 1,
"currency": "<string>"
},
"tax": {
"amount": 1,
"currency": "<string>"
},
"taxable": true,
"percentage": 123
}
],
"feeTotal": {
"amount": 1,
"currency": "<string>"
},
"subtotal": {
"amount": 1,
"currency": "<string>"
},
"taxTotal": {
"amount": 1,
"currency": "<string>"
},
"total": {
"amount": 1,
"currency": "<string>"
},
"amountPaid": {
"amount": 1,
"currency": "<string>"
},
"amountRefunded": {
"amount": 1,
"currency": "<string>"
},
"amountDue": {
"amount": 1,
"currency": "<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"
}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.