⌘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
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
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 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.
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
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
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 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.
orientation
enum
Orientation of the branding design item.
Possible enum values
VerticalHorizontalplacement
enum
Required
How branding item should be used in the order.
Possible enum values
PerOrderPerUnittype
enum
Required
What type of branding item is being saved.
Possible enum values
PackageInsertPackageStickerReturns
The newly created or updated
Branding data.POST
/branding/save
cURL
Response