Swap a line item's product in place

curl --request POST \
  --url https://api.arcuserp.com/v1/orders/{id}/items/{item_id}/swap \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity": 2,
  "sell_rate": 123,
  "unit_price": 123,
  "list_price": 123,
  "notes": "<string>",
  "override": true,
  "override_reason": "<string>"
}
'

import requests

url = "https://api.arcuserp.com/v1/orders/{id}/items/{item_id}/swap"

payload = {
    "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "quantity": 2,
    "sell_rate": 123,
    "unit_price": 123,
    "list_price": 123,
    "notes": "<string>",
    "override": True,
    "override_reason": "<string>"
}
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({
    product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    variant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    quantity: 2,
    sell_rate: 123,
    unit_price: 123,
    list_price: 123,
    notes: '<string>',
    override: true,
    override_reason: '<string>'
  })
};

fetch('https://api.arcuserp.com/v1/orders/{id}/items/{item_id}/swap', 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}/items/{item_id}/swap",
  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([
    'product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'variant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'quantity' => 2,
    'sell_rate' => 123,
    'unit_price' => 123,
    'list_price' => 123,
    'notes' => '<string>',
    'override' => true,
    'override_reason' => '<string>'
  ]),
  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}/items/{item_id}/swap"

	payload := strings.NewReader("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2,\n  \"sell_rate\": 123,\n  \"unit_price\": 123,\n  \"list_price\": 123,\n  \"notes\": \"<string>\",\n  \"override\": true,\n  \"override_reason\": \"<string>\"\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}/items/{item_id}/swap")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2,\n  \"sell_rate\": 123,\n  \"unit_price\": 123,\n  \"list_price\": 123,\n  \"notes\": \"<string>\",\n  \"override\": true,\n  \"override_reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/orders/{id}/items/{item_id}/swap")

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  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2,\n  \"sell_rate\": 123,\n  \"unit_price\": 123,\n  \"list_price\": 123,\n  \"notes\": \"<string>\",\n  \"override\": true,\n  \"override_reason\": \"<string>\"\n}"

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

{
  "old_order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "new_order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "new_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity": 123,
  "sort_order": 123,
  "channel_lineage_inherited": true,
  "requires_overpayment_review": true,
  "overpayment_amount": 123
}

{
  "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

Swap a line item's product in place

Replaces the product on an existing order line in ONE server-side transaction, keeping the captured payment attached so only the price delta needs settling. Composes the canonical add + delete: it adds the replacement line (kit re-explosion, pricing policy, tax) and removes the original (reservation release, kit component cascade) with a single recalculation. sort_order is preserved.

For channel-sourced orders (Shopify/Amazon/eBay), the replacement line inherits the original line’s external line-id triple so revision sync-back can map old -> new. Requires orders:write scope.

Editing a line on a CLOSED AR document is blocked the same way as update/delete: cancelled/voided or posted/fulfilled (suggested_action: create_return, not overridable); paid/billed (suggested_action: revise_order). To swap a line on a paid order pass override: true with the orders.revision_override permission; the swap is audited (item_swapped). A kit COMPONENT line returns 422 kit_component_not_editable (swap the kit parent). A line with an issued drop-ship PO returns 409 dropship_po_issued_blocks_line_edit.

POST

orders

{id}

items

{item_id}

swap

Swap a line item's product in place

curl --request POST \
  --url https://api.arcuserp.com/v1/orders/{id}/items/{item_id}/swap \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity": 2,
  "sell_rate": 123,
  "unit_price": 123,
  "list_price": 123,
  "notes": "<string>",
  "override": true,
  "override_reason": "<string>"
}
'

import requests

url = "https://api.arcuserp.com/v1/orders/{id}/items/{item_id}/swap"

payload = {
    "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "quantity": 2,
    "sell_rate": 123,
    "unit_price": 123,
    "list_price": 123,
    "notes": "<string>",
    "override": True,
    "override_reason": "<string>"
}
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({
    product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    variant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    quantity: 2,
    sell_rate: 123,
    unit_price: 123,
    list_price: 123,
    notes: '<string>',
    override: true,
    override_reason: '<string>'
  })
};

fetch('https://api.arcuserp.com/v1/orders/{id}/items/{item_id}/swap', 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}/items/{item_id}/swap",
  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([
    'product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'variant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'quantity' => 2,
    'sell_rate' => 123,
    'unit_price' => 123,
    'list_price' => 123,
    'notes' => '<string>',
    'override' => true,
    'override_reason' => '<string>'
  ]),
  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}/items/{item_id}/swap"

	payload := strings.NewReader("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2,\n  \"sell_rate\": 123,\n  \"unit_price\": 123,\n  \"list_price\": 123,\n  \"notes\": \"<string>\",\n  \"override\": true,\n  \"override_reason\": \"<string>\"\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}/items/{item_id}/swap")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2,\n  \"sell_rate\": 123,\n  \"unit_price\": 123,\n  \"list_price\": 123,\n  \"notes\": \"<string>\",\n  \"override\": true,\n  \"override_reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/orders/{id}/items/{item_id}/swap")

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  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2,\n  \"sell_rate\": 123,\n  \"unit_price\": 123,\n  \"list_price\": 123,\n  \"notes\": \"<string>\",\n  \"override\": true,\n  \"override_reason\": \"<string>\"\n}"

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

{
  "old_order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "new_order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "new_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity": 123,
  "sort_order": 123,
  "channel_lineage_inherited": true,
  "requires_overpayment_review": true,
  "overpayment_amount": 123
}

{
  "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.

Path Parameters

string<uuid>

required

item_id

string<uuid>

required

Body

application/json

product_id

string<uuid>

required

Replacement product.

variant_id

string<uuid>

Replacement variant (required if the product has variants).

quantity

integer

Quantity for the replacement line. Defaults to the original line's quantity.

Required range: x >= 1

sell_rate

number

Override unit price for the replacement (canonical Arcus field).

unit_price

number

Alias of sell_rate (Stripe/Shopify convention).

list_price

number

notes

string

override

boolean

Set true (with orders.revision_override) to swap a line on a paid/billed order. Without it a paid/billed order returns 422 edit_not_allowed (suggested_action revise_order).

override_reason

string

Response

Line swapped. Returns old + new order_item ids, quantity, sort_order, and channel_lineage_inherited.

old_order_item_id

string<uuid>

new_order_item_id

string<uuid>

new_product_id

string<uuid>

quantity

integer

sort_order

integer

channel_lineage_inherited

boolean

requires_overpayment_review

boolean

overpayment_amount

number | null

Update a line item quantity or notes Get order activity timeline

Overview

All Endpoints

Swap a line item's product in place

Authorizations

Path Parameters

Body

Response