Create Reference Item Alternative
curl --request POST \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/core-changes/create-as-alternative \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"name": "<string>",
"values": {
"dimensions": "<string>",
"finish": "<string>"
},
"referenceItemVersion": 123,
"entryVersion": 123,
"collectionVersion": 123,
"sku": "<string>",
"autoGenerateSku": false
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/core-changes/create-as-alternative"
payload = {
"name": "<string>",
"values": {
"dimensions": "<string>",
"finish": "<string>"
},
"referenceItemVersion": 123,
"entryVersion": 123,
"collectionVersion": 123,
"sku": "<string>",
"autoGenerateSku": False
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
values: {dimensions: '<string>', finish: '<string>'},
referenceItemVersion: 123,
entryVersion: 123,
collectionVersion: 123,
sku: '<string>',
autoGenerateSku: false
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/core-changes/create-as-alternative', 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://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/core-changes/create-as-alternative",
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([
'name' => '<string>',
'values' => [
'dimensions' => '<string>',
'finish' => '<string>'
],
'referenceItemVersion' => 123,
'entryVersion' => 123,
'collectionVersion' => 123,
'sku' => '<string>',
'autoGenerateSku' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/core-changes/create-as-alternative"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"values\": {\n \"dimensions\": \"<string>\",\n \"finish\": \"<string>\"\n },\n \"referenceItemVersion\": 123,\n \"entryVersion\": 123,\n \"collectionVersion\": 123,\n \"sku\": \"<string>\",\n \"autoGenerateSku\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/core-changes/create-as-alternative")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"values\": {\n \"dimensions\": \"<string>\",\n \"finish\": \"<string>\"\n },\n \"referenceItemVersion\": 123,\n \"entryVersion\": 123,\n \"collectionVersion\": 123,\n \"sku\": \"<string>\",\n \"autoGenerateSku\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/core-changes/create-as-alternative")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"values\": {\n \"dimensions\": \"<string>\",\n \"finish\": \"<string>\"\n },\n \"referenceItemVersion\": 123,\n \"entryVersion\": 123,\n \"collectionVersion\": 123,\n \"sku\": \"<string>\",\n \"autoGenerateSku\": false\n}"
response = http.request(request)
puts response.read_body{
"item": {
"kind": "catalog_item",
"catalogItemId": "<string>",
"catalogFamilySourceId": "<string>",
"catalogFamilyName": "<string>",
"catalogAttributes": {
"family": {},
"item": {},
"familySource": {},
"itemSource": {}
},
"catalogFamilyVersion": 123,
"catalogItemVersion": 123,
"catalogItemSourceVersion": 123,
"id": "<string>",
"referenceCode": "<string>",
"name": "<string>",
"vendorName": "<string>",
"sourceLabel": "<string>",
"imageUrl": "<string>",
"available": true,
"status": "draft",
"position": 123,
"version": 123,
"dimensions": "<string>",
"finish": "<string>",
"quantity": "<string>",
"price": "<string>",
"writableValueFields": [
"finish"
],
"materialsCount": 123,
"partsCount": 123,
"componentsCount": 123
},
"created": true,
"entryVersion": 123,
"collectionVersion": 123
}Collections
Create Reference Item Alternative
POST
/
v1
/
workspaces
/
{workspaceId}
/
collections
/
{id}
/
entries
/
{entryId}
/
reference-items
/
{referenceItemId}
/
core-changes
/
create-as-alternative
Create Reference Item Alternative
curl --request POST \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/core-changes/create-as-alternative \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"name": "<string>",
"values": {
"dimensions": "<string>",
"finish": "<string>"
},
"referenceItemVersion": 123,
"entryVersion": 123,
"collectionVersion": 123,
"sku": "<string>",
"autoGenerateSku": false
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/core-changes/create-as-alternative"
payload = {
"name": "<string>",
"values": {
"dimensions": "<string>",
"finish": "<string>"
},
"referenceItemVersion": 123,
"entryVersion": 123,
"collectionVersion": 123,
"sku": "<string>",
"autoGenerateSku": False
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
values: {dimensions: '<string>', finish: '<string>'},
referenceItemVersion: 123,
entryVersion: 123,
collectionVersion: 123,
sku: '<string>',
autoGenerateSku: false
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/core-changes/create-as-alternative', 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://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/core-changes/create-as-alternative",
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([
'name' => '<string>',
'values' => [
'dimensions' => '<string>',
'finish' => '<string>'
],
'referenceItemVersion' => 123,
'entryVersion' => 123,
'collectionVersion' => 123,
'sku' => '<string>',
'autoGenerateSku' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/core-changes/create-as-alternative"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"values\": {\n \"dimensions\": \"<string>\",\n \"finish\": \"<string>\"\n },\n \"referenceItemVersion\": 123,\n \"entryVersion\": 123,\n \"collectionVersion\": 123,\n \"sku\": \"<string>\",\n \"autoGenerateSku\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/core-changes/create-as-alternative")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"values\": {\n \"dimensions\": \"<string>\",\n \"finish\": \"<string>\"\n },\n \"referenceItemVersion\": 123,\n \"entryVersion\": 123,\n \"collectionVersion\": 123,\n \"sku\": \"<string>\",\n \"autoGenerateSku\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/core-changes/create-as-alternative")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"values\": {\n \"dimensions\": \"<string>\",\n \"finish\": \"<string>\"\n },\n \"referenceItemVersion\": 123,\n \"entryVersion\": 123,\n \"collectionVersion\": 123,\n \"sku\": \"<string>\",\n \"autoGenerateSku\": false\n}"
response = http.request(request)
puts response.read_body{
"item": {
"kind": "catalog_item",
"catalogItemId": "<string>",
"catalogFamilySourceId": "<string>",
"catalogFamilyName": "<string>",
"catalogAttributes": {
"family": {},
"item": {},
"familySource": {},
"itemSource": {}
},
"catalogFamilyVersion": 123,
"catalogItemVersion": 123,
"catalogItemSourceVersion": 123,
"id": "<string>",
"referenceCode": "<string>",
"name": "<string>",
"vendorName": "<string>",
"sourceLabel": "<string>",
"imageUrl": "<string>",
"available": true,
"status": "draft",
"position": 123,
"version": 123,
"dimensions": "<string>",
"finish": "<string>",
"quantity": "<string>",
"price": "<string>",
"writableValueFields": [
"finish"
],
"materialsCount": 123,
"partsCount": 123,
"componentsCount": 123
},
"created": true,
"entryVersion": 123,
"collectionVersion": 123
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Path Parameters
Body
application/json
Choose exactly one SKU mode: provide sku for manual mode, or set autoGenerateSku=true and omit sku.
Required string length:
1 - 255Show child attributes
Show child attributes
Required range:
x <= 9007199254740991Required range:
x <= 9007199254740991Required range:
x <= 9007199254740991Manual SKU for the new alternative. Required when autoGenerateSku is omitted or false; omit when autoGenerateSku is true.
When true, the server generates the SKU and sku must be omitted.
⌘I