Cancel order - Sparqle API

Cancel order

curl --request PATCH \
  --url https://staging-v2.sparqle.tech/orders/cancel/{orderId} \
  --header 'api-key: <api-key>'

const options = {method: 'PATCH', headers: {'api-key': '<api-key>'}};

fetch('https://staging-v2.sparqle.tech/orders/cancel/{orderId}', 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://staging-v2.sparqle.tech/orders/cancel/{orderId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_HTTPHEADER => [
    "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://staging-v2.sparqle.tech/orders/cancel/{orderId}"

	req, _ := http.NewRequest("PATCH", url, nil)

	req.Header.Add("api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://staging-v2.sparqle.tech/orders/cancel/{orderId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": 1,
  "orderId": "SPQ-10293",
  "orderRef": "PADE3JWEA",
  "status": "draft",
  "name": "iPod",
  "barcode": "3STBXX123456789",
  "trackingUrl": "https://tracking.sparqle.com/barcode/3STBXX123456789",
  "deliveryName": "Jane Doe",
  "deliveryEmail": "[email protected]",
  "deliveryAddress": "Gustav Mahlerlaan 320, 1082 ME Amsterdam",
  "deliveryEta": "12:40 - 13:00",
  "deliveryEtaDate": "2026-08-13",
  "deliveryDate": "2026-08-13",
  "locationId": 1,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

PATCH

/

orders

/

cancel

/

{orderId}

Cancel order

curl --request PATCH \
  --url https://staging-v2.sparqle.tech/orders/cancel/{orderId} \
  --header 'api-key: <api-key>'

const options = {method: 'PATCH', headers: {'api-key': '<api-key>'}};

fetch('https://staging-v2.sparqle.tech/orders/cancel/{orderId}', 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://staging-v2.sparqle.tech/orders/cancel/{orderId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_HTTPHEADER => [
    "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://staging-v2.sparqle.tech/orders/cancel/{orderId}"

	req, _ := http.NewRequest("PATCH", url, nil)

	req.Header.Add("api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://staging-v2.sparqle.tech/orders/cancel/{orderId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": 1,
  "orderId": "SPQ-10293",
  "orderRef": "PADE3JWEA",
  "status": "draft",
  "name": "iPod",
  "barcode": "3STBXX123456789",
  "trackingUrl": "https://tracking.sparqle.com/barcode/3STBXX123456789",
  "deliveryName": "Jane Doe",
  "deliveryEmail": "[email protected]",
  "deliveryAddress": "Gustav Mahlerlaan 320, 1082 ME Amsterdam",
  "deliveryEta": "12:40 - 13:00",
  "deliveryEtaDate": "2026-08-13",
  "deliveryDate": "2026-08-13",
  "locationId": 1,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

api-key

string

header

required

Path Parameters

orderId

string

required

Response

Order cancelled

id

integer

Example:

1

orderId

string

Example:

"SPQ-10293"

orderRef

string

Example:

"PADE3JWEA"

status

enum<string>

Available options:

draft,

expected,

in_transit,

out_for_delivery,

awaiting_next_attempt,

at_pickup_point,

completed,

failed,

in_return_transit,

returned,

cancelled,

rejected,

address_not_found,

inactive,

missing,

lost,

error

Example:

"draft"

name

string

Example:

"iPod"

barcode

string

Example:

"3STBXX123456789"

trackingUrl

string

Example:

"https://tracking.sparqle.com/barcode/3STBXX123456789"

deliveryName

string

Example:

"Jane Doe"

deliveryEmail

string

Example:

"[email protected]"

deliveryAddress

string

Example:

"Gustav Mahlerlaan 320, 1082 ME Amsterdam"

deliveryEta

string

Example:

"12:40 - 13:00"

deliveryEtaDate

string<date>

Example:

"2026-08-13"

deliveryDate

string

Example:

"2026-08-13"

locationId

integer

Example:

1

createdAt

string<date-time>

updatedAt

string<date-time>