⌘K
Save Product Set
Create or update a product set.
Parameters
id
nullable string
Unique identifier of the product set to update. Only include when updating a product set.
name
string
Required
Unique name of the product set.
productOptions
array of objects
Required
Products contained in the product set.
Show child attributes
catalogProductId
enum
Required
Artelo product type identifier.
Possible enum values
IndividualArtPrintSetOf2ArtPrintsSetOf3ArtPrintsSetOf4ArtPrintsSetOf5ArtPrintsSetOf6ArtPrintsSetOf8ArtPrintsShow more values
designs
array of Design Inputs
Required
Designs contained in the product. This should be an empty array for products without prints. Source URL is not supported for product design inputs.
Show child attributes
fitOptions
object
Options for how the image should be placed in the design.
Show child attributes
canvas
enum
Canvas where the image should be fit to.
Possible enum values
MatOpeningThe canvas is the mat opening, plus bleed area. For products without mats, the
Paper canvas is used as a fallback.PaperThe canvas is the full sheet of paper, plus bleed area.
style
enum
Style for how to fit the image to the design.
Possible enum values
InsideThe entire image is visible within the canvas, with visible whitespace if the aspect ratios differ.
OutsideThe canvas is fully filled by cropping the image's larger dimension to match the aspect ratio.
imageId
string
Required
Unique identifier for the uploaded image in Artelo. This is returned in the response when uploading images.
overrides
object
Overrides for the design positioning. If not provided, the image will automatically fit outside the design canvas.
Show child attributes
height
number
Required
Height of the design in pixels.
rotation
number
Required
Clockwise rotation of the design in degrees (0-360).
width
number
Required
Width of the design in pixels.
x
number
Required
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
Required
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.
sourceImage
object
Design image source data. This is currently only supported for design inputs when creating orders.
Show child attributes
parentFolderId
nullable string
Unique identifier of the upload folder to save the file into. If set to null, the file will be placed in your root folder on the uploads page. If left empty, the file will not be accessible on the uploads page.
url
string
Required
URL of the design image source.
frameColor
nullable enum
Required
Frame color of the product. This should be
null for unframed products.Possible enum values
NaturalOakBlackOakWhiteOakWalnutOakWhiteMetalBlackMetalSilverMetalShow more values
includeFramingService
boolean
Whether or not to include framing a print-in-frame service for the product. This should be
false for unframed products or frames without prints.includeHangingPins
boolean
Whether or not to include hanging pins for the product. This should be
false for unframed products.includeMats
boolean
Whether or not to include hanging mats for the product. This should be
false for unframed products or frames that do not support mats.orientation
nullable enum
Orientation of the product. This should be
null 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
Required
Size of the product.
Possible enum values
x6x6x8x8x10x10x12x12x16x16x18x18x20x20Show more values
Returns
The newly created or updated
ProductSet object.POST
/product-sets/save
cURL
Response