curl --request POST \
--url https://api.arcuserp.com/v1/products/{id}/components \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"component_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_per_kit": 1,
"sort_order": 0,
"notes": "<string>",
"external_source": "<string>",
"external_id": "<string>",
"migration_batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"imported_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.arcuserp.com/v1/products/{id}/components"
payload = {
"component_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_per_kit": 1,
"sort_order": 0,
"notes": "<string>",
"external_source": "<string>",
"external_id": "<string>",
"migration_batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"imported_at": "2023-11-07T05:31:56Z"
}
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({
component_product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity_per_kit: 1,
sort_order: 0,
notes: '<string>',
external_source: '<string>',
external_id: '<string>',
migration_batch_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
imported_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.arcuserp.com/v1/products/{id}/components', 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/products/{id}/components",
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([
'component_product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity_per_kit' => 1,
'sort_order' => 0,
'notes' => '<string>',
'external_source' => '<string>',
'external_id' => '<string>',
'migration_batch_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'imported_at' => '2023-11-07T05:31:56Z'
]),
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/products/{id}/components"
payload := strings.NewReader("{\n \"component_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity_per_kit\": 1,\n \"sort_order\": 0,\n \"notes\": \"<string>\",\n \"external_source\": \"<string>\",\n \"external_id\": \"<string>\",\n \"migration_batch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"imported_at\": \"2023-11-07T05:31:56Z\"\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/products/{id}/components")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"component_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity_per_kit\": 1,\n \"sort_order\": 0,\n \"notes\": \"<string>\",\n \"external_source\": \"<string>\",\n \"external_id\": \"<string>\",\n \"migration_batch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"imported_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/products/{id}/components")
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 \"component_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity_per_kit\": 1,\n \"sort_order\": 0,\n \"notes\": \"<string>\",\n \"external_source\": \"<string>\",\n \"external_id\": \"<string>\",\n \"migration_batch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"imported_at\": \"2023-11-07T05:31:56Z\"\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"
}Add a product's kit component
Adds a component product to a kit, specifying the quantity required to build one unit of the kit; the parent product must be kit-typed. Requires the products:write scope; a non-kit parent returns code not_a_kit and a duplicate component returns code component_already_exists.
curl --request POST \
--url https://api.arcuserp.com/v1/products/{id}/components \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"component_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_per_kit": 1,
"sort_order": 0,
"notes": "<string>",
"external_source": "<string>",
"external_id": "<string>",
"migration_batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"imported_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.arcuserp.com/v1/products/{id}/components"
payload = {
"component_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_per_kit": 1,
"sort_order": 0,
"notes": "<string>",
"external_source": "<string>",
"external_id": "<string>",
"migration_batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"imported_at": "2023-11-07T05:31:56Z"
}
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({
component_product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity_per_kit: 1,
sort_order: 0,
notes: '<string>',
external_source: '<string>',
external_id: '<string>',
migration_batch_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
imported_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.arcuserp.com/v1/products/{id}/components', 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/products/{id}/components",
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([
'component_product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity_per_kit' => 1,
'sort_order' => 0,
'notes' => '<string>',
'external_source' => '<string>',
'external_id' => '<string>',
'migration_batch_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'imported_at' => '2023-11-07T05:31:56Z'
]),
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/products/{id}/components"
payload := strings.NewReader("{\n \"component_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity_per_kit\": 1,\n \"sort_order\": 0,\n \"notes\": \"<string>\",\n \"external_source\": \"<string>\",\n \"external_id\": \"<string>\",\n \"migration_batch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"imported_at\": \"2023-11-07T05:31:56Z\"\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/products/{id}/components")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"component_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity_per_kit\": 1,\n \"sort_order\": 0,\n \"notes\": \"<string>\",\n \"external_source\": \"<string>\",\n \"external_id\": \"<string>\",\n \"migration_batch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"imported_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/products/{id}/components")
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 \"component_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity_per_kit\": 1,\n \"sort_order\": 0,\n \"notes\": \"<string>\",\n \"external_source\": \"<string>\",\n \"external_id\": \"<string>\",\n \"migration_batch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"imported_at\": \"2023-11-07T05:31:56Z\"\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"
}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.
Headers
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. A second request with the same
key sent while the first is still running waits for it and returns its
answer; if the first is still running after 20 seconds the second
answers 409 idempotency_key_in_use (retryable, nothing done). An
answer carrying retryable: true is not cached. Reusing a key with a
different request body answers 409 idempotency_key_collision (nothing
done; send the new request with a fresh key). The replay, the wait and
these two 409 codes come from the idempotency layer, so they apply to
the operations that run it, each of which can answer the two codes
whether or not its own 409 response lists them. The handlers of these
operations take the header but do not run the layer, so on them the key
neither replays nor answers either code: createPaymentPlan,
chargePaymentPlanInstallment, setProductLocations, updateOrder,
emailOrder, updateOrderItem, confirmPickup, markOrderNoShow,
applyExistingPaymentToInvoices, updatePackage, movePackageItem,
changePackageBox, changePackageCarrier, voidPackageLabel,
printPackageLabel, emailPackage, setProNumberV1, setPackageProNumber,
sendPurchaseOrderToVendorV1, notifyRevisionPurchaseOrderV1,
addMaintenanceLog, generateBOLV1,
createReportJobV1 and customerAcknowledgeRevision; recordVendorPrepaymentV1
and recordCustomerDepositV1 hand the key to their own write instead.
255Path Parameters
Body
x >= 0Display order of the component within the kit.
Source-system tag for historical migration (e.g. 'bubble_io', 'versa_cloud').
Source-system row id, persisted for batch traceability.
Optional migration-wave identifier, persisted on the row.
Source record timestamp; preserve the origin system's created_at for audit fidelity.
Response
Component added
The response is of type object.
Was this page helpful?

