POST /api/v1/orders/cancel/{partner_reference}. A cancel that already happened answers 200 with already_cancelled true, so after a lost answer you simply send it again. After no answer, a 429 or a 5xx, it waits Retry-After, or 1, 2, 4, then 8 seconds with jitter, at most five times. A cancel is not a refund.
Prerequisites
MART_API_KEY: your API key, with theorders:writescope.MART_API_BASE:https://sandbox.mart.pswhile you build,https://mart.pswhen you go live.MART_PARTNER_REFERENCE: the reference you gave the order.
jq; Node 22.18 or later, which runs the .ts file as it is; Python 3.9 or later with httpx; PHP 7.4 or later with its curl extension; Go 1.22 or later; or Java 17 or later with Jackson (jackson-databind). Each file reads its variables from the environment and sets a timeout on every call. Run it on your own server: a browser or an app never holds the key.
Run the recipe
#!/usr/bin/env bash
# Cancel an order you created, by your own reference. Repeating it is safe.
# Needs MART_API_BASE, MART_API_KEY and MART_PARTNER_REFERENCE.
set -euo pipefail
reference=${MART_PARTNER_REFERENCE:?set MART_PARTNER_REFERENCE to the order\'s reference}
# A cancel that already happened answers 200 with already_cancelled true, so after no answer, a
# 429 or a 5xx the recovery is to send it again. Retries are your choice of numbers: at most 5
# attempts, waiting what Retry-After says, or else 1, 2, 4, 8 seconds (capped at 30) with jitter.
for attempt in 1 2 3 4 5; do
response=$(curl --silent --show-error --max-time 30 --request POST \
--header @<(printf 'Authorization: Bearer %s\n' "$MART_API_KEY") --header 'Content-Type: application/json' \
--data '{"reason": "The customer changed their mind"}' --write-out '\n%{http_code} %header{retry-after}' \
"$MART_API_BASE/api/v1/orders/cancel/$(jq -rn --arg r "$reference" '$r | @uri')") || response=$'\n000'
read -r status retry_after <<<"${response##*$'\n'}"
body=${response%$'\n'*}
case $status in 000 | 429 | 500 | 502 | 503 | 504) ;; *) break ;; esac
[ "$attempt" = 5 ] && break
if [[ $retry_after =~ ^[0-9]+$ ]]; then
if [ "$retry_after" -gt 60 ]; then
echo "error: $status, try again after $retry_after s" >&2
exit 1
fi
wait_ms=$((retry_after * 1000))
else
wait_ms=$((1000 << (attempt - 1)))
[ "$wait_ms" -gt 30000 ] && wait_ms=30000
wait_ms=$((wait_ms / 2 + RANDOM % (wait_ms / 2 + 1)))
fi
printf 'retry: attempt %d %s, waiting %d.%d s\n' "$attempt" \
"$([ "$status" = 000 ] && echo 'got no answer' || echo "answered $status")" $((wait_ms / 1000)) $((wait_ms % 1000 / 100)) >&2
sleep "$((wait_ms / 1000)).$(printf '%03d' $((wait_ms % 1000)))"
done
if [ "$status" = 000 ]; then
echo "error: no answer; send the cancel again later" >&2
exit 1
fi
if [ "$status" -ge 300 ]; then
echo "error: $status $(jq -r '.error.code' <<<"$body" 2>/dev/null || echo '(not JSON)')${retry_after:+, try again after $retry_after s}" >&2
exit 1
fi
jq -r '.data.order | "order: \(.partner_reference)\nstatus id: \(.status.id)\nalready cancelled: \(.already_cancelled)"' <<<"$body"
// Cancel an order you created, by your own reference. Repeating it is safe.
// Node 22.18 or later runs this .ts file as it is. Needs MART_API_BASE, MART_API_KEY and MART_PARTNER_REFERENCE.
const base = process.env.MART_API_BASE;
const key = process.env.MART_API_KEY;
const reference = process.env.MART_PARTNER_REFERENCE;
if (!base || !key || !reference) throw new Error('Set MART_API_BASE, MART_API_KEY and MART_PARTNER_REFERENCE');
const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
const RETRYABLE = new Set([429, 500, 502, 503, 504]);
// Retries are your choice of numbers: at most 5 attempts; after no answer, a 429 or a 5xx, wait
// what Retry-After says, or else 1, 2, 4, 8 seconds (capped at 30) with jitter. Any other answer
// is final. Every attempt sends the same bytes.
async function send(path: string, payload: string, timeoutMs: number): Promise<Response | null> {
for (let attempt = 1; ; attempt++) {
let response: Response | null = null;
try {
response = await fetch(`${base}${path}`, {
method: 'POST',
headers: { Authorization: `Bearer ${key}`, 'Content-Type': 'application/json' },
body: payload,
signal: AbortSignal.timeout(timeoutMs),
});
if (!RETRYABLE.has(response.status) || attempt === 5) return response;
} catch {
if (attempt === 5) return null; // no answer at all
}
let wait: number;
const retryAfter = Number(response?.headers.get('retry-after'));
if (response && Number.isInteger(retryAfter) && retryAfter > 0) {
if (retryAfter > 60) return response; // too long to wait here: the caller says when to come back
wait = retryAfter;
} else {
const backoff = Math.min(30, 2 ** (attempt - 1));
wait = backoff / 2 + (Math.random() * backoff) / 2;
}
console.error(`retry: attempt ${attempt} ${response ? `answered ${response.status}` : 'got no answer'}, waiting ${wait.toFixed(1)} s`);
await sleep(wait * 1000);
}
}
// A cancel that already happened answers 200 with already_cancelled true, so sending it again
// after no answer is the recovery.
const response = await send(`/api/v1/orders/cancel/${encodeURIComponent(reference)}`,
JSON.stringify({ reason: 'The customer changed their mind' }), 30_000);
const body = response ? await response.json().catch(() => null) : null;
if (response === null) {
console.error('error: no answer; send the cancel again later');
process.exit(1);
}
if (!response.ok || body === null) {
const when = response.headers.get('retry-after');
console.error(`error: ${response.status} ${body?.error?.code ?? '(not JSON)'}${when ? `, try again after ${when} s` : ''}`);
process.exit(1);
}
console.log(`order: ${body.data.order.partner_reference}`);
console.log(`status id: ${body.data.order.status.id}`);
console.log(`already cancelled: ${body.data.order.already_cancelled}`);
"""Cancel an order you created, by your own reference. Repeating it is safe. Python 3.9+, httpx.
Needs MART_API_BASE, MART_API_KEY and MART_PARTNER_REFERENCE.
"""
import os
import random
import sys
import time
from urllib.parse import quote
import httpx
TIMEOUT = 30
client = httpx.Client(
base_url=os.environ["MART_API_BASE"],
headers={"Authorization": f"Bearer {os.environ['MART_API_KEY']}"},
timeout=TIMEOUT,
)
reference = os.environ["MART_PARTNER_REFERENCE"]
def body_of(response: httpx.Response):
"""The JSON body, or None for an answer that is not JSON (an edge error page)."""
try:
return response.json()
except ValueError:
return None
RETRYABLE = {429, 500, 502, 503, 504}
def send(path: str, payload: dict):
"""POST the same payload until it is answered for good.
Retries are your choice of numbers: at most 5 attempts; after no answer, a 429 or a 5xx, wait
what Retry-After says, or else 1, 2, 4, 8 seconds (capped at 30) with jitter. Any other answer
is final. Returns None when no attempt got an answer.
"""
for attempt in range(1, 6):
response = None
try:
response = client.post(path, json=payload)
if response.status_code not in RETRYABLE or attempt == 5:
return response
except httpx.TransportError:
if attempt == 5:
return None
retry_after = response.headers.get("Retry-After", "") if response is not None else ""
if retry_after.isdigit() and int(retry_after) > 0:
if int(retry_after) > 60:
return response # too long to wait here: the caller says when to come back
wait = float(retry_after)
else:
backoff = min(30, 2 ** (attempt - 1))
wait = backoff / 2 + random.uniform(0, backoff / 2)
what = f"answered {response.status_code}" if response is not None else "got no answer"
print(f"retry: attempt {attempt} {what}, waiting {wait:.1f} s", file=sys.stderr)
time.sleep(wait)
def when(response) -> str:
"""", try again after N s" when the answer says how long to wait (Retry-After), else nothing."""
retry_after = response.headers.get("Retry-After") if response is not None else None
return f", try again after {retry_after} s" if retry_after else ""
# A cancel that already happened answers 200 with already_cancelled true, so sending it again
# after no answer is the recovery.
response = send(f"/api/v1/orders/cancel/{quote(reference, safe='')}", {"reason": "The customer changed their mind"})
if response is None:
sys.exit("error: no answer; send the cancel again later")
body = body_of(response)
if response.is_error or body is None:
sys.exit(f"error: {response.status_code} {body['error']['code'] if body else '(not JSON)'}{when(response)}")
cancelled = body["data"]["order"]
print(f"order: {cancelled['partner_reference']}")
print(f"status id: {cancelled['status']['id']}")
print(f"already cancelled: {str(cancelled['already_cancelled']).lower()}")
<?php
// Cancel an order you created, by your own reference. Repeating it is safe. PHP 7.4 or later, with
// the curl extension. Needs MART_API_BASE, MART_API_KEY and MART_PARTNER_REFERENCE.
$base = getenv('MART_API_BASE');
$key = getenv('MART_API_KEY');
$reference = (string) getenv('MART_PARTNER_REFERENCE');
/**
* One request with the curl extension. Returns [status, headers (lower-case name => value), body];
* status 0 when there was no answer at all.
*/
function request(string $method, string $url, string $key, ?string $payload = null, int $timeout = 30): array
{
$headers = [];
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => $method,
CURLOPT_HTTPHEADER => ["Authorization: Bearer $key", 'Content-Type: application/json'],
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => $timeout,
CURLOPT_HEADERFUNCTION => function ($curl, string $line) use (&$headers): int {
$parts = explode(':', $line, 2);
if (count($parts) === 2) {
$headers[strtolower(trim($parts[0]))] = trim($parts[1]);
}
return strlen($line);
},
]);
if ($payload !== null) {
curl_setopt($curl, CURLOPT_POSTFIELDS, $payload);
}
$body = curl_exec($curl);
$status = $body === false ? 0 : (int) curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
return [$status, $headers, (string) $body];
}
/** ", try again after N s" when the answer says how long to wait (Retry-After), else nothing. */
function when(array $headers): string
{
return isset($headers['retry-after']) ? ", try again after {$headers['retry-after']} s" : '';
}
/**
* POST the same payload until it is answered for good. Retries are your choice of numbers: at most
* 5 attempts; after no answer, a 429 or a 5xx, wait what Retry-After says, or else 1, 2, 4, 8
* seconds (capped at 30) with jitter. Any other answer is final.
*/
function send(string $url, string $key, string $payload, int $timeout): array
{
for ($attempt = 1; ; $attempt++) {
[$status, $headers, $raw] = request('POST', $url, $key, $payload, $timeout);
if (!in_array($status, [0, 429, 500, 502, 503, 504], true) || $attempt === 5) {
return [$status, $headers, $raw];
}
$retryAfter = $headers['retry-after'] ?? '';
if (ctype_digit($retryAfter) && (int) $retryAfter > 0) {
if ((int) $retryAfter > 60) {
return [$status, $headers, $raw]; // too long to wait here: the caller says when to come back
}
$wait = (float) $retryAfter;
} else {
$backoff = min(30, 2 ** ($attempt - 1));
$wait = $backoff / 2 + mt_rand() / mt_getrandmax() * $backoff / 2;
}
fwrite(STDERR, sprintf("retry: attempt %d %s, waiting %.1f s\n", $attempt, $status === 0 ? 'got no answer' : "answered $status", $wait));
usleep((int) ($wait * 1000000));
}
}
// A cancel that already happened answers 200 with already_cancelled true, so sending it again
// after no answer is the recovery.
[$status, $headers, $raw] = send("$base/api/v1/orders/cancel/" . rawurlencode($reference), $key,
json_encode(['reason' => 'The customer changed their mind']), 30);
if ($status === 0) {
fwrite(STDERR, "error: no answer; send the cancel again later\n");
exit(1);
}
$body = json_decode($raw, true);
if ($status >= 300 || !is_array($body)) {
fwrite(STDERR, "error: $status " . ($body['error']['code'] ?? '(not JSON)') . when($headers) . "\n");
exit(1);
}
$cancelled = $body['data']['order'];
echo "order: {$cancelled['partner_reference']}\n";
echo "status id: {$cancelled['status']['id']}\n";
echo 'already cancelled: ' . ($cancelled['already_cancelled'] ? 'true' : 'false') . "\n";
//go:build ignore
// Cancel an order you created, by your own reference. Repeating it is safe. Go 1.22 or later.
// Needs MART_API_BASE, MART_API_KEY and MART_PARTNER_REFERENCE. Run it with: go run cancel-an-order.go
package main
import (
"bytes"
"encoding/json"
"fmt"
"io"
"math"
"math/rand"
"net/http"
"net/url"
"os"
"strconv"
"time"
)
var client = &http.Client{Timeout: 30 * time.Second}
func main() {
reference := os.Getenv("MART_PARTNER_REFERENCE")
// A cancel that already happened answers 200 with already_cancelled true, so sending it again
// after no answer is the recovery.
resp := send("/api/v1/orders/cancel/"+url.PathEscape(reference), []byte(`{"reason": "The customer changed their mind"}`))
if resp == nil {
fail(fmt.Errorf("no answer; send the cancel again later"))
}
var answer struct {
Data struct {
Order struct {
PartnerReference string `json:"partner_reference"`
Status struct {
ID int `json:"id"`
} `json:"status"`
AlreadyCancelled bool `json:"already_cancelled"`
} `json:"order"`
} `json:"data"`
}
decode(resp, &answer)
fmt.Println("order:", answer.Data.Order.PartnerReference)
fmt.Println("status id:", answer.Data.Order.Status.ID)
fmt.Println("already cancelled:", answer.Data.Order.AlreadyCancelled)
}
var retryable = map[int]bool{429: true, 500: true, 502: true, 503: true, 504: true}
// send POSTs the same bytes until they are answered for good, and returns the last answer, or
// nil when no attempt got one. Retries are your choice of numbers: at most 5 attempts; after no
// answer, a 429 or a 5xx, wait what Retry-After says, or else 1, 2, 4, 8 seconds (capped at 30)
// with jitter. Any other answer is final.
func send(path string, payload []byte) *http.Response {
for attempt := 1; ; attempt++ {
req, err := http.NewRequest(http.MethodPost, os.Getenv("MART_API_BASE")+path, bytes.NewReader(payload))
if err != nil {
fail(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("MART_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := client.Do(req)
if err != nil && attempt == 5 {
return nil
}
if err == nil && (!retryable[resp.StatusCode] || attempt == 5) {
return resp
}
what := "got no answer"
backoff := math.Min(30, math.Pow(2, float64(attempt-1)))
wait := backoff/2 + rand.Float64()*backoff/2
if err == nil {
what = fmt.Sprintf("answered %d", resp.StatusCode)
if seconds, convErr := strconv.Atoi(resp.Header.Get("Retry-After")); convErr == nil && seconds > 0 {
if seconds > 60 {
return resp // too long to wait here: the caller says when to come back
}
wait = float64(seconds)
}
resp.Body.Close()
}
fmt.Fprintf(os.Stderr, "retry: attempt %d %s, waiting %.1f s\n", attempt, what, wait)
time.Sleep(time.Duration(wait * float64(time.Second)))
}
}
// decode reads an answer into out. An error answer, or one that is not JSON (an edge error page),
// stops with its status and error code.
func decode(resp *http.Response, out any) {
defer resp.Body.Close()
raw, err := io.ReadAll(resp.Body)
if err != nil {
fail(err)
}
var envelope struct {
Error *struct {
Code string `json:"code"`
} `json:"error"`
}
if resp.StatusCode >= 300 {
code := "(not JSON)"
if json.Unmarshal(raw, &envelope) == nil && envelope.Error != nil {
code = envelope.Error.Code
}
wait := ""
if after := resp.Header.Get("Retry-After"); after != "" {
wait = ", try again after " + after + " s"
}
fail(fmt.Errorf("%d %s%s", resp.StatusCode, code, wait))
}
if err := json.Unmarshal(raw, out); err != nil {
fail(fmt.Errorf("%d (not JSON)", resp.StatusCode))
}
}
func fail(err error) {
fmt.Fprintln(os.Stderr, "error:", err)
os.Exit(1)
}
// Cancel an order you created, by your own reference. Repeating it is safe. Java 17 or later, with Jackson.
// Needs MART_API_BASE, MART_API_KEY and MART_PARTNER_REFERENCE.
// Run it as a single file: java -cp <the Jackson jars> cancel-an-order.java
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.IOException;
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.Locale;
import java.util.Set;
import java.util.concurrent.ThreadLocalRandom;
class CancelAnOrder {
static final HttpClient CLIENT = HttpClient.newBuilder().connectTimeout(Duration.ofSeconds(10)).build();
static final ObjectMapper JSON = new ObjectMapper();
public static void main(String[] args) throws Exception {
String reference = URLEncoder.encode(System.getenv("MART_PARTNER_REFERENCE"), StandardCharsets.UTF_8);
HttpRequest request = HttpRequest.newBuilder(
URI.create(System.getenv("MART_API_BASE") + "/api/v1/orders/cancel/" + reference))
.header("Authorization", "Bearer " + System.getenv("MART_API_KEY"))
.header("Content-Type", "application/json")
.timeout(Duration.ofSeconds(30))
.POST(HttpRequest.BodyPublishers.ofString("{\"reason\": \"The customer changed their mind\"}"))
.build();
// A cancel that already happened answers 200 with already_cancelled true, so sending it again
// after no answer is the recovery.
HttpResponse<String> response = send(request);
if (response == null) {
fail("no answer; send the cancel again later");
}
JsonNode body = parse(response.body());
if (response.statusCode() >= 300 || body == null) {
fail(response.statusCode() + " " + code(body) + when(response));
}
JsonNode cancelled = body.path("data").path("order");
System.out.println("order: " + cancelled.path("partner_reference").asText());
System.out.println("status id: " + cancelled.path("status").path("id").asInt());
System.out.println("already cancelled: " + cancelled.path("already_cancelled").asBoolean());
}
static final Set<Integer> RETRYABLE = Set.of(429, 500, 502, 503, 504);
/**
* Sends the same request until it is answered for good, and returns the last answer, or null when
* no attempt got one. Retries are your choice of numbers: at most 5 attempts; after no answer, a
* 429 or a 5xx, wait what Retry-After says, or else 1, 2, 4, 8 seconds (capped at 30) with jitter.
* Any other answer is final.
*/
static HttpResponse<String> send(HttpRequest request) throws InterruptedException {
for (int attempt = 1; ; attempt++) {
HttpResponse<String> response = null;
try {
response = CLIENT.send(request, HttpResponse.BodyHandlers.ofString());
if (!RETRYABLE.contains(response.statusCode()) || attempt == 5) {
return response;
}
} catch (IOException e) {
if (attempt == 5) {
return null;
}
}
double backoff = Math.min(30, Math.pow(2, attempt - 1));
double wait = backoff / 2 + ThreadLocalRandom.current().nextDouble() * backoff / 2;
String what = "got no answer";
if (response != null) {
what = "answered " + response.statusCode();
String after = response.headers().firstValue("Retry-After").orElse("");
if (after.matches("[0-9]+") && Long.parseLong(after) > 0) {
if (Long.parseLong(after) > 60) {
return response; // too long to wait here: the caller says when to come back
}
wait = Long.parseLong(after);
}
}
System.err.printf(Locale.ROOT, "retry: attempt %d %s, waiting %.1f s%n", attempt, what, wait);
Thread.sleep((long) (wait * 1000));
}
}
/** The JSON body, or null for an answer that is not JSON (an edge error page). */
static JsonNode parse(String text) {
try {
return JSON.readTree(text);
} catch (IOException e) {
return null;
}
}
static void fail(String message) {
System.err.println("error: " + message);
System.exit(1);
}
static String code(JsonNode body) {
return body == null ? "(not JSON)" : body.path("error").path("code").asText();
}
/** ", try again after N s" when the answer says how long to wait (Retry-After), else nothing. */
static String when(HttpResponse<String> response) {
return response.headers().firstValue("Retry-After").map(s -> ", try again after " + s + " s").orElse("");
}
}
Verify the result
Run it twice for the same order:order: 100245
status id: <id>
already cancelled: false
already cancelled: true: nothing changed. status id is the status Mart moved the order to; treat it as opaque.
Troubleshooting
| What you see | What to do |
|---|---|
404 order_not_found | No order of yours has this reference. |
409 order_not_cancellable | The order is past the point where you may cancel it. Contact Mart if it must still be stopped. |
503 order_cancellation_in_progress | Another cancel is under way. The recipe waits and sends it again. |
503 order_cancellation_not_configured | Cancelling through the API is not switched on. Contact Mart. |
| Any recipe | What to do |
|---|---|
401 missing_api_key or invalid_api_key | Check that MART_API_KEY holds the whole key. A key still refused needs a replacement from Mart. |
401 key_environment_mismatch | Point MART_API_BASE at the environment that issued the key. |
403 insufficient_scope | Ask Mart to add the scope in details.required_scope. |
429 rate_limit_exceeded | Wait the Retry-After the error line shows, then run it again. |
error: no answer, or a timeout | Check MART_API_BASE and your network. |
error: with (not JSON) | A proxy or firewall answered, not the API. Check MART_API_BASE and your network. |
