Shirtplatform Webservices API Docs

GET /accounts/{accountId}/shops/{shopId}/products

List products in the shop. Results can be filtered using a previously saved filter. Returns basic product data without expanded sub-resources.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter.Product ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of products per page (default 10)

Response Codes

Code	Condition
200	the list was retrieved successfully

Response Body

Media Type	Data Type	Description
`application/json`	PagedData
`application/xml`	PagedData

Response (XML)

<pagedData>
  <records>...</records>
  <totalElements>...</totalElements>
</pagedData>

Response (JSON)

{
  "pagedData" : {
    "records" : [ { }, { } ],
    "totalElements" : 12345
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}

Get a product by its ID. Returns basic product data without expanded sub-resources.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	Product
`application/xml`	Product

Response (XML)

<product>
  <id>...</id>
  <name>Premium T-shirt</name>
  <amountMultiply>...</amountMultiply>
  <artNr>180.42</artNr>
  <model>Exact 190</model>
  <hsCode>ABC123456789</hsCode>
  <active>...</active>
  <orderIndex>1</orderIndex>
</product>

Response (JSON)

{
  "product" : {
    "id" : 12345,
    "name" : "Premium T-shirt",
    "amountMultiply" : 12345,
    "artNr" : "180.42",
    "model" : "Exact 190",
    "hsCode" : "ABC123456789",
    "active" : true,
    "orderIndex" : 1
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/expanded

List products with all sub-resources expanded inline (views, colors, sizes, SKUs, prices, etc.). This avoids the need for follow-up requests but returns significantly more data per product.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter.Product ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of products per page (default 10)

Response Codes

Code	Condition
200	the list was retrieved successfully

Response Body

Media Type	Data Type	Description
`application/json`	PagedData
`application/xml`	PagedData

Response (XML)

<pagedData>
  <records>...</records>
  <totalElements>...</totalElements>
</pagedData>

Response (JSON)

{
  "pagedData" : {
    "records" : [ { }, { } ],
    "totalElements" : 12345
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/expanded/{productId}

Get a product by its ID with all sub-resources expanded inline (views, colors, sizes, SKUs, prices, localizations, print technologies, etc.).

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	ProductExpanded
`application/xml`	ProductExpanded

Response (XML)

<productExpanded>
  <localizations>
    <productLocalized>
      <id>...</id>
      <language>
        <id>...</id>
        <code>en</code>
        <name>English</name>
      </language>
      <name>Premium T-shirt</name>
      <description>Men's premium shirt</description>
      <shortDescription>A real classic T-shirt for men.</shortDescription>
    </productLocalized>
  </localizations>
  <assignedSizes>
    <assignedProductSizeExpanded>
      <productSize>
        <localizations>
          <productSizeLocalized/>
        </localizations>
      </productSize>
      <id>...</id>
      <orderIndex>1</orderIndex>
      <default>...</default>
      <productSize/>
      <width>47</width>
      <height>68</height>
      <length>...</length>
      <accuracy>...</accuracy>
    </assignedProductSizeExpanded>
  </assignedSizes>
  <assignedColors>
    <assignedProductColorExpanded>
      <productColor>
        <localizations>
          <productColorLocalized/>
        </localizations>
      </productColor>
      <id>...</id>
      <orderIndex>1</orderIndex>
      <productColor/>
      <default>...</default>
      <active>...</active>
    </assignedProductColorExpanded>
  </assignedColors>
  <assignedViews>
    <assignedProductViewExpanded>
      <productView>
        <localizations>
          <productViewLocalized/>
        </localizations>
      </productView>
      <areas>
        <productAreaExpanded>
          <realSizes>
            <areaRealSize/>
          </realSizes>
        </productAreaExpanded>
      </areas>
      <id>...</id>
      <orderIndex>1</orderIndex>
      <productView/>
      <defaultView>...</defaultView>
      <visibleInCreator>...</visibleInCreator>
      <prioritizeOnOverview>...</prioritizeOnOverview>
      <type>...</type>
    </assignedProductViewExpanded>
  </assignedViews>
  <id>...</id>
  <name>Premium T-shirt</name>
  <amountMultiply>...</amountMultiply>
  <artNr>180.42</artNr>
  <model>Exact 190</model>
  <hsCode>ABC123456789</hsCode>
  <active>...</active>
  <orderIndex>1</orderIndex>
</productExpanded>

Response (JSON)

{
  "productExpanded" : {
    "localizations" : {
      "productLocalized" : [ {
        "id" : 12345,
        "language" : {
          "id" : 12345,
          "code" : "en",
          "name" : "English"
        },
        "name" : "Premium T-shirt",
        "description" : "Men's premium shirt",
        "shortDescription" : "A real classic T-shirt for men."
      }, {
        "id" : 12345,
        "language" : {
          "id" : 12345,
          "code" : "en",
          "name" : "English"
        },
        "name" : "Premium T-shirt",
        "description" : "Men's premium shirt",
        "shortDescription" : "A real classic T-shirt for men."
      } ]
    },
    "assignedSizes" : {
      "assignedProductSizeExpanded" : [ {
        "productSize" : {
          "localizations" : {
            "productSizeLocalized" : [ { }, { } ]
          },
          "id" : 12345,
          "name" : "XXL",
          "dimensions" : 12345,
          "groupingId" : "...",
          "groupingDefault" : true
        },
        "id" : 12345,
        "orderIndex" : 1,
        "default" : true,
        "width" : 47.0,
        "height" : 68.0,
        "length" : 12345.0,
        "accuracy" : 12345.0
      }, {
        "productSize" : {
          "localizations" : {
            "productSizeLocalized" : [ { }, { } ]
          },
          "id" : 12345,
          "name" : "XXL",
          "dimensions" : 12345,
          "groupingId" : "...",
          "groupingDefault" : true
        },
        "id" : 12345,
        "orderIndex" : 1,
        "default" : true,
        "width" : 47.0,
        "height" : 68.0,
        "length" : 12345.0,
        "accuracy" : 12345.0
      } ]
    },
    "assignedColors" : {
      "assignedProductColorExpanded" : [ {
        "productColor" : {
          "localizations" : {
            "productColorLocalized" : [ { }, { } ]
          },
          "id" : 12345,
          "name" : "black"
        },
        "id" : 12345,
        "orderIndex" : 1,
        "default" : true,
        "active" : true
      }, {
        "productColor" : {
          "localizations" : {
            "productColorLocalized" : [ { }, { } ]
          },
          "id" : 12345,
          "name" : "black"
        },
        "id" : 12345,
        "orderIndex" : 1,
        "default" : true,
        "active" : true
      } ]
    },
    "assignedViews" : {
      "assignedProductViewExpanded" : [ {
        "productView" : {
          "localizations" : {
            "productViewLocalized" : [ { }, { } ]
          },
          "id" : 12345,
          "name" : "Front view",
          "position" : "Front"
        },
        "areas" : {
          "productAreaExpanded" : [ {
            "realSizes" : {
              "areaRealSize" : [ { }, { } ]
            },
            "id" : 12345,
            "boundsXTwips" : 3390,
            "boundsYTwips" : 3990,
            "boundsWidthTwips" : 3500,
            "boundsHeightTwips" : 5980,
            "name" : "Front",
            "default" : true,
            "xHotSpotTwips" : 12345,
            "yHotSpotTwips" : 12345,
            "sizeHotSpotTwips" : 12345,
            "enabled" : true
          }, {
            "realSizes" : {
              "areaRealSize" : [ { }, { } ]
            },
            "id" : 12345,
            "boundsXTwips" : 3390,
            "boundsYTwips" : 3990,
            "boundsWidthTwips" : 3500,
            "boundsHeightTwips" : 5980,
            "name" : "Front",
            "default" : true,
            "xHotSpotTwips" : 12345,
            "yHotSpotTwips" : 12345,
            "sizeHotSpotTwips" : 12345,
            "enabled" : true
          } ]
        },
        "id" : 12345,
        "orderIndex" : 1,
        "defaultView" : true,
        "visibleInCreator" : true,
        "prioritizeOnOverview" : true,
        "type" : "HUMAN"
      }, {
        "productView" : {
          "localizations" : {
            "productViewLocalized" : [ { }, { } ]
          },
          "id" : 12345,
          "name" : "Front view",
          "position" : "Front"
        },
        "areas" : {
          "productAreaExpanded" : [ {
            "realSizes" : {
              "areaRealSize" : [ { }, { } ]
            },
            "id" : 12345,
            "boundsXTwips" : 3390,
            "boundsYTwips" : 3990,
            "boundsWidthTwips" : 3500,
            "boundsHeightTwips" : 5980,
            "name" : "Front",
            "default" : true,
            "xHotSpotTwips" : 12345,
            "yHotSpotTwips" : 12345,
            "sizeHotSpotTwips" : 12345,
            "enabled" : true
          }, {
            "realSizes" : {
              "areaRealSize" : [ { }, { } ]
            },
            "id" : 12345,
            "boundsXTwips" : 3390,
            "boundsYTwips" : 3990,
            "boundsWidthTwips" : 3500,
            "boundsHeightTwips" : 5980,
            "name" : "Front",
            "default" : true,
            "xHotSpotTwips" : 12345,
            "yHotSpotTwips" : 12345,
            "sizeHotSpotTwips" : 12345,
            "enabled" : true
          } ]
        },
        "id" : 12345,
        "orderIndex" : 1,
        "defaultView" : true,
        "visibleInCreator" : true,
        "prioritizeOnOverview" : true,
        "type" : "TECHNICAL"
      } ]
    },
    "id" : 12345,
    "name" : "Premium T-shirt",
    "amountMultiply" : 12345,
    "artNr" : "180.42",
    "model" : "Exact 190",
    "hsCode" : "ABC123456789",
    "active" : true,
    "orderIndex" : 1
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedAttributeListItems

List attribute list item assignments for a specific product.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter.ProductAssignedAttributeListItem ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	`anyType`

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedCategories

List category assignments for a product.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter.ProductAssignedToCategory ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the list was retrieved successfully

Response Body

Media Type	Data Type	Description
`application/json`	PagedData
`application/xml`	PagedData

Response (XML)

<pagedData>
  <records>...</records>
  <totalElements>...</totalElements>
</pagedData>

Response (JSON)

{
  "pagedData" : {
    "records" : [ { }, { } ],
    "totalElements" : 12345
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedColors

List color assignments for a product.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter.ProductAssignedColor ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the list was retrieved successfully

Response Body

Media Type	Data Type	Description
`application/json`	PagedData
`application/xml`	PagedData

Response (XML)

<pagedData>
  <records>...</records>
  <totalElements>...</totalElements>
</pagedData>

Response (JSON)

{
  "pagedData" : {
    "records" : [ { }, { } ],
    "totalElements" : 12345
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedFactories

List factory assignments for a product.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the list was retrieved successfully

Response Body

Media Type	Data Type	Description
`application/json`	PagedData
`application/xml`	PagedData

Response (XML)

<pagedData>
  <records>...</records>
  <totalElements>...</totalElements>
</pagedData>

Response (JSON)

{
  "pagedData" : {
    "records" : [ { }, { } ],
    "totalElements" : 12345
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedPrintTechnologies

List print technology assignments for a product.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter.ProductAssignedPrintTechnology ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	`anyType`

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedSizes

List size assignments for a product.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter.ProductAssignedSize ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the list was retrieved successfully

Response Body

Media Type	Data Type	Description
`application/json`	PagedData
`application/xml`	PagedData

Response (XML)

<pagedData>
  <records>...</records>
  <totalElements>...</totalElements>
</pagedData>

Response (JSON)

{
  "pagedData" : {
    "records" : [ { }, { } ],
    "totalElements" : 12345
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedViewColors

List all view-color associations for a product across all views.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter.ProductAssignedViewColor ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	`anyType`

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedViews

List view assignments for a product.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter.ProductAssignedView ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the list was retrieved successfully

Response Body

Media Type	Data Type	Description
`application/json`	PagedData
`application/xml`	PagedData

Response (XML)

<pagedData>
  <records>...</records>
  <totalElements>...</totalElements>
</pagedData>

Response (JSON)

{
  "pagedData" : {
    "records" : [ { }, { } ],
    "totalElements" : 12345
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/image

Get a rendered product preview image using the default view and color. The image is generated from the uploaded bitmap or SWF template. Supports resizing, background color, output format, and quality options via query parameters.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`productId`	required	path		int	the unique identifier of the product
`bkg`		query			optional background color as hex RGB string
`height`		query	`-2`	int	the desired image height in pixels (-2 for original size)
`quality`		query	`9`	byte	the image compression quality (0-9, default 9)
`showSticker`		query	`true`	boolean	whether to render sticker overlays (default true)
`type`		query		"GIF" or "JPG" or "PDF" or "PNG" or "TIF" or "WEBP"	the output image format (e.g. PNG, JPEG)
`viewType`		query			optional view type filter (e.g. "front")
`width`		query	`-2`	int	the desired image width in pixels (-2 for original size)

Response Codes

Code	Condition
200	the data was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	`anyType`

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/localizations

List localizations for a product. Each localization contains the translated product name and description for a specific language.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter.ProductLocalized ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the list was retrieved successfully

Response Body

Media Type	Data Type	Description
`application/json`	PagedData
`application/xml`	PagedData

Response (XML)

<pagedData>
  <records>...</records>
  <totalElements>...</totalElements>
</pagedData>

Response (JSON)

{
  "pagedData" : {
    "records" : [ { }, { } ],
    "totalElements" : 12345
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/measurementImage

Get the measurement image for a product. The measurement image shows the product's physical dimensions and sizing information. Supports conditional GET via ETag.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`productId`	required	path		int	the unique identifier of the product

Response Codes

Code	Condition
200	the data was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	`anyType`

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/prices

List prices for a product.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter.ProductPrice ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the list was retrieved successfully

Response Body

Media Type	Data Type	Description
`application/json`	PagedData
`application/xml`	PagedData

Response (XML)

<pagedData>
  <records>...</records>
  <totalElements>...</totalElements>
</pagedData>

Response (JSON)

{
  "pagedData" : {
    "records" : [ { }, { } ],
    "totalElements" : 12345
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/sku

List SKUs (Stock Keeping Units) for a product. Each SKU represents a unique combination of color and size with its own inventory tracking.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter.ProductSku ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the list was retrieved successfully

Response Body

Media Type	Data Type	Description
`application/json`	PagedData
`application/xml`	PagedData

Response (XML)

<pagedData>
  <records>...</records>
  <totalElements>...</totalElements>
</pagedData>

Response (JSON)

{
  "pagedData" : {
    "records" : [ { }, { } ],
    "totalElements" : 12345
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedAttributeListItems/{assignedAttributeListItemId}

Get an attribute list item assignment by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`assignedAttributeListItemId`	required	path	int	the unique identifier of the attribute list item assignment
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	ProductAssignedAttributeListItem
`application/xml`	ProductAssignedAttributeListItem

Response (XML)

<assignedAttributeListItem>
  <id>...</id>
  <listItem>
    <id>...</id>
    <name>...</name>
    <version>...</version>
    <attributeList>
      <id>...</id>
      <name>...</name>
      <version>...</version>
      <containPicture>...</containPicture>
      <containUrl>...</containUrl>
      <link xmlns="http://www.w3.org/2005/Atom"/>
    </attributeList>
    <link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
  </listItem>
  <version>...</version>
  <link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</assignedAttributeListItem>

Response (JSON)

{
  "assignedAttributeListItem" : {
    "id" : 12345,
    "listItem" : {
      "id" : 12345,
      "name" : "...",
      "version" : 12345,
      "attributeList" : { },
      "rest" : [ { }, { } ]
    },
    "version" : 12345,
    "rest" : [ { }, { } ]
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedCategories/{assignedCategoryId}

Get a category assignment by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`assignedCategoryId`	required	path	int	the unique identifier of the category assignment
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	CategoryAssignedToProduct
`application/xml`	CategoryAssignedToProduct

Response (XML)

<categoryAssignedToProduct>
  <id>...</id>
  <version>...</version>
  <orderIndex>...</orderIndex>
  <category>
    <id>...</id>
    <version>...</version>
    <name>...</name>
    <orderIndex>...</orderIndex>
    <active>...</active>
    <deleted>...</deleted>
    <link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
  </category>
  <link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</categoryAssignedToProduct>

Response (JSON)

{
  "categoryAssignedToProduct" : {
    "id" : 12345,
    "version" : 12345,
    "orderIndex" : 12345,
    "category" : {
      "id" : 12345,
      "version" : 12345,
      "name" : "...",
      "orderIndex" : 12345,
      "active" : true,
      "deleted" : true,
      "rest" : [ { }, { } ]
    },
    "rest" : [ { }, { } ]
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedColors/{assignedColorId}

Get a color assignment by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`assignedColorId`	required	path	int	the unique identifier of the color assignment
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	AssignedProductColor
`application/xml`	AssignedProductColor

Response (XML)

<assignedProductColor>
  <id>...</id>
  <orderIndex>1</orderIndex>
  <productColor>
    <id>...</id>
    <name>black</name>
  </productColor>
  <default>...</default>
  <active>...</active>
</assignedProductColor>

Response (JSON)

{
  "assignedProductColor" : {
    "id" : 12345,
    "orderIndex" : 1,
    "productColor" : {
      "id" : 12345,
      "name" : "black"
    },
    "default" : true,
    "active" : true
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedFactories/{assignedFactoryId}

Get a factory assignment by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`assignedFactoryId`	required	path	int	the unique identifier of the factory assignment
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	productAssignedFactoryPrime

Response (XML)

<assignedProductFactory>
  <id>...</id>
  <factoryAssigned>
    <id>...</id>
    <factory>
      <id>...</id>
      <name>...</name>
      <publicFactory>...</publicFactory>
      <version>...</version>
      <ownerAccountId>...</ownerAccountId>
    </factory>
    <orderIndex>...</orderIndex>
    <active>...</active>
    <deleted>...</deleted>
    <version>...</version>
    <default>...</default>
  </factoryAssigned>
  <deleted>...</deleted>
  <version>...</version>
</assignedProductFactory>

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedPrintTechnologies/{assignedPrintTechnologyId}

Get a print technology assignment by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`assignedPrintTechnologyId`	required	path	int	the unique identifier of the print technology assignment
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	ProductAssignedPrintTechnology
`application/xml`	ProductAssignedPrintTechnology

Response (XML)

<assignedPrintTechnology>
  <id>...</id>
  <default>...</default>
  <version>...</version>
  <orderIndex>...</orderIndex>
  <productTypePrintTechnology>
    <id>...</id>
    <default>...</default>
    <active>...</active>
    <version>...</version>
    <printTechnology>
      <id>...</id>
      <version>...</version>
      <name>...</name>
      <orderIndex>...</orderIndex>
      <active>...</active>
      <vectorEnabled>...</vectorEnabled>
      <bitmapEnabled>...</bitmapEnabled>
      <occupiedViewsCount>...</occupiedViewsCount>
      <summarySymbolsEnable>...</summarySymbolsEnable>
      <priceFormula>...</priceFormula>
      <type>...</type>
      <motivePriceFormula>...</motivePriceFormula>
      <barcodeNaming>...</barcodeNaming>
      <enabledCreatorFrontend>...</enabledCreatorFrontend>
      <enabledCreatorBackend>...</enabledCreatorBackend>
      <link xmlns="http://www.w3.org/2005/Atom"/>
    </printTechnology>
    <link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
  </productTypePrintTechnology>
  <link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</assignedPrintTechnology>

Response (JSON)

{
  "assignedPrintTechnology" : {
    "id" : 12345,
    "default" : true,
    "version" : 12345,
    "orderIndex" : 12345,
    "productTypePrintTechnology" : { },
    "rest" : [ { }, { } ]
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedSizes/{assignedSizeId}

Get a size assignment by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`assignedSizeId`	required	path	int	the unique identifier of the size assignment
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	AssignedProductSize
`application/xml`	AssignedProductSize

Response (XML)

<assignedProductSize>
  <id>...</id>
  <orderIndex>1</orderIndex>
  <default>...</default>
  <productSize>
    <id>...</id>
    <name>XXL</name>
    <dimensions>...</dimensions>
    <groupingId>...</groupingId>
    <groupingDefault>...</groupingDefault>
  </productSize>
  <width>47</width>
  <height>68</height>
  <length>...</length>
  <accuracy>...</accuracy>
</assignedProductSize>

Response (JSON)

{
  "assignedProductSize" : {
    "id" : 12345,
    "orderIndex" : 1,
    "default" : true,
    "productSize" : {
      "id" : 12345,
      "name" : "XXL",
      "dimensions" : 12345,
      "groupingId" : "...",
      "groupingDefault" : true
    },
    "width" : 47.0,
    "height" : 68.0,
    "length" : 12345.0,
    "accuracy" : 12345.0
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedViewColors/{assignedViewColorId}

Get a view-color association by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`assignedViewColorId`	required	path	int	the unique identifier of the view-color association
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	ProductAssignedViewColor
`application/xml`	ProductAssignedViewColor

Response (XML)

<productViewColorDetail>
  <id>...</id>
  <version>...</version>
  <layer1Color>...</layer1Color>
  <layer2Color>...</layer2Color>
  <shadows1Alpha>...</shadows1Alpha>
  <shadows2Alpha>...</shadows2Alpha>
  <texAlpha>...</texAlpha>
  <tex2Alpha>...</tex2Alpha>
  <imageId>...</imageId>
  <assignedView>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productView>
      <id>...</id>
      <name>Front view</name>
      <position>Front</position>
    </productView>
    <defaultView>...</defaultView>
    <visibleInCreator>...</visibleInCreator>
    <prioritizeOnOverview>...</prioritizeOnOverview>
    <type>...</type>
  </assignedView>
  <assignedColor>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productColor>
      <id>...</id>
      <name>black</name>
    </productColor>
    <default>...</default>
    <active>...</active>
  </assignedColor>
  <defaultColorValue>
    <id>...</id>
    <version>...</version>
    <colorValue>...</colorValue>
    <orderIndex>...</orderIndex>
    <textureId>...</textureId>
    <reference/>
    <colorId>...</colorId>
    <deleted>...</deleted>
    <tiled>...</tiled>
    <link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
  </defaultColorValue>
  <textureId>...</textureId>
  <link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</productViewColorDetail>

Response (JSON)

{
  "productViewColorDetail" : {
    "id" : 12345,
    "version" : 12345,
    "layer1Color" : "...",
    "layer2Color" : "...",
    "shadows1Alpha" : 12345,
    "shadows2Alpha" : 12345,
    "texAlpha" : 12345,
    "tex2Alpha" : 12345,
    "imageId" : 12345,
    "assignedView" : {
      "id" : 12345,
      "orderIndex" : 1,
      "productView" : {
        "id" : 12345,
        "name" : "Front view",
        "position" : "Front"
      },
      "defaultView" : true,
      "visibleInCreator" : true,
      "prioritizeOnOverview" : true,
      "type" : "TECHNICAL"
    },
    "assignedColor" : {
      "id" : 12345,
      "orderIndex" : 1,
      "productColor" : {
        "id" : 12345,
        "name" : "black"
      },
      "default" : true,
      "active" : true
    },
    "defaultColorValue" : {
      "id" : 12345,
      "version" : 12345,
      "colorValue" : "...",
      "orderIndex" : 12345,
      "textureId" : 12345,
      "reference" : { },
      "colorId" : 12345,
      "deleted" : true,
      "tiled" : true,
      "rest" : [ { }, { } ]
    },
    "textureId" : 12345,
    "rest" : [ { }, { } ]
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedViews/{assignedViewId}

Get a view assignment by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`assignedViewId`	required	path	int	the unique identifier of the view assignment
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	AssignedProductView
`application/xml`	AssignedProductView

Response (XML)

<assignedProductView>
  <id>...</id>
  <orderIndex>1</orderIndex>
  <productView>
    <id>...</id>
    <name>Front view</name>
    <position>Front</position>
  </productView>
  <defaultView>...</defaultView>
  <visibleInCreator>...</visibleInCreator>
  <prioritizeOnOverview>...</prioritizeOnOverview>
  <type>...</type>
</assignedProductView>

Response (JSON)

{
  "assignedProductView" : {
    "id" : 12345,
    "orderIndex" : 1,
    "productView" : {
      "id" : 12345,
      "name" : "Front view",
      "position" : "Front"
    },
    "defaultView" : true,
    "visibleInCreator" : true,
    "prioritizeOnOverview" : true,
    "type" : "TECHNICAL"
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/localizations/{localizationId}

Get a product localization by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`localizationId`	required	path	int	the unique identifier of the localization
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	ProductLocalized
`application/xml`	ProductLocalized

Response (XML)

<productLocalized>
  <id>...</id>
  <language>
    <id>...</id>
    <code>en</code>
    <name>English</name>
  </language>
  <name>Premium T-shirt</name>
  <description>Men's premium shirt</description>
  <shortDescription>A real classic T-shirt for men.</shortDescription>
</productLocalized>

Response (JSON)

{
  "productLocalized" : {
    "id" : 12345,
    "language" : {
      "id" : 12345,
      "code" : "en",
      "name" : "English"
    },
    "name" : "Premium T-shirt",
    "description" : "Men's premium shirt",
    "shortDescription" : "A real classic T-shirt for men."
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/prices/{priceId}

Get a price by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`priceId`	required	path	int	the unique identifier of the price
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	ProductPrice
`application/xml`	ProductPrice

Response (XML)

<productPrice>
  <id>...</id>
  <version>...</version>
  <country>
    <id>...</id>
    <code>UK</code>
    <name>United Kingdom</name>
    <standardVat>
      <id>...</id>
      <percentValue>19</percentValue>
    </standardVat>
    <reducedVat>
      <id>...</id>
      <percentValue>19</percentValue>
    </reducedVat>
    <currency>
      <id>...</id>
      <code>EUR</code>
      <symbol>€</symbol>
      <name>Euro</name>
    </currency>
    <pricePrecision>2</pricePrecision>
    <priceFractionalDigits>2</priceFractionalDigits>
    <default>...</default>
  </country>
  <assignedColor>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productColor>
      <id>...</id>
      <name>black</name>
    </productColor>
    <default>...</default>
    <active>...</active>
  </assignedColor>
  <assignedSize>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <default>...</default>
    <productSize>
      <id>...</id>
      <name>XXL</name>
      <dimensions>...</dimensions>
      <groupingId>...</groupingId>
      <groupingDefault>...</groupingDefault>
    </productSize>
    <width>47</width>
    <height>68</height>
    <length>...</length>
    <accuracy>...</accuracy>
  </assignedSize>
  <amount>...</amount>
  <margin>...</margin>
  <price>...</price>
</productPrice>

Response (JSON)

{
  "productPrice" : {
    "id" : 12345,
    "version" : 12345,
    "country" : {
      "id" : 12345,
      "code" : "UK",
      "name" : "United Kingdom",
      "standardVat" : {
        "id" : 12345,
        "percentValue" : 19.0
      },
      "reducedVat" : {
        "id" : 12345,
        "percentValue" : 19.0
      },
      "currency" : {
        "id" : 12345,
        "code" : "EUR",
        "symbol" : "€",
        "name" : "Euro"
      },
      "pricePrecision" : 2,
      "priceFractionalDigits" : 2,
      "default" : true
    },
    "assignedColor" : {
      "id" : 12345,
      "orderIndex" : 1,
      "productColor" : {
        "id" : 12345,
        "name" : "black"
      },
      "default" : true,
      "active" : true
    },
    "assignedSize" : {
      "id" : 12345,
      "orderIndex" : 1,
      "default" : true,
      "productSize" : {
        "id" : 12345,
        "name" : "XXL",
        "dimensions" : 12345,
        "groupingId" : "...",
        "groupingDefault" : true
      },
      "width" : 47.0,
      "height" : 68.0,
      "length" : 12345.0,
      "accuracy" : 12345.0
    },
    "amount" : 12345,
    "margin" : 12345.0,
    "price" : 12345.0
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/printStyles/userMotives

Get the print style limits for user motives on a product. Print styles define the allowed design techniques (e.g. flex, flock, digital) and their constraints such as maximum dimensions and color counts.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	array of CreatorSE.PrintStyleLimit
`application/xml`	list of CreatorSE.PrintStyleLimit

Response (XML)

<list>
  <creatorse_printStyleLimit>
    <minWidth>0</minWidth>
    <minHeight>0</minHeight>
    <maxWidth>400</maxWidth>
    <maxHeight>600</maxHeight>
    <printTechnology>
      <id>...</id>
      <name>DTG</name>
    </printTechnology>
    <productArea>
      <id>...</id>
      <name>...</name>
      <assignedView>
        <id>...</id>
        <view/>
      </assignedView>
      <realSize>
        <width>...</width>
        <height>...</height>
      </realSize>
    </productArea>
    <assignedSize>
      <id>...</id>
      <size>
        <id>...</id>
        <name>XL</name>
      </size>
    </assignedSize>
  </creatorse_printStyleLimit>
</list>

Response (JSON)

[ {
  "creatorse_printStyleLimit" : {
    "minWidth" : 0.0,
    "minHeight" : 0.0,
    "maxWidth" : 400.0,
    "maxHeight" : 600.0,
    "printTechnology" : {
      "id" : 12345,
      "name" : "DTG"
    },
    "productArea" : {
      "id" : 12345,
      "name" : "...",
      "assignedView" : {
        "id" : 12345,
        "view" : { }
      },
      "realSize" : {
        "width" : 12345.0,
        "height" : 12345.0
      }
    },
    "assignedSize" : {
      "id" : 12345,
      "size" : {
        "id" : 12345,
        "name" : "XL"
      }
    }
  }
} ]

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/sku/{skuId}

Get a SKU by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop
`skuId`	required	path	int	the unique identifier of the SKU

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	ProductSku
`application/xml`	ProductSku

Response (XML)

<productSku>
  <id>...</id>
  <stockId>...</stockId>
  <available>...</available>
  <assignedSize>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <default>...</default>
    <productSize>
      <id>...</id>
      <name>XXL</name>
      <dimensions>...</dimensions>
      <groupingId>...</groupingId>
      <groupingDefault>...</groupingDefault>
    </productSize>
    <width>47</width>
    <height>68</height>
    <length>...</length>
    <accuracy>...</accuracy>
  </assignedSize>
  <assignedColor>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productColor>
      <id>...</id>
      <name>black</name>
    </productColor>
    <default>...</default>
    <active>...</active>
  </assignedColor>
</productSku>

Response (JSON)

{
  "productSku" : {
    "id" : 12345,
    "stockId" : 12345,
    "available" : true,
    "assignedSize" : {
      "id" : 12345,
      "orderIndex" : 1,
      "default" : true,
      "productSize" : {
        "id" : 12345,
        "name" : "XXL",
        "dimensions" : 12345,
        "groupingId" : "...",
        "groupingDefault" : true
      },
      "width" : 47.0,
      "height" : 68.0,
      "length" : 12345.0,
      "accuracy" : 12345.0
    },
    "assignedColor" : {
      "id" : 12345,
      "orderIndex" : 1,
      "productColor" : {
        "id" : 12345,
        "name" : "black"
      },
      "default" : true,
      "active" : true
    }
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/by-sku/{sku}/printStyles/userMotives

Get the print style limits for user motives by SKU string instead of product ID. This is useful when the caller only knows the SKU identifier.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`shopId`	required	path	int	the unique identifier of the shop
`sku`	required	path		the SKU string identifier

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	array of CreatorSE.PrintStyleLimit
`application/xml`	list of CreatorSE.PrintStyleLimit

Response (XML)

<list>
  <creatorse_printStyleLimit>
    <minWidth>0</minWidth>
    <minHeight>0</minHeight>
    <maxWidth>400</maxWidth>
    <maxHeight>600</maxHeight>
    <printTechnology>
      <id>...</id>
      <name>DTG</name>
    </printTechnology>
    <productArea>
      <id>...</id>
      <name>...</name>
      <assignedView>
        <id>...</id>
        <view/>
      </assignedView>
      <realSize>
        <width>...</width>
        <height>...</height>
      </realSize>
    </productArea>
    <assignedSize>
      <id>...</id>
      <size>
        <id>...</id>
        <name>XL</name>
      </size>
    </assignedSize>
  </creatorse_printStyleLimit>
</list>

Response (JSON)

[ {
  "creatorse_printStyleLimit" : {
    "minWidth" : 0.0,
    "minHeight" : 0.0,
    "maxWidth" : 400.0,
    "maxHeight" : 600.0,
    "printTechnology" : {
      "id" : 12345,
      "name" : "DTG"
    },
    "productArea" : {
      "id" : 12345,
      "name" : "...",
      "assignedView" : {
        "id" : 12345,
        "view" : { }
      },
      "realSize" : {
        "width" : 12345.0,
        "height" : 12345.0
      }
    },
    "assignedSize" : {
      "id" : 12345,
      "size" : {
        "id" : 12345,
        "name" : "XL"
      }
    }
  }
} ]

GET

/accounts/{accountId}/shops/{shopId}/products/{productId}/assignedPrintTechnologies/{assignedPrintTechnologyId}/printTechnologyBrothers

List Brother printer setups under a print technology assignment.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`assignedPrintTechnologyId`	required	path		int	the unique identifier of the parent print technology assignment
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	`anyType`

GET

/accounts/{accountId}/shops/{shopId}/products/{productId}/assignedPrintTechnologies/{assignedPrintTechnologyId}/printTechnologyColors

List Color setups under a print technology assignment.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`assignedPrintTechnologyId`	required	path		int	the unique identifier of the parent print technology assignment
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	`anyType`

GET

/accounts/{accountId}/shops/{shopId}/products/{productId}/assignedPrintTechnologies/{assignedPrintTechnologyId}/printTechnologyGenerals

List General printer setups under a print technology assignment.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`assignedPrintTechnologyId`	required	path		int	the unique identifier of the parent print technology assignment
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	`anyType`

GET

/accounts/{accountId}/shops/{shopId}/products/{productId}/assignedPrintTechnologies/{assignedPrintTechnologyId}/printTechnologyKornits

List Kornit printer setups under a print technology assignment.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`assignedPrintTechnologyId`	required	path		int	the unique identifier of the parent print technology assignment
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	`anyType`

GET

/accounts/{accountId}/shops/{shopId}/products/{productId}/assignedPrintTechnologies/{assignedPrintTechnologyId}/printTechnologyMedias

List Media setups under a print technology assignment.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`assignedPrintTechnologyId`	required	path		int	the unique identifier of the parent print technology assignment
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	`anyType`

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedViews/{assignedViewId}/assignedColors

List view-color associations for a product view. Each entry describes how a specific color looks on a specific view, including the product image.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`assignedViewId`	required	path		int	the unique identifier of the view
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter.ProductAssignedViewColor ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the list was retrieved successfully

Response Body

Media Type	Data Type	Description
`application/json`	PagedData
`application/xml`	PagedData

Response (XML)

<pagedData>
  <records>...</records>
  <totalElements>...</totalElements>
</pagedData>

Response (JSON)

{
  "pagedData" : {
    "records" : [ { }, { } ],
    "totalElements" : 12345
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedViews/{assignedViewId}/assignedStickers

List sticker assignments for a product view.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`assignedViewId`	required	path		int	the unique identifier of the view
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter.ProductAssignedSticker ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the list was retrieved successfully

Response Body

Media Type	Data Type	Description
`application/json`	PagedData
`application/xml`	PagedData

Response (XML)

<pagedData>
  <records>...</records>
  <totalElements>...</totalElements>
</pagedData>

Response (JSON)

{
  "pagedData" : {
    "records" : [ { }, { } ],
    "totalElements" : 12345
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedViews/{assignedViewId}/colisions

List collision zones for a product view. Collisions define restricted areas where user designs cannot be placed.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`accountId`	required	path		int	the unique identifier of the account
`assignedViewId`	required	path		int	the unique identifier of the view
`productId`	required	path		int	the unique identifier of the product
`shopId`	required	path		int	the unique identifier of the shop
`filterId`		query			optional saved Filter ID; empty string for all
`page`		query	`0`	int	the zero-based page index (default 0)
`size`		query	`10`	int	the number of items per page (default 10)

Response Codes

Code	Condition
200	the list was retrieved successfully

Response Body

Media Type	Data Type	Description
`application/json`	PagedData
`application/xml`	PagedData

Response (XML)

<pagedData>
  <records>...</records>
  <totalElements>...</totalElements>
</pagedData>

Response (JSON)

{
  "pagedData" : {
    "records" : [ { }, { } ],
    "totalElements" : 12345
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedViews/{assignedViewId}/sourceSwf

Get the source SWF (Flash) file for a product view. The SWF is the vector-based template used by the design creator tool. Supports conditional GET via ETag.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`assignedViewId`	required	path	int	the unique identifier of the view
`productId`	required	path	int	the unique identifier of the product

Response Codes

Code	Condition
200	the data was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/x-shockwave-flash`	`(custom)`
`application/xml`	`anyType`

GET

/accounts/{accountId}/shops/{shopId}/products/{productId}/assignedPrintTechnologies/{assignedPrintTechnologyId}/printTechnologyBrothers/{printTechnologyBrotherId}

Get a Brother printer setup by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`assignedPrintTechnologyId`	required	path	int	the unique identifier of the parent print technology assignment
`printTechnologyBrotherId`	required	path	int	the unique identifier of the Brother setup
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	productAssignedPrintTechnologyBrotherPrime

Response (XML)

<assignedPrintTechnologyBrother>
  <id>...</id>
  <assignedSize>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <default>...</default>
    <productSize>
      <id>...</id>
      <name>XXL</name>
      <dimensions>...</dimensions>
      <groupingId>...</groupingId>
      <groupingDefault>...</groupingDefault>
    </productSize>
    <width>47</width>
    <height>68</height>
    <length>...</length>
    <accuracy>...</accuracy>
  </assignedSize>
  <assignedColor>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productColor>
      <id>...</id>
      <name>black</name>
    </productColor>
    <default>...</default>
    <active>...</active>
  </assignedColor>
  <assignedView>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productView>
      <id>...</id>
      <name>Front view</name>
      <position>Front</position>
    </productView>
    <defaultView>...</defaultView>
    <visibleInCreator>...</visibleInCreator>
    <prioritizeOnOverview>...</prioritizeOnOverview>
    <type>...</type>
  </assignedView>
  <pretreadSpeed>...</pretreadSpeed>
  <pretreadDirectionDouble>...</pretreadDirectionDouble>
  <inkVolume>...</inkVolume>
  <colorMultiplePass>...</colorMultiplePass>
  <printBidirectional>...</printBidirectional>
  <type>...</type>
  <version>...</version>
</assignedPrintTechnologyBrother>

GET

/accounts/{accountId}/shops/{shopId}/products/{productId}/assignedPrintTechnologies/{assignedPrintTechnologyId}/printTechnologyColors/{printTechnologyColorId}

Get a Color setup by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`assignedPrintTechnologyId`	required	path	int	the unique identifier of the parent print technology assignment
`printTechnologyColorId`	required	path	int	the unique identifier of the Color setup
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	productAssignedPrintTechnologyColorPrime

Response (XML)

<assignedPrintTechnologyColor>
  <id>...</id>
  <whiteColor>...</whiteColor>
  <colorValue>
    <id>...</id>
    <version>...</version>
    <colorValue>...</colorValue>
    <orderIndex>...</orderIndex>
    <textureId>...</textureId>
    <reference/>
    <colorId>...</colorId>
    <deleted>...</deleted>
    <tiled>...</tiled>
    <link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
  </colorValue>
  <version>...</version>
</assignedPrintTechnologyColor>

GET

/accounts/{accountId}/shops/{shopId}/products/{productId}/assignedPrintTechnologies/{assignedPrintTechnologyId}/printTechnologyGenerals/{printTechnologyGeneralId}

Get a General printer setup by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`assignedPrintTechnologyId`	required	path	int	the unique identifier of the parent print technology assignment
`printTechnologyGeneralId`	required	path	int	the unique identifier of the General setup
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	productAssignedPrintTechnologyGeneralPrime

Response (XML)

<assignedPrintTechnologyGeneral>
  <id>...</id>
  <assignedColor>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productColor>
      <id>...</id>
      <name>black</name>
    </productColor>
    <default>...</default>
    <active>...</active>
  </assignedColor>
  <assignedView>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productView>
      <id>...</id>
      <name>Front view</name>
      <position>Front</position>
    </productView>
    <defaultView>...</defaultView>
    <visibleInCreator>...</visibleInCreator>
    <prioritizeOnOverview>...</prioritizeOnOverview>
    <type>...</type>
  </assignedView>
  <active>...</active>
  <version>...</version>
</assignedPrintTechnologyGeneral>

GET

/accounts/{accountId}/shops/{shopId}/products/{productId}/assignedPrintTechnologies/{assignedPrintTechnologyId}/printTechnologyKornits/{printTechnologyKornitId}

Get a Kornit printer setup by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`assignedPrintTechnologyId`	required	path	int	the unique identifier of the parent print technology assignment
`printTechnologyKornitId`	required	path	int	the unique identifier of the Kornit setup
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	productAssignedPrintTechnologyKornitPrime

Response (XML)

<assignedPrintTechnologyKornit>
  <id>...</id>
  <assignedSize>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <default>...</default>
    <productSize>
      <id>...</id>
      <name>XXL</name>
      <dimensions>...</dimensions>
      <groupingId>...</groupingId>
      <groupingDefault>...</groupingDefault>
    </productSize>
    <width>47</width>
    <height>68</height>
    <length>...</length>
    <accuracy>...</accuracy>
  </assignedSize>
  <assignedColor>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productColor>
      <id>...</id>
      <name>black</name>
    </productColor>
    <default>...</default>
    <active>...</active>
  </assignedColor>
  <assignedView>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productView>
      <id>...</id>
      <name>Front view</name>
      <position>Front</position>
    </productView>
    <defaultView>...</defaultView>
    <visibleInCreator>...</visibleInCreator>
    <prioritizeOnOverview>...</prioritizeOnOverview>
    <type>...</type>
  </assignedView>
  <mediaName>
    <id>...</id>
    <name>...</name>
    <version>...</version>
  </mediaName>
  <sprayAmount>...</sprayAmount>
  <printSpeed>...</printSpeed>
  <colorPrintMode>...</colorPrintMode>
  <saturation>...</saturation>
  <whitePrintMode>...</whitePrintMode>
  <opacity>...</opacity>
  <hilightWhite>...</hilightWhite>
  <hilightOpacity>...</hilightOpacity>
  <direction>...</direction>
  <version>...</version>
</assignedPrintTechnologyKornit>

GET

/accounts/{accountId}/shops/{shopId}/products/{productId}/assignedPrintTechnologies/{assignedPrintTechnologyId}/printTechnologyMedias/{printTechnologyMediaId}

Get a Media setup by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`assignedPrintTechnologyId`	required	path	int	the unique identifier of the parent print technology assignment
`printTechnologyMediaId`	required	path	int	the unique identifier of the Media setup
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	productAssignedPrintTechnologyMediaPrime

Response (XML)

<assignedPrintTechnologyMedia>
  <id>...</id>
  <assignedSize>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <default>...</default>
    <productSize>
      <id>...</id>
      <name>XXL</name>
      <dimensions>...</dimensions>
      <groupingId>...</groupingId>
      <groupingDefault>...</groupingDefault>
    </productSize>
    <width>47</width>
    <height>68</height>
    <length>...</length>
    <accuracy>...</accuracy>
  </assignedSize>
  <assignedPrintMediaSize>
    <id>...</id>
    <default>...</default>
    <orderIndex>...</orderIndex>
    <version>...</version>
    <mediaSize>
      <id>...</id>
      <name>...</name>
      <width>...</width>
      <length>...</length>
      <version>...</version>
      <orderIndex>...</orderIndex>
      <displayUnit>...</displayUnit>
      <link xmlns="http://www.w3.org/2005/Atom"/>
    </mediaSize>
    <link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
  </assignedPrintMediaSize>
  <assignedView>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productView>
      <id>...</id>
      <name>Front view</name>
      <position>Front</position>
    </productView>
    <defaultView>...</defaultView>
    <visibleInCreator>...</visibleInCreator>
    <prioritizeOnOverview>...</prioritizeOnOverview>
    <type>...</type>
  </assignedView>
  <downgradable>...</downgradable>
  <version>...</version>
</assignedPrintTechnologyMedia>

GET

/accounts/{accountId}/shops/{shopId}/products/{productId}/assignedViews/{assignedViewId}/assignedColors/{assignedColorId}

Get a view-color association by its view and color IDs.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`assignedColorId`	required	path	int	the unique identifier of the color within the view
`assignedViewId`	required	path	int	the unique identifier of the view
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	ProductAssignedViewColor
`application/xml`	ProductAssignedViewColor

Response (XML)

<productViewColorDetail>
  <id>...</id>
  <version>...</version>
  <layer1Color>...</layer1Color>
  <layer2Color>...</layer2Color>
  <shadows1Alpha>...</shadows1Alpha>
  <shadows2Alpha>...</shadows2Alpha>
  <texAlpha>...</texAlpha>
  <tex2Alpha>...</tex2Alpha>
  <imageId>...</imageId>
  <assignedView>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productView>
      <id>...</id>
      <name>Front view</name>
      <position>Front</position>
    </productView>
    <defaultView>...</defaultView>
    <visibleInCreator>...</visibleInCreator>
    <prioritizeOnOverview>...</prioritizeOnOverview>
    <type>...</type>
  </assignedView>
  <assignedColor>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productColor>
      <id>...</id>
      <name>black</name>
    </productColor>
    <default>...</default>
    <active>...</active>
  </assignedColor>
  <defaultColorValue>
    <id>...</id>
    <version>...</version>
    <colorValue>...</colorValue>
    <orderIndex>...</orderIndex>
    <textureId>...</textureId>
    <reference/>
    <colorId>...</colorId>
    <deleted>...</deleted>
    <tiled>...</tiled>
    <link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
  </defaultColorValue>
  <textureId>...</textureId>
  <link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</productViewColorDetail>

Response (JSON)

{
  "productViewColorDetail" : {
    "id" : 12345,
    "version" : 12345,
    "layer1Color" : "...",
    "layer2Color" : "...",
    "shadows1Alpha" : 12345,
    "shadows2Alpha" : 12345,
    "texAlpha" : 12345,
    "tex2Alpha" : 12345,
    "imageId" : 12345,
    "assignedView" : {
      "id" : 12345,
      "orderIndex" : 1,
      "productView" : {
        "id" : 12345,
        "name" : "Front view",
        "position" : "Front"
      },
      "defaultView" : true,
      "visibleInCreator" : true,
      "prioritizeOnOverview" : true,
      "type" : "TECHNICAL"
    },
    "assignedColor" : {
      "id" : 12345,
      "orderIndex" : 1,
      "productColor" : {
        "id" : 12345,
        "name" : "black"
      },
      "default" : true,
      "active" : true
    },
    "defaultColorValue" : {
      "id" : 12345,
      "version" : 12345,
      "colorValue" : "...",
      "orderIndex" : 12345,
      "textureId" : 12345,
      "reference" : { },
      "colorId" : 12345,
      "deleted" : true,
      "tiled" : true,
      "rest" : [ { }, { } ]
    },
    "textureId" : 12345,
    "rest" : [ { }, { } ]
  }
}

GET

/accounts/{accountId}/shops/{shopId}/products/{productId}/assignedViews/{assignedViewId}/assignedStickers/{assignedStickerId}

Get a sticker assignment by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`assignedStickerId`	required	path	int	the unique identifier of the sticker assignment
`assignedViewId`	required	path	int	the unique identifier of the view
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	ProductAssignedSticker
`application/xml`	ProductAssignedSticker

Response (XML)

<assignedProductSticker>
  <id>...</id>
  <sticker>
    <id>...</id>
    <name>...</name>
    <version>...</version>
    <imageId>...</imageId>
  </sticker>
  <onAllColors>...</onAllColors>
  <aboveMotives>...</aboveMotives>
  <creatorOnly>...</creatorOnly>
  <xTwips>...</xTwips>
  <yTwips>...</yTwips>
  <widthTwips>...</widthTwips>
  <heightTwips>...</heightTwips>
  <designWidthTwips>...</designWidthTwips>
  <designHeightTwips>...</designHeightTwips>
  <displayUntil>...</displayUntil>
  <version>...</version>
</assignedProductSticker>

Response (JSON)

{
  "assignedProductSticker" : {
    "id" : 12345,
    "sticker" : {
      "id" : 12345,
      "name" : "...",
      "version" : 12345,
      "imageId" : 12345
    },
    "onAllColors" : true,
    "aboveMotives" : true,
    "creatorOnly" : true,
    "xTwips" : 12345,
    "yTwips" : 12345,
    "widthTwips" : 12345,
    "heightTwips" : 12345,
    "designWidthTwips" : 12345,
    "designHeightTwips" : 12345,
    "displayUntil" : 12345,
    "version" : 12345
  }
}

GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedViews/{assignedViewId}/colisions/{colisionId}

Get a collision zone by its ID.

Parameters

Name		In	Constraints	Description
`x-auth-token`		header		The authentication token
`accountId`	required	path	int	the unique identifier of the account
`assignedViewId`	required	path	int	the unique identifier of the view
`colisionId`	required	path	int	the unique identifier of the collision
`productId`	required	path	int	the unique identifier of the product
`shopId`	required	path	int	the unique identifier of the shop

Response Codes

Code	Condition
200	the resource was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	`object`
`application/xml`	productColisionPrime

Response (XML)

<productColision>
  <id>...</id>
  <version>...</version>
  <boundsXTwips>...</boundsXTwips>
  <boundsYTwips>...</boundsYTwips>
  <boundsWidthTwips>...</boundsWidthTwips>
  <boundsHeightTwips>...</boundsHeightTwips>
  <baseWidthTwips>...</baseWidthTwips>
  <baseHeightTwips>...</baseHeightTwips>
</productColision>

GET

/accounts/{accountId}/shops/{shopId}/products/{productId}/assignedViews/{assignedViewId}/assignedColors/{assignedColorId}/image

Get a rendered product preview image for a specific view and color combination. Supports resizing, background color, output format, and quality options.

Parameters

Name		In	Default	Constraints	Description
`x-auth-token`		header			The authentication token
`assignedColorId`	required	path		int	the unique identifier of the color variant
`assignedViewId`	required	path		int	the unique identifier of the view
`productId`	required	path		int	the unique identifier of the product
`bkg`		query			optional background color as hex RGB string
`height`		query	`-2`	int	the desired image height in pixels (-2 for original size)
`quality`		query	`9`	byte	the image compression quality (0-9, default 9)
`showSticker`		query	`true`	boolean	whether to render sticker overlays (default true)
`type`		query		"GIF" or "JPG" or "PDF" or "PNG" or "TIF" or "WEBP"	the output image format (e.g. PNG, JPEG)
`width`		query	`-2`	int	the desired image width in pixels (-2 for original size)

Response Codes

Code	Condition
200	the data was retrieved successfully
404	the requested resource was not found

Response Body

Media Type	Data Type	Description
`application/json`	array of `number`
`application/xml`	list of `byte`