Add an order item to a package

curl --request POST \
  --url https://api.arcuserp.com/v1/packages/{id}/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quantity": 2,
  "order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "serial_numbers": [
    "<string>"
  ]
}
'

import requests

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

payload = {
    "quantity": 2,
    "order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serial_numbers": ["<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({
    quantity: 2,
    order_item_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    serial_numbers: ['<string>']
  })
};

fetch('https://api.arcuserp.com/v1/packages/{id}/items', 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/packages/{id}/items",
  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([
    'quantity' => 2,
    'order_item_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'serial_numbers' => [
        '<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/packages/{id}/items"

	payload := strings.NewReader("{\n  \"quantity\": 2,\n  \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"serial_numbers\": [\n    \"<string>\"\n  ]\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/packages/{id}/items")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"quantity\": 2,\n  \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"serial_numbers\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"quantity\": 2,\n  \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"serial_numbers\": [\n    \"<string>\"\n  ]\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "package_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity": 123,
  "sku": "<string>",
  "title": "<string>",
  "serial_numbers": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "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": "<string>",
  "type": "validation_error",
  "hint": "<string>",
  "param": "<string>",
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ordered_qty": 123,
  "already_packed_qty": 123,
  "remaining_qty": 123
}

Fulfillment

Add an order item to a package

Adds an order line item (or partial quantity) to a package. Either order_item_id OR product_id must be supplied; if both are provided the order_item_id is authoritative.

Two invariants enforced BEFORE the INSERT (canonical writer utils/fulfillment-helpers.mjs::addItemToPackage):

Item-on-order — the product must be on the parent order. Returns 422 product_not_on_order with envelope {error, code, type:'validation_error', param:'product_id', hint, product_id, order_id} when the product is not on any order_items row for the order.
Quantity cap — the requested quantity must not exceed SUM(ordered_qty) - SUM(elsewhere_packed) across ALL packages of the order for this product. Returns 422 package_quantity_exceeds_ordered with envelope {error, code, type:'validation_error', param:'quantity', hint, ordered_qty, already_packed_qty, remaining_qty, product_id}.

Multi-line same-product orders: the first non-fully-packed line wins. Both refusal paths write to the parent order activity log.

Requires fulfillment:write scope.

POST

packages

{id}

items

Add an order item to a package

curl --request POST \
  --url https://api.arcuserp.com/v1/packages/{id}/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quantity": 2,
  "order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "serial_numbers": [
    "<string>"
  ]
}
'

import requests

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

payload = {
    "quantity": 2,
    "order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serial_numbers": ["<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({
    quantity: 2,
    order_item_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    serial_numbers: ['<string>']
  })
};

fetch('https://api.arcuserp.com/v1/packages/{id}/items', 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/packages/{id}/items",
  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([
    'quantity' => 2,
    'order_item_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'serial_numbers' => [
        '<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/packages/{id}/items"

	payload := strings.NewReader("{\n  \"quantity\": 2,\n  \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"serial_numbers\": [\n    \"<string>\"\n  ]\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/packages/{id}/items")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"quantity\": 2,\n  \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"serial_numbers\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"quantity\": 2,\n  \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"serial_numbers\": [\n    \"<string>\"\n  ]\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "package_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity": 123,
  "sku": "<string>",
  "title": "<string>",
  "serial_numbers": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "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": "<string>",
  "type": "validation_error",
  "hint": "<string>",
  "param": "<string>",
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ordered_qty": 123,
  "already_packed_qty": 123,
  "remaining_qty": 123
}

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

quantity

integer

required

Required range: x >= 1

order_item_id

string<uuid>

Order line ID. Either order_item_id or product_id required.

product_id

string<uuid>

Product ID. The canonical writer resolves the matching order_item by (order_id, product_id, entity_id).

serial_numbers

string[]

Response

Package item added

A line item placed inside a package (one order_item can be split across packages).

string<uuid>

package_id

string<uuid>

order_item_id

string<uuid>

product_id

string<uuid> | null

quantity

integer

Qty of this order_item packed into this package.

sku

string | null

title

string | null

serial_numbers

string[] | null

created_at

string<date-time>

read-only

Update package dimensions / metadata Remove an item from a package

Overview

All Endpoints

Add an order item to a package

Authorizations

Headers

Path Parameters

Body

Response