Correct a mis-shipment (wrong SKU physically shipped)

curl --request POST \
  --url https://api.arcuserp.com/v1/orders/{id}/correct-misshipment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "wrong_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ordered_order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity": 2,
  "wrong_qty": 2,
  "correct_qty": 2,
  "wrong_disposition": "writeoff",
  "settle_value_delta": true,
  "value_delta": 123
}
'

import requests

url = "https://api.arcuserp.com/v1/orders/{id}/correct-misshipment"

payload = {
    "wrong_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ordered_order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "quantity": 2,
    "wrong_qty": 2,
    "correct_qty": 2,
    "wrong_disposition": "writeoff",
    "settle_value_delta": True,
    "value_delta": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    wrong_product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    ordered_order_item_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    quantity: 2,
    wrong_qty: 2,
    correct_qty: 2,
    wrong_disposition: 'writeoff',
    settle_value_delta: true,
    value_delta: 123
  })
};

fetch('https://api.arcuserp.com/v1/orders/{id}/correct-misshipment', 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}/correct-misshipment",
  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([
    'wrong_product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'ordered_order_item_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'quantity' => 2,
    'wrong_qty' => 2,
    'correct_qty' => 2,
    'wrong_disposition' => 'writeoff',
    'settle_value_delta' => true,
    'value_delta' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.arcuserp.com/v1/orders/{id}/correct-misshipment"

	payload := strings.NewReader("{\n  \"wrong_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"ordered_order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2,\n  \"wrong_qty\": 2,\n  \"correct_qty\": 2,\n  \"wrong_disposition\": \"writeoff\",\n  \"settle_value_delta\": true,\n  \"value_delta\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://api.arcuserp.com/v1/orders/{id}/correct-misshipment")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"wrong_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"ordered_order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2,\n  \"wrong_qty\": 2,\n  \"correct_qty\": 2,\n  \"wrong_disposition\": \"writeoff\",\n  \"settle_value_delta\": true,\n  \"value_delta\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/orders/{id}/correct-misshipment")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"wrong_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"ordered_order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2,\n  \"wrong_qty\": 2,\n  \"correct_qty\": 2,\n  \"wrong_disposition\": \"writeoff\",\n  \"settle_value_delta\": true,\n  \"value_delta\": 123\n}"

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

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Orders

Correct a mis-shipment (wrong SKU physically shipped)

Self-correcting inventory fix for when the wrong SKU physically shipped: disposes the wrong item (writeoff by default) and restores plus re-opens the ordered item for re-ship. Quantities decouple (N wrong need not equal M correct): wrong_qty units of the wrong SKU are disposed and correct_qty units of the ordered SKU are restored (both default to quantity for the legacy 1:1 case). Optionally settles the sell-value delta through the canonical order-adjustments engine when settle_value_delta is true.

Authorization: requires returns:write scope plus the returns.process SoD permission. Idempotent via the Idempotency-Key header and the handler’s own misship_already_corrected cap.

POST

orders

{id}

correct-misshipment

Correct a mis-shipment (wrong SKU physically shipped)

curl --request POST \
  --url https://api.arcuserp.com/v1/orders/{id}/correct-misshipment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "wrong_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ordered_order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity": 2,
  "wrong_qty": 2,
  "correct_qty": 2,
  "wrong_disposition": "writeoff",
  "settle_value_delta": true,
  "value_delta": 123
}
'

import requests

url = "https://api.arcuserp.com/v1/orders/{id}/correct-misshipment"

payload = {
    "wrong_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ordered_order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "quantity": 2,
    "wrong_qty": 2,
    "correct_qty": 2,
    "wrong_disposition": "writeoff",
    "settle_value_delta": True,
    "value_delta": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    wrong_product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    ordered_order_item_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    quantity: 2,
    wrong_qty: 2,
    correct_qty: 2,
    wrong_disposition: 'writeoff',
    settle_value_delta: true,
    value_delta: 123
  })
};

fetch('https://api.arcuserp.com/v1/orders/{id}/correct-misshipment', 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}/correct-misshipment",
  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([
    'wrong_product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'ordered_order_item_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'quantity' => 2,
    'wrong_qty' => 2,
    'correct_qty' => 2,
    'wrong_disposition' => 'writeoff',
    'settle_value_delta' => true,
    'value_delta' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.arcuserp.com/v1/orders/{id}/correct-misshipment"

	payload := strings.NewReader("{\n  \"wrong_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"ordered_order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2,\n  \"wrong_qty\": 2,\n  \"correct_qty\": 2,\n  \"wrong_disposition\": \"writeoff\",\n  \"settle_value_delta\": true,\n  \"value_delta\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://api.arcuserp.com/v1/orders/{id}/correct-misshipment")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"wrong_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"ordered_order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2,\n  \"wrong_qty\": 2,\n  \"correct_qty\": 2,\n  \"wrong_disposition\": \"writeoff\",\n  \"settle_value_delta\": true,\n  \"value_delta\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/orders/{id}/correct-misshipment")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"wrong_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"ordered_order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2,\n  \"wrong_qty\": 2,\n  \"correct_qty\": 2,\n  \"wrong_disposition\": \"writeoff\",\n  \"settle_value_delta\": true,\n  \"value_delta\": 123\n}"

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

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Authorizations

Authorization

string

header

required

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.

Headers

Idempotency-Key

string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Path Parameters

string<uuid>

required

Body

application/json

wrong_product_id

string<uuid>

required

The SKU that was PHYSICALLY shipped (the wrong part).

ordered_order_item_id

string<uuid>

required

The ordered line (the correct SKU) that was mis-shipped.

quantity

integer

Legacy 1:1 quantity; used as the default for both wrong_qty and correct_qty.

Required range: x >= 1

wrong_qty

integer

Units of the wrong SKU that physically shipped and are disposed.

Required range: x >= 1

correct_qty

integer

Units of the ordered SKU to restore and re-ship.

Required range: x >= 1

wrong_disposition

enum<string>

default:writeoff

Available options:

writeoff,

bill,

expect_return,

vendor_return

settle_value_delta

boolean

Opt in to settle the sell-value delta between the correct and wrong SKU.

value_delta

number

Signed dollar delta used verbatim when supplied; otherwise a suggested delta is computed.

Response

Mis-shipment corrected

Undo fulfillment on a shipped order (reverse to packed/editable)Void a posted order

Overview

All Endpoints

Correct a mis-shipment (wrong SKU physically shipped)

Authorizations

Headers

Path Parameters

Body

Response