Create a product variant (entity-wide endpoint)

curl --request POST \
  --url https://api.arcuserp.com/v1/variants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sku": "<string>",
  "barcode": "<string>",
  "variant_title": "<string>",
  "option1": "<string>",
  "option2": "<string>",
  "option3": "<string>",
  "price": 123,
  "cost": 123,
  "weight": 123,
  "is_active": true,
  "metadata": {}
}
'

import requests

url = "https://api.arcuserp.com/v1/variants"

payload = {
    "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sku": "<string>",
    "barcode": "<string>",
    "variant_title": "<string>",
    "option1": "<string>",
    "option2": "<string>",
    "option3": "<string>",
    "price": 123,
    "cost": 123,
    "weight": 123,
    "is_active": True,
    "metadata": {}
}
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',
    sku: '<string>',
    barcode: '<string>',
    variant_title: '<string>',
    option1: '<string>',
    option2: '<string>',
    option3: '<string>',
    price: 123,
    cost: 123,
    weight: 123,
    is_active: true,
    metadata: {}
  })
};

fetch('https://api.arcuserp.com/v1/variants', 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/variants",
  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',
    'sku' => '<string>',
    'barcode' => '<string>',
    'variant_title' => '<string>',
    'option1' => '<string>',
    'option2' => '<string>',
    'option3' => '<string>',
    'price' => 123,
    'cost' => 123,
    'weight' => 123,
    'is_active' => true,
    'metadata' => [
        
    ]
  ]),
  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/variants"

	payload := strings.NewReader("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sku\": \"<string>\",\n  \"barcode\": \"<string>\",\n  \"variant_title\": \"<string>\",\n  \"option1\": \"<string>\",\n  \"option2\": \"<string>\",\n  \"option3\": \"<string>\",\n  \"price\": 123,\n  \"cost\": 123,\n  \"weight\": 123,\n  \"is_active\": true,\n  \"metadata\": {}\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/variants")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sku\": \"<string>\",\n  \"barcode\": \"<string>\",\n  \"variant_title\": \"<string>\",\n  \"option1\": \"<string>\",\n  \"option2\": \"<string>\",\n  \"option3\": \"<string>\",\n  \"price\": 123,\n  \"cost\": 123,\n  \"weight\": 123,\n  \"is_active\": true,\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/variants")

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  \"sku\": \"<string>\",\n  \"barcode\": \"<string>\",\n  \"variant_title\": \"<string>\",\n  \"option1\": \"<string>\",\n  \"option2\": \"<string>\",\n  \"option3\": \"<string>\",\n  \"price\": 123,\n  \"cost\": 123,\n  \"weight\": 123,\n  \"is_active\": true,\n  \"metadata\": {}\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"
}

POST

variants

Create a product variant (entity-wide endpoint)

curl --request POST \
  --url https://api.arcuserp.com/v1/variants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sku": "<string>",
  "barcode": "<string>",
  "variant_title": "<string>",
  "option1": "<string>",
  "option2": "<string>",
  "option3": "<string>",
  "price": 123,
  "cost": 123,
  "weight": 123,
  "is_active": true,
  "metadata": {}
}
'

import requests

url = "https://api.arcuserp.com/v1/variants"

payload = {
    "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sku": "<string>",
    "barcode": "<string>",
    "variant_title": "<string>",
    "option1": "<string>",
    "option2": "<string>",
    "option3": "<string>",
    "price": 123,
    "cost": 123,
    "weight": 123,
    "is_active": True,
    "metadata": {}
}
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',
    sku: '<string>',
    barcode: '<string>',
    variant_title: '<string>',
    option1: '<string>',
    option2: '<string>',
    option3: '<string>',
    price: 123,
    cost: 123,
    weight: 123,
    is_active: true,
    metadata: {}
  })
};

fetch('https://api.arcuserp.com/v1/variants', 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/variants",
  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',
    'sku' => '<string>',
    'barcode' => '<string>',
    'variant_title' => '<string>',
    'option1' => '<string>',
    'option2' => '<string>',
    'option3' => '<string>',
    'price' => 123,
    'cost' => 123,
    'weight' => 123,
    'is_active' => true,
    'metadata' => [
        
    ]
  ]),
  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/variants"

	payload := strings.NewReader("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sku\": \"<string>\",\n  \"barcode\": \"<string>\",\n  \"variant_title\": \"<string>\",\n  \"option1\": \"<string>\",\n  \"option2\": \"<string>\",\n  \"option3\": \"<string>\",\n  \"price\": 123,\n  \"cost\": 123,\n  \"weight\": 123,\n  \"is_active\": true,\n  \"metadata\": {}\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/variants")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sku\": \"<string>\",\n  \"barcode\": \"<string>\",\n  \"variant_title\": \"<string>\",\n  \"option1\": \"<string>\",\n  \"option2\": \"<string>\",\n  \"option3\": \"<string>\",\n  \"price\": 123,\n  \"cost\": 123,\n  \"weight\": 123,\n  \"is_active\": true,\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/variants")

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  \"sku\": \"<string>\",\n  \"barcode\": \"<string>\",\n  \"variant_title\": \"<string>\",\n  \"option1\": \"<string>\",\n  \"option2\": \"<string>\",\n  \"option3\": \"<string>\",\n  \"price\": 123,\n  \"cost\": 123,\n  \"weight\": 123,\n  \"is_active\": true,\n  \"metadata\": {}\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"
}

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.

Body

application/json

product_id

string<uuid>

required

sku

string

required

barcode

string

variant_title

string

option1

string

option2

string

option3

string

price

number

cost

number

weight

number

weight_unit

enum<string>

Available options:

lb,

oz,

kg,

g

is_active

boolean

default:true

metadata

object

Response

Variant created

product_variant row

List product variants entity-wide Get a single variant by ID

Overview

All Endpoints

Create a product variant (entity-wide endpoint)

Authorizations

Body

Response