⌘K
The Product set Object
Attributes
createdAt
date
Timestamp when the product set was created.
id
string
Unique identifier for the object.
name
string
Unique name of the product set.
products
array of Products
Products contained in the product set.
Show child attributes
designs
array of Designs
Designs contained in the product.
Show child attributes
height
number
Height of the design in pixels.
id
string
Unique identifier of the design.
image
Image
Image URL and preview images.
Show child attributes
previews
Previews
Preview images of the original image in various sizes.
Show child attributes
lg
string
Large preview image URL up to 1920x1920 pixels.
sm
string
Small preview image URL up to 320x320 pixels.
xs
string
Extra small preview image URL up to 96x96 pixels.
url
string
Original source url of the image.
order
number
Order of the design within the product, starting at 0.
rotation
number
Clockwise rotation of the design in degrees (0-360).
width
number
Width of the design in pixels.
x
number
X-position in pixels of the top left corner of the image inside the design canvas, which includes the bleed area. The coordinates of the top left-corner are (0, 0). The coordinates of the bottom-right corner are (width x 300, height x 300), where width and height are in inches.
y
number
Y-position in pixels of the top left corner of the image inside the design canvas, which includes the bleed area. The coordinates of the top left-corner are (0, 0). The coordinates of the bottom-right corner are (width x 300, height x 300), where width and height are in inches.
frameStyle
enum
Frame style of the product. This is only relevant for framed products.
Possible enum values
PremiumMetalPremiumOakUnframedMetalOakid
string
Unique identifier of the product.
paperStyle
enum
Paper style of the product. This should be
null for products without prints.Possible enum values
FineArtPhotoPostercatalogProductId
enum
Artelo product type identifier.
Possible enum values
IndividualArtPrintSetOf2ArtPrintsSetOf3ArtPrintsSetOf4ArtPrintsSetOf5ArtPrintsSetOf6ArtPrintsSetOf8ArtPrintsShow more values
frameColor
nullable enum
Frame color of the product. This is only relevant for framed products.
Possible enum values
NaturalOakBlackOakWhiteOakWalnutOakWhiteMetalBlackMetalSilverMetalShow more values
includeFramingService
boolean
Whether or not to include framing a print-in-frame service for the product. This is only relevant for unframed products or frames without prints.
includeHangingPins
boolean
Whether or not to include hanging pins for the product. This is only relevant for unframed products.
includeMats
boolean
Whether or not to include hanging mats for the product.
orientation
nullable enum
Orientation of the product. This is not relevant for gallery products.
Possible enum values
VerticalHorizontalpaperType
nullable enum
Paper type of the product. This should be
null for products without prints.Possible enum values
SemiGlossPosterMattePosterSemiMatteLinenPosterGlossyPosterRagSatinPhotoGlossyPhotoLusterPhotoShow more values
size
enum
Size of the product.
Possible enum values
x4x4x5x5x6x6x8x8x10x10x12x12x14x14Show more values
unitCost
number
Unit cost of the product.
updatedAt
date
Timestamp when the product set was last updated.
Product set Object
{
"createdAt": "2024-10-11T12:38:48.465Z",
"name": "product name",
"products": [
{
"designs": [
{
"height": 400,
"id": "the-design-id",
"image": {
"previews": {
"lg": "https://example.com/img.lg.png",
"sm": "https://example.com/img.sm.png",
"xs": "https://example.com/img.xs.png"
},
"url": "https://example.com/x.png"
},
"order": 0,
"rotation": 30,
"width": 400,
"x": 0,
"y": 0
}
],
"frameStyle": "Metal",
"id": "sample-id",
"paperStyle": "FineArt",
"catalogProductId": "IndividualArtPrint",
"frameColor": "BlackMetal",
"includeFramingService": false,
"includeHangingPins": false,
"includeMats": false,
"orientation": "Horizontal",
"paperType": "ArchivalMatteFineArt",
"size": "x10x10",
"unitCost": 19.99
}
],
"updatedAt": "2024-12-11T12:38:48.465Z"
}