Update header-level fields on a draft or submitted transfer

curl --request PATCH \
  --url https://api.arcuserp.com/v1/transfers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "notes": "<string>",
  "expected_ship_date": "2023-12-25",
  "expected_receive_date": "2023-12-25",
  "carrier": "<string>",
  "tracking_number": "<string>",
  "transfer_notes": "<string>"
}
'

import requests

url = "https://api.arcuserp.com/v1/transfers/{id}"

payload = {
    "notes": "<string>",
    "expected_ship_date": "2023-12-25",
    "expected_receive_date": "2023-12-25",
    "carrier": "<string>",
    "tracking_number": "<string>",
    "transfer_notes": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    notes: '<string>',
    expected_ship_date: '2023-12-25',
    expected_receive_date: '2023-12-25',
    carrier: '<string>',
    tracking_number: '<string>',
    transfer_notes: '<string>'
  })
};

fetch('https://api.arcuserp.com/v1/transfers/{id}', 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/transfers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'notes' => '<string>',
    'expected_ship_date' => '2023-12-25',
    'expected_receive_date' => '2023-12-25',
    'carrier' => '<string>',
    'tracking_number' => '<string>',
    'transfer_notes' => '<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/transfers/{id}"

	payload := strings.NewReader("{\n  \"notes\": \"<string>\",\n  \"expected_ship_date\": \"2023-12-25\",\n  \"expected_receive_date\": \"2023-12-25\",\n  \"carrier\": \"<string>\",\n  \"tracking_number\": \"<string>\",\n  \"transfer_notes\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.arcuserp.com/v1/transfers/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"notes\": \"<string>\",\n  \"expected_ship_date\": \"2023-12-25\",\n  \"expected_receive_date\": \"2023-12-25\",\n  \"carrier\": \"<string>\",\n  \"tracking_number\": \"<string>\",\n  \"transfer_notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/transfers/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"notes\": \"<string>\",\n  \"expected_ship_date\": \"2023-12-25\",\n  \"expected_receive_date\": \"2023-12-25\",\n  \"carrier\": \"<string>\",\n  \"tracking_number\": \"<string>\",\n  \"transfer_notes\": \"<string>\"\n}"

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

{
  "data": {}
}

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

Inventory

Update header-level fields on a draft or submitted transfer

Updates a constrained set of header fields on a transfer in draft or submitted status. Allowed fields: notes, expected_ship_date, expected_receive_date, carrier, tracking_number, transfer_notes. Any other field returns 400 field_not_writable.

Status guard: returns 409 state_transition_invalid when the transfer is in any status beyond draft or submitted (in_transit / shipped / receiving / closed / cancelled are immutable at the header level).

Item-level mutations are not supported on PATCH; cancel the transfer and create a new one to change items.

Requires inventory:write scope. Idempotent via Idempotency-Key.

PATCH

transfers

{id}

Update header-level fields on a draft or submitted transfer

curl --request PATCH \
  --url https://api.arcuserp.com/v1/transfers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "notes": "<string>",
  "expected_ship_date": "2023-12-25",
  "expected_receive_date": "2023-12-25",
  "carrier": "<string>",
  "tracking_number": "<string>",
  "transfer_notes": "<string>"
}
'

import requests

url = "https://api.arcuserp.com/v1/transfers/{id}"

payload = {
    "notes": "<string>",
    "expected_ship_date": "2023-12-25",
    "expected_receive_date": "2023-12-25",
    "carrier": "<string>",
    "tracking_number": "<string>",
    "transfer_notes": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    notes: '<string>',
    expected_ship_date: '2023-12-25',
    expected_receive_date: '2023-12-25',
    carrier: '<string>',
    tracking_number: '<string>',
    transfer_notes: '<string>'
  })
};

fetch('https://api.arcuserp.com/v1/transfers/{id}', 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/transfers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'notes' => '<string>',
    'expected_ship_date' => '2023-12-25',
    'expected_receive_date' => '2023-12-25',
    'carrier' => '<string>',
    'tracking_number' => '<string>',
    'transfer_notes' => '<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/transfers/{id}"

	payload := strings.NewReader("{\n  \"notes\": \"<string>\",\n  \"expected_ship_date\": \"2023-12-25\",\n  \"expected_receive_date\": \"2023-12-25\",\n  \"carrier\": \"<string>\",\n  \"tracking_number\": \"<string>\",\n  \"transfer_notes\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.arcuserp.com/v1/transfers/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"notes\": \"<string>\",\n  \"expected_ship_date\": \"2023-12-25\",\n  \"expected_receive_date\": \"2023-12-25\",\n  \"carrier\": \"<string>\",\n  \"tracking_number\": \"<string>\",\n  \"transfer_notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/transfers/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"notes\": \"<string>\",\n  \"expected_ship_date\": \"2023-12-25\",\n  \"expected_receive_date\": \"2023-12-25\",\n  \"carrier\": \"<string>\",\n  \"tracking_number\": \"<string>\",\n  \"transfer_notes\": \"<string>\"\n}"

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

{
  "data": {}
}

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

notes

string

expected_ship_date

string<date> | null

expected_receive_date

string<date> | null

carrier

string | null

tracking_number

string | null

transfer_notes

string | null

Response

Updated transfer header row

data

object

Overview

All Endpoints

Update header-level fields on a draft or submitted transfer

Authorizations

Headers

Path Parameters

Body

Response