Cancel preview (census) for a sales order
curl --request GET \
--url https://api.arcuserp.com/v1/orders/{id}/cancel-preview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.arcuserp.com/v1/orders/{id}/cancel-preview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.arcuserp.com/v1/orders/{id}/cancel-preview', 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://api.arcuserp.com/v1/orders/{id}/cancel-preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.arcuserp.com/v1/orders/{id}/cancel-preview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.arcuserp.com/v1/orders/{id}/cancel-preview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/orders/{id}/cancel-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"order": {},
"child_drop_ship_pos": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"po_number": "<string>",
"order_status": "<string>",
"vendor_name": "<string>",
"sent_at": "<string>",
"has_receipts": true,
"is_billed": true,
"state": "draft",
"action": "cancels_with_order"
}
],
"child_work_orders": [
{}
],
"packages_to_void": [
{}
],
"cancellation_fee": {},
"eligibility": {},
"requires_wizard": true
}
}Orders
Cancel preview (census) for a sales order
Server-enumerated cancel census for the guided cancel wizard. Read-only. Returns the
sales order’s child drop-ship purchase orders classified by state (draft / sent /
received) with the resolution action each drives (a draft PO cancels silently with the
order; a sent PO offers one-click cancel + vendor notification; a vendor-shipped PO
pivots to the return flow), the child work orders, the active shipping labels that must
be voided first, a composed cancellation-fee preview, and the cancel/void eligibility
blockers. requires_wizard is true when there is at least one child PO or work order to
surface. Requires orders:read scope.
GET
/
orders
/
{id}
/
cancel-preview
Cancel preview (census) for a sales order
curl --request GET \
--url https://api.arcuserp.com/v1/orders/{id}/cancel-preview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.arcuserp.com/v1/orders/{id}/cancel-preview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.arcuserp.com/v1/orders/{id}/cancel-preview', 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://api.arcuserp.com/v1/orders/{id}/cancel-preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.arcuserp.com/v1/orders/{id}/cancel-preview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.arcuserp.com/v1/orders/{id}/cancel-preview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/orders/{id}/cancel-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"order": {},
"child_drop_ship_pos": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"po_number": "<string>",
"order_status": "<string>",
"vendor_name": "<string>",
"sent_at": "<string>",
"has_receipts": true,
"is_billed": true,
"state": "draft",
"action": "cancels_with_order"
}
],
"child_work_orders": [
{}
],
"packages_to_void": [
{}
],
"cancellation_fee": {},
"eligibility": {},
"requires_wizard": true
}
}Authorizations
API key issued per entity via Settings > Developers > API Keys.
Each key carries scopes (e.g. orders:read, products:write).
Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.
Path Parameters
Response
Cancel census
Show child attributes
Show child attributes
Was this page helpful?