Logo
Logo
⌘K

Save Branding

Create or update branding data.
Parameters

id

string

Unique identifier of the branding item to update. If not provided, a new branding item will be created.

back

Design Input

Back design of the insert. Only applicable to package inserts.
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.

front

Design Input

Required

Front design of the branding item.
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.

orientation

enum

Orientation of the branding design item.
Possible enum values
Vertical
Horizontal

placement

enum

Required

How branding item should be used in the order.
Possible enum values
PerOrder
PerUnit

type

enum

Required

What type of branding item is being saved.
Possible enum values
PackageInsert
PackageSticker
Returns
The newly created or updated Branding data.

POST

/branding/save

curl -X POST 'https://www.artelo.io/api/open/branding/save' \
  -H 'Authorization: Bearer your-token' \
  -d '{
    "id": "9d99eee2-d070-40ec-ac2e-f1e980a2e125",
    "back": {
      "fitOptions": {},
      "imageId": "image-id",
      "overrides": {
        "height": 400,
        "rotation": 30,
        "width": 400,
        "x": 0,
        "y": 0
      },
      "sourceImage": {
        "url": "https://sample.com/x.png"
      }
    },
    "front": {
      "fitOptions": {},
      "imageId": "image-id",
      "overrides": {
        "height": 400,
        "rotation": 30,
        "width": 400,
        "x": 0,
        "y": 0
      },
      "sourceImage": {
        "url": "https://sample.com/x.png"
      }
    },
    "orientation": "Vertical",
    "placement": "PerOrder",
    "type": "PackageInsert"
  }'
Response
{
  "PackageInsert": [
    {
      "createdAt": "2023-04-11T00:00:00.000Z",
      "isDefault": true,
      "back": {
        "height": 600,
        "id": "a21c48de-b303-42a8-956b-f3608d64e42b",
        "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": 0,
        "width": 600,
        "x": 0,
        "y": 0
      },
      "front": {
        "height": 600,
        "id": "ae057244-6635-4e6d-b179-dde12217b991",
        "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": 0,
        "width": 600,
        "x": 0,
        "y": 0
      },
      "id": "9d99eee2-d070-40ec-ac2e-f1e980a2e125",
      "orientation": "Vertical",
      "placement": "PerOrder",
      "type": "PackageInsert"
    }
  ],
  "PackageSticker": [
    {
      "createdAt": "2023-04-11T00:00:00.000Z",
      "isDefault": true,
      "back": null,
      "front": {
        "height": 600,
        "id": "e0eea4a4-7d0c-4c2f-965d-0be951142e4c",
        "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": 0,
        "width": 600,
        "x": 0,
        "y": 0
      },
      "id": "7f975a7e-2eca-43ff-8ef6-d7945fb38dd6",
      "orientation": "Vertical",
      "placement": "PerOrder",
      "type": "PackageSticker"
    }
  ]
}