curl --request GET \
--url https://app.amber.ai/api/public/v1/brands/{brand}/products/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.amber.ai/api/public/v1/brands/{brand}/products/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.amber.ai/api/public/v1/brands/{brand}/products/{id}', 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.amber.ai/api/public/v1/brands/{brand}/products/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.amber.ai/api/public/v1/brands/{brand}/products/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.amber.ai/api/public/v1/brands/{brand}/products/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.amber.ai/api/public/v1/brands/{brand}/products/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"code": "<string>",
"name": "<string>",
"status": "<string>",
"description": "<string>",
"category": "<string>",
"categoryId": "<string>",
"variants": [
{
"id": "<string>",
"sku": "<string>",
"color": "<string>",
"size": "<string>"
}
],
"suppliers": [
{
"id": "<string>",
"name": "<string>",
"shortName": "<string>"
}
],
"createdAt": "<string>",
"updatedAt": "<string>",
"launchWindow": "<string>",
"estimatedVolume": 123,
"globalMoq": 123,
"htsCodeOverride": "<string>",
"customFields": "<unknown>",
"productOwnerUserId": "<string>",
"currentProductVersionId": "<string>",
"optionGroupCurveId": "<string>",
"lastActivityAt": "<string>",
"included": {
"documents": {
"items": [
{
"subjects": [
{
"subjectKind": "<string>",
"subjectKey": "<string>",
"establishedAs": "<string>",
"subjectLabel": "<string>"
}
],
"id": "<string>",
"ownerType": "<string>",
"ownerId": "<string>",
"visibility": "<string>",
"documentTypeId": "<string>",
"dataValue": "<string>",
"fileName": "<string>",
"mimeType": "<string>",
"fileSizeBytes": 123,
"channel": "<string>",
"source": "<string>",
"supersededByDocumentId": "<string>",
"supersededAt": "<string>",
"supersededReason": "<string>",
"senderRole": "<string>",
"issuerName": "<string>",
"extent": "<unknown>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"subjectKind": "<string>",
"subjectKey": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"images": {
"items": [
{
"id": "<string>",
"filename": "<string>",
"fileSize": 123,
"mimeType": "<string>",
"category": "<string>",
"entityId": "<string>",
"entityType": "<string>",
"description": "<string>",
"title": "<string>",
"idx": 123,
"isThumbnail": true,
"isInternal": true,
"uploadedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"bomSections": {
"items": [
{
"id": "<string>",
"code": "<string>",
"name": "<string>",
"sequence": 123,
"relevantFieldKeys": "<unknown>",
"deletedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"launchWindowDefinitions": {
"items": [
{
"id": "<string>",
"collectionId": "<string>",
"name": "<string>",
"code": "<string>",
"uiColor": "<string>",
"launchStartDate": "<string>",
"launchEndDate": "<string>",
"deletedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"tagDefinitions": {
"items": [
{
"id": "<string>",
"name": "<string>",
"code": "<string>",
"uiColor": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"collectionDefinitions": {
"items": [
{
"id": "<string>",
"name": "<string>",
"code": "<string>",
"uiColor": "<string>",
"customFields": "<unknown>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"dimensionValueDefinitions": {
"items": [
{
"id": "<string>",
"dimensionId": "<string>",
"value": "<string>",
"customerFacingLabel": "<string>",
"sequence": 123,
"skuCode": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"dimensionDefinitions": {
"items": [
{
"id": "<string>",
"name": "<string>",
"code": "<string>",
"skuSequence": 123,
"listSequence": 123,
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"optionValueDefinitions": {
"items": [
{
"id": "<string>",
"optionId": "<string>",
"name": "<string>",
"code": "<string>",
"status": "<string>",
"sequence": 123,
"hexCode": "<string>",
"swatchVersion": 123,
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"optionDefinitions": {
"items": [
{
"id": "<string>",
"name": "<string>",
"key": "<string>",
"sequence": 123,
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"categories": {
"items": [
{
"id": "<string>",
"parentId": "<string>",
"name": "<string>",
"code": "<string>",
"defaultHtsCode": "<string>",
"defaultSizeSystemId": "<string>",
"defaultTargetSize": "<string>",
"nextValue": 123,
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"colors": {
"items": [
{
"id": "<string>",
"status": "<string>",
"code": "<string>",
"name": "<string>",
"hexCode": "<string>",
"swatchVersion": 123,
"customFields": "<unknown>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"materialVariants": {
"items": [
{
"id": "<string>",
"componentId": "<string>",
"supplierMaterialVariantName": "<string>",
"supplierMaterialVariantCode": "<string>",
"negotiatedPrice": "<string>",
"negotiatedPriceCurrency": "<string>",
"imageVersion": 123,
"hexCode": "<string>",
"colorId": "<string>",
"customFields": "<unknown>",
"status": "<string>",
"deletedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"materials": {
"items": [
{
"id": "<string>",
"bomSectionId": "<string>",
"name": "<string>",
"code": "<string>",
"composition": "<string>",
"description": "<string>",
"gsm": 123,
"supplier": "<string>",
"supplierProductCode": "<string>",
"status": "<string>",
"negotiatedPrice": "<string>",
"negotiatedPriceCurrency": "<string>",
"properties": "<unknown>",
"customFields": "<unknown>",
"imageVersion": 123,
"deletedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"productOptions": {
"items": [
{
"id": "<string>",
"productId": "<string>",
"name": "<string>",
"vendorFacingProductName": "<string>",
"sequence": 123,
"status": "<string>",
"supplierId": "<string>",
"collectionId": "<string>",
"launchWindow": "<string>",
"channel": "<string>",
"measurementTableId": "<string>",
"construction": "<string>",
"hsCode": "<string>",
"hsConfirmed": true,
"hsWhy": "<string>",
"customFields": "<unknown>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"skus": {
"items": [
{
"id": "<string>",
"productId": "<string>",
"code": "<string>",
"status": "<string>",
"upc": "<string>",
"retailPrice": "<string>",
"wholesalePrice": "<string>",
"colorId": "<string>",
"htsCodeOverride": "<string>",
"productOptionId": "<string>",
"targetFobOverride": "<string>",
"launchWindowOverride": "<string>",
"collectionIdsOverride": "<unknown>",
"weightValue": "<string>",
"weightUomId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"versions": {
"items": [
{
"id": "<string>",
"productId": "<string>",
"versionNumber": 123,
"versionName": "<string>",
"status": "<string>",
"isActive": true,
"weightValue": "<string>",
"weightUomId": "<string>",
"targetFob": "<string>",
"targetFobCurrency": "<string>",
"priceCurrency": "<string>",
"moq": 123,
"moqByColor": 123,
"moqLastConfirmedAt": "<string>",
"technicalSpecs": "<unknown>",
"packagingSpecs": "<unknown>",
"labelingSpecs": "<unknown>",
"sizeSpecs": "<unknown>",
"baseVersionId": "<string>",
"protoId": "<string>",
"partnerId": "<string>",
"notes": "<string>",
"changesSummary": "<string>",
"approvedAt": "<string>",
"approvedBy": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"boms": {
"items": [
{
"id": "<string>",
"productVersionId": "<string>",
"name": "<string>",
"isDefault": true,
"constructionAnnotations": "<unknown>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"bomComponents": {
"items": [
{
"id": "<string>",
"bomId": "<string>",
"componentId": "<string>",
"componentVariantId": "<string>",
"bomSectionId": "<string>",
"name": "<string>",
"composition": "<string>",
"quantity": "<string>",
"unitPrice": "<string>",
"gsm": 123,
"supplier": "<string>",
"notes": "<string>",
"properties": "<unknown>",
"showOnPo": true,
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"measurementTables": {
"items": [
{
"id": "<string>",
"productVersionId": "<string>",
"name": "<string>",
"sizeSpecs": "<unknown>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"optionValues": {
"items": [
{
"productOptionId": "<string>",
"optionValueId": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"dimensionValues": {
"items": [
{
"productOptionId": "<string>",
"dimensionValueId": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"prices": {
"items": [
{
"productOptionId": "<string>",
"kind": "<string>",
"currency": "<string>",
"amount": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"optionCollections": {
"items": [
{
"productOptionId": "<string>",
"collectionId": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"bomSkus": {
"items": [
{
"bomId": "<string>",
"skuId": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"measurementTableSkus": {
"items": [
{
"measurementTableId": "<string>",
"skuId": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"skuDimensionValues": {
"items": [
{
"skuId": "<string>",
"dimensionValueId": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"collections": {
"items": [
{
"id": "<string>",
"productId": "<string>",
"collectionId": "<string>",
"quantity": 123,
"unitPrice": "<string>",
"notes": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"tags": {
"items": [
{
"productId": "<string>",
"tagId": "<string>",
"createdAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"launchWindows": {
"items": [
{
"productId": "<string>",
"launchWindowId": "<string>",
"createdAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"relations": {
"items": [
{
"id": "<string>",
"productId": "<string>",
"relatedProductId": "<string>",
"relationType": "<string>",
"createdByUserId": "<string>",
"createdAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
}
}
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}Get Parent Products
curl --request GET \
--url https://app.amber.ai/api/public/v1/brands/{brand}/products/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.amber.ai/api/public/v1/brands/{brand}/products/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.amber.ai/api/public/v1/brands/{brand}/products/{id}', 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.amber.ai/api/public/v1/brands/{brand}/products/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.amber.ai/api/public/v1/brands/{brand}/products/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.amber.ai/api/public/v1/brands/{brand}/products/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.amber.ai/api/public/v1/brands/{brand}/products/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"code": "<string>",
"name": "<string>",
"status": "<string>",
"description": "<string>",
"category": "<string>",
"categoryId": "<string>",
"variants": [
{
"id": "<string>",
"sku": "<string>",
"color": "<string>",
"size": "<string>"
}
],
"suppliers": [
{
"id": "<string>",
"name": "<string>",
"shortName": "<string>"
}
],
"createdAt": "<string>",
"updatedAt": "<string>",
"launchWindow": "<string>",
"estimatedVolume": 123,
"globalMoq": 123,
"htsCodeOverride": "<string>",
"customFields": "<unknown>",
"productOwnerUserId": "<string>",
"currentProductVersionId": "<string>",
"optionGroupCurveId": "<string>",
"lastActivityAt": "<string>",
"included": {
"documents": {
"items": [
{
"subjects": [
{
"subjectKind": "<string>",
"subjectKey": "<string>",
"establishedAs": "<string>",
"subjectLabel": "<string>"
}
],
"id": "<string>",
"ownerType": "<string>",
"ownerId": "<string>",
"visibility": "<string>",
"documentTypeId": "<string>",
"dataValue": "<string>",
"fileName": "<string>",
"mimeType": "<string>",
"fileSizeBytes": 123,
"channel": "<string>",
"source": "<string>",
"supersededByDocumentId": "<string>",
"supersededAt": "<string>",
"supersededReason": "<string>",
"senderRole": "<string>",
"issuerName": "<string>",
"extent": "<unknown>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"subjectKind": "<string>",
"subjectKey": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"images": {
"items": [
{
"id": "<string>",
"filename": "<string>",
"fileSize": 123,
"mimeType": "<string>",
"category": "<string>",
"entityId": "<string>",
"entityType": "<string>",
"description": "<string>",
"title": "<string>",
"idx": 123,
"isThumbnail": true,
"isInternal": true,
"uploadedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"bomSections": {
"items": [
{
"id": "<string>",
"code": "<string>",
"name": "<string>",
"sequence": 123,
"relevantFieldKeys": "<unknown>",
"deletedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"launchWindowDefinitions": {
"items": [
{
"id": "<string>",
"collectionId": "<string>",
"name": "<string>",
"code": "<string>",
"uiColor": "<string>",
"launchStartDate": "<string>",
"launchEndDate": "<string>",
"deletedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"tagDefinitions": {
"items": [
{
"id": "<string>",
"name": "<string>",
"code": "<string>",
"uiColor": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"collectionDefinitions": {
"items": [
{
"id": "<string>",
"name": "<string>",
"code": "<string>",
"uiColor": "<string>",
"customFields": "<unknown>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"dimensionValueDefinitions": {
"items": [
{
"id": "<string>",
"dimensionId": "<string>",
"value": "<string>",
"customerFacingLabel": "<string>",
"sequence": 123,
"skuCode": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"dimensionDefinitions": {
"items": [
{
"id": "<string>",
"name": "<string>",
"code": "<string>",
"skuSequence": 123,
"listSequence": 123,
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"optionValueDefinitions": {
"items": [
{
"id": "<string>",
"optionId": "<string>",
"name": "<string>",
"code": "<string>",
"status": "<string>",
"sequence": 123,
"hexCode": "<string>",
"swatchVersion": 123,
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"optionDefinitions": {
"items": [
{
"id": "<string>",
"name": "<string>",
"key": "<string>",
"sequence": 123,
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"categories": {
"items": [
{
"id": "<string>",
"parentId": "<string>",
"name": "<string>",
"code": "<string>",
"defaultHtsCode": "<string>",
"defaultSizeSystemId": "<string>",
"defaultTargetSize": "<string>",
"nextValue": 123,
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"colors": {
"items": [
{
"id": "<string>",
"status": "<string>",
"code": "<string>",
"name": "<string>",
"hexCode": "<string>",
"swatchVersion": 123,
"customFields": "<unknown>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"materialVariants": {
"items": [
{
"id": "<string>",
"componentId": "<string>",
"supplierMaterialVariantName": "<string>",
"supplierMaterialVariantCode": "<string>",
"negotiatedPrice": "<string>",
"negotiatedPriceCurrency": "<string>",
"imageVersion": 123,
"hexCode": "<string>",
"colorId": "<string>",
"customFields": "<unknown>",
"status": "<string>",
"deletedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"materials": {
"items": [
{
"id": "<string>",
"bomSectionId": "<string>",
"name": "<string>",
"code": "<string>",
"composition": "<string>",
"description": "<string>",
"gsm": 123,
"supplier": "<string>",
"supplierProductCode": "<string>",
"status": "<string>",
"negotiatedPrice": "<string>",
"negotiatedPriceCurrency": "<string>",
"properties": "<unknown>",
"customFields": "<unknown>",
"imageVersion": 123,
"deletedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"productOptions": {
"items": [
{
"id": "<string>",
"productId": "<string>",
"name": "<string>",
"vendorFacingProductName": "<string>",
"sequence": 123,
"status": "<string>",
"supplierId": "<string>",
"collectionId": "<string>",
"launchWindow": "<string>",
"channel": "<string>",
"measurementTableId": "<string>",
"construction": "<string>",
"hsCode": "<string>",
"hsConfirmed": true,
"hsWhy": "<string>",
"customFields": "<unknown>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"skus": {
"items": [
{
"id": "<string>",
"productId": "<string>",
"code": "<string>",
"status": "<string>",
"upc": "<string>",
"retailPrice": "<string>",
"wholesalePrice": "<string>",
"colorId": "<string>",
"htsCodeOverride": "<string>",
"productOptionId": "<string>",
"targetFobOverride": "<string>",
"launchWindowOverride": "<string>",
"collectionIdsOverride": "<unknown>",
"weightValue": "<string>",
"weightUomId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"versions": {
"items": [
{
"id": "<string>",
"productId": "<string>",
"versionNumber": 123,
"versionName": "<string>",
"status": "<string>",
"isActive": true,
"weightValue": "<string>",
"weightUomId": "<string>",
"targetFob": "<string>",
"targetFobCurrency": "<string>",
"priceCurrency": "<string>",
"moq": 123,
"moqByColor": 123,
"moqLastConfirmedAt": "<string>",
"technicalSpecs": "<unknown>",
"packagingSpecs": "<unknown>",
"labelingSpecs": "<unknown>",
"sizeSpecs": "<unknown>",
"baseVersionId": "<string>",
"protoId": "<string>",
"partnerId": "<string>",
"notes": "<string>",
"changesSummary": "<string>",
"approvedAt": "<string>",
"approvedBy": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"boms": {
"items": [
{
"id": "<string>",
"productVersionId": "<string>",
"name": "<string>",
"isDefault": true,
"constructionAnnotations": "<unknown>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"bomComponents": {
"items": [
{
"id": "<string>",
"bomId": "<string>",
"componentId": "<string>",
"componentVariantId": "<string>",
"bomSectionId": "<string>",
"name": "<string>",
"composition": "<string>",
"quantity": "<string>",
"unitPrice": "<string>",
"gsm": 123,
"supplier": "<string>",
"notes": "<string>",
"properties": "<unknown>",
"showOnPo": true,
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"measurementTables": {
"items": [
{
"id": "<string>",
"productVersionId": "<string>",
"name": "<string>",
"sizeSpecs": "<unknown>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"optionValues": {
"items": [
{
"productOptionId": "<string>",
"optionValueId": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"dimensionValues": {
"items": [
{
"productOptionId": "<string>",
"dimensionValueId": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"prices": {
"items": [
{
"productOptionId": "<string>",
"kind": "<string>",
"currency": "<string>",
"amount": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"optionCollections": {
"items": [
{
"productOptionId": "<string>",
"collectionId": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"bomSkus": {
"items": [
{
"bomId": "<string>",
"skuId": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"measurementTableSkus": {
"items": [
{
"measurementTableId": "<string>",
"skuId": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"skuDimensionValues": {
"items": [
{
"skuId": "<string>",
"dimensionValueId": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"collections": {
"items": [
{
"id": "<string>",
"productId": "<string>",
"collectionId": "<string>",
"quantity": 123,
"unitPrice": "<string>",
"notes": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"tags": {
"items": [
{
"productId": "<string>",
"tagId": "<string>",
"createdAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"launchWindows": {
"items": [
{
"productId": "<string>",
"launchWindowId": "<string>",
"createdAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
},
"relations": {
"items": [
{
"id": "<string>",
"productId": "<string>",
"relatedProductId": "<string>",
"relationType": "<string>",
"createdByUserId": "<string>",
"createdAt": "<string>"
}
],
"nextCursor": "<string>",
"totalItems": 4503599627370495,
"url": "<string>"
}
}
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}Authorizations
A brand-scoped or global amb_sk_... API key.
Path Parameters
Brand slug authorized by this API key.
"acme"
Stable resource identifier.
Query Parameters
Comma-separated: documents, images, bomSections, launchWindowDefinitions, tagDefinitions, collectionDefinitions, dimensionValueDefinitions, dimensionDefinitions, optionValueDefinitions, optionDefinitions, categories, colors, materialVariants, materials, productOptions, skus, versions, boms, bomComponents, measurementTables, optionValues, dimensionValues, prices, optionCollections, bomSkus, measurementTableSkus, skuDimensionValues, collections, tags, launchWindows, relations, or all. Each relation includes up to includeLimit rows (default 25, maximum 100), a totalItems count, and a URL carrying the filters and page size to combine with nextCursor. Reads run in batches of at most 3 relationships. Each distinct include costs one expansion credit from a per-key budget shared across brands: capacity 62, default refill 1,000 credits/hour. Exhaustion returns 429 with Retry-After. Continuation URLs do not consume expansion credits.
"boms,bomComponents,measurementTables,productOptions,materials"
Rows per included relationship, default 25. Requires include. Each relationship has its own continuation cursor.
1 <= x <= 100Response
Visible entity.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes