Create an itemvariant

POST/commerce/{connection_id}/itemvariant

Parameters

Payload

idstring

created_atdate-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

public_namestring

descriptionstring

public_descriptionstring

skustring

barcode, UPC, isbn, etc

is_activeboolean

is_visibleboolean

is_featuredboolean

media array

available_atdate-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

tagsstring array

widthnumber

heightnumber

lengthnumber

weightnumber

size_unit enum

Valid values:

"cm"

"inch"

weight_unit enum

Valid values:

"g"

"kg"

"oz"

"lb"

total_stocknumber

prices array

options array

inventory_idstring

requires_shippingboolean

metadata array

items array

references CommerceItem

raw

Returns

CommerceItemvariant

Response field	Type	Required	Description
`id`	string	No
`created_at`	string (date-time)	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`name`	string	No
`public_name`	string	No
`description`	string	No
`public_description`	string	No
`sku`	string	No	barcode, UPC, isbn, etc
`is_active`	boolean	No
`is_visible`	boolean	No
`is_featured`	boolean	No
`media`	CommerceItemMedia[]	No
`media[].id`	string	No
`media[].url`	string	Yes
`media[].alt`	string	No
`media[].type`	enum	No	Values: `image`, `video`
`media[].height`	number	No
`media[].width`	number	No
`media[].position`	number	No	1 is the first
`media[].metadata`	CommerceMetadata[]	No
`media[].metadata[].id`	string	No
`media[].metadata[].value`	object	No
`media[].metadata[].namespace`	string	No
`media[].metadata[].format`	enum	No	Values: `TEXT`, `NUMBER`, `DATE`, `BOOLEAN`, `FILE`, `TEXTAREA`, `SINGLE_SELECT`, `MULTIPLE_SELECT`, `MEASUREMENT`, `PRICE`, `YES_NO`, `CURRENCY`, `URL`
`media[].metadata[].extra_data`	object	No
`media[].metadata[].slug`	string	No
`media[].metadata[].description`	string	No
`media[].metadata[].is_required`	boolean	No
`available_at`	string (date-time)	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`tags`	string[]	No
`width`	number	No
`height`	number	No
`length`	number	No
`weight`	number	No
`size_unit`	enum	No	Values: `cm`, `inch`
`weight_unit`	enum	No	Values: `g`, `kg`, `oz`, `lb`
`total_stock`	number	No
`prices`	CommerceItemPrice[]	No
`prices[].price`	number	Yes
`prices[].compare_at_price`	number	No	The original price of the item before an adjustment or a sale.
`prices[].currency`	string	No
`options`	CommerceItemOption[]	No
`options[].id`	string	No
`options[].name`	string	Yes
`options[].position`	number	No
`options[].values`	string[]	Yes
`inventory_id`	string	No
`requires_shipping`	boolean	No
`metadata`	CommerceMetadata[]	No
`metadata[].id`	string	No
`metadata[].value`	object	No
`metadata[].namespace`	string	No
`metadata[].format`	enum	No	Values: `TEXT`, `NUMBER`, `DATE`, `BOOLEAN`, `FILE`, `TEXTAREA`, `SINGLE_SELECT`, `MULTIPLE_SELECT`, `MEASUREMENT`, `PRICE`, `YES_NO`, `CURRENCY`, `URL`
`metadata[].extra_data`	object	No
`metadata[].slug`	string	No
`metadata[].description`	string	No
`metadata[].is_required`	boolean	No
`items`	CommerceReference[]	No	references CommerceItem
`items[].id`	string	No
`items[].name`	string	No
`items[].type`	string	No

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'POST',
  url: 'https://api.unified.to/commerce/5de520f96e439b002043d8dc/itemvariant',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const results = await sdk.commerce.createCommerceItemvariant({ connectionId, commerceItemvariant: { }, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'POST',
  url: 'https://api.unified.to/commerce/5de520f96e439b002043d8dc/itemvariant',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("POST", "https://api.unified.to/commerce/5de520f96e439b002043d8dc/itemvariant?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/commerce/5de520f96e439b002043d8dc/itemvariant?fields=&raw=

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/commerce/5de520f96e439b002043d8dc/itemvariant?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.post(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/commerce/5de520f96e439b002043d8dc/itemvariant?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/commerce/5de520f96e439b002043d8dc/itemvariant?fields=&raw=")

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

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

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

cURL

curl --request POST \
  --url 'https://api.unified.to/commerce/5de520f96e439b002043d8dc/itemvariant?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?