Logo
Logo
⌘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.

isPersonalizable

boolean

Whether the product set is personalizable.

productOptions

array of objects

Required

Products contained in the product set.
Show child attributes

catalogProductId

enum

Required

Artelo product type identifier.
Possible enum values
IndividualArtPrint
SetOf2ArtPrints
SetOf3ArtPrints
SetOf4ArtPrints
SetOf5ArtPrints
SetOf6ArtPrints
SetOf8ArtPrints
Show more values

designs

array of Design Inputs

Required

Designs contained in the product. This should be an empty array for products without prints.
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
MatOpening
The canvas is the mat opening, plus bleed area. For products without mats, the Paper canvas is used as a fallback.
Paper
The 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
Inside
The entire image is visible within the canvas, with visible whitespace if the aspect ratios differ.
Outside
The canvas is fully filled by cropping the image's larger dimension to match the aspect ratio.

imageId

string

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.
Show child attributes

parentFolderId

nullable string

Unique identifier of the uploads 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
NaturalOak
BlackOak
WhiteOak
WalnutOak
WhiteMetal
BlackMetal
SilverMetal
Show 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
Vertical
Horizontal

paperType

nullable enum

Paper type of the product. This should be null for products without prints.
Possible enum values
SemiGlossPoster
MattePoster
SemiMatteLinenPoster
GlossyPoster
RagSatinPhoto
GlossyPhoto
LusterPhoto
Show more values

size

enum

Required

Size of the product.
Possible enum values
x4x4
x5x5
x6x6
x8x8
x10x10
x12x12
x14x14
Show more values
Returns
The newly created or updated ProductSet object.

POST

/product-sets/save

curl -X POST 'https://www.artelo.io/api/open/product-sets/save' \
  -H 'Authorization: Bearer your-token' \
  -d '{
    "name": "Vision",
    "isPersonalizable": false,
    "productOptions": [
      {
        "catalogProductId": "IndividualArtPrint",
        "designs": [
          {
            "fitOptions": {},
            "imageId": "image-id",
            "overrides": {
              "height": 400,
              "rotation": 30,
              "width": 400,
              "x": 0,
              "y": 0
            },
            "sourceImage": {
              "url": "https://sample.com/x.png"
            }
          }
        ],
        "frameColor": "BlackMetal",
        "orientation": "Vertical",
        "paperType": "GlossyPoster",
        "size": "x10x10"
      }
    ]
  }'
Response
{
  "createdAt": "2024-10-11T12:38:48.465Z",
  "id": "456f9ad0-da58-4a2a-8240-0f6dda97ae9f",
  "name": "product name",
  "products": [
    {
      "catalogProductId": "IndividualArtPrint",
      "designs": [
        {
          "height": 400,
          "id": "906f9ad0-da58-dd90-0140-0f6dda97ae9f",
          "image": {
            "previews": {
              "lg": "https://url.com/lg-img.png",
              "sm": "https://url.com/sm-img.png",
              "xs": "https://url.com/xs-img.png"
            },
            "url": "https://example.com/x.png"
          },
          "order": 0,
          "rotation": 30,
          "width": 400,
          "x": 0,
          "y": 0
        }
      ],
      "frameColor": "BlackMetal",
      "frameStyle": "Metal",
      "id": "456f9ad0-da58-dd90-0140-0f6dda97ae9f",
      "includeFramingService": true,
      "includeHangingPins": true,
      "includeMats": true,
      "orientation": "Horizontal",
      "paperStyle": "FineArt",
      "paperType": "ArchivalMatteFineArt",
      "size": "x10x10",
      "unitCost": 10.99
    }
  ],
  "updatedAt": "2024-12-11T12:38:48.465Z"
}