Logo
Logo
⌘K

The Branding Object

Attributes

PackageInsert

array of objects

Branding items with info regarding the package inserts.
Show child attributes

back

Design

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

front

Design

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

id

string

Unique identifier of the branding item.

isDefault

boolean

Whether the branding item is the default selection when placing orders.

orientation

enum

Orientation of the branding item.
Possible enum values
Vertical
Horizontal

placement

enum

How the branding item should be placed on the order.
Possible enum values
PerOrder
The branding item is used once per order. This is typically used for orders going to a single customer.
PerUnit
The branding item is placed once per unit. This is typically used for products that are sold individually.

type

enum

Branding item type.
Possible enum values
PackageInsert
Package insert to place in the product packaging.
PackageSticker
Package sticker to place on the product packaging.

createdAt

string

Timestamp when the branding item was created.

updatedAt

string

Timestamp when the branding item was last updated.

PackageSticker

array of objects

Branding items with info regarding the package stickers.
Show child attributes

back

Design

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

front

Design

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

id

string

Unique identifier of the branding item.

isDefault

boolean

Whether the branding item is the default selection when placing orders.

orientation

enum

Orientation of the branding item.
Possible enum values
Vertical
Horizontal

placement

enum

How the branding item should be placed on the order.
Possible enum values
PerOrder
The branding item is used once per order. This is typically used for orders going to a single customer.
PerUnit
The branding item is placed once per unit. This is typically used for products that are sold individually.

type

enum

Branding item type.
Possible enum values
PackageInsert
Package insert to place in the product packaging.
PackageSticker
Package sticker to place on the product packaging.

createdAt

string

Timestamp when the branding item was created.

updatedAt

string

Timestamp when the branding item was last updated.
Branding Object
{
  "PackageInsert": [
    {
      "back": {
        "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
      },
      "front": {
        "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
      },
      "id": "7ea374c6-de44-4771-9a18-9ce1930d8fb3",
      "isDefault": true,
      "orientation": "Horizontal",
      "placement": "PerOrder",
      "type": "PackageInsert",
      "createdAt": "2023-04-11T00:00:00.000Z",
      "updatedAt": "2023-04-11T00:00:00.000Z"
    }
  ],
  "PackageSticker": [
    {
      "back": {
        "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
      },
      "front": {
        "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
      },
      "id": "7ea374c6-de44-4771-9a18-9ce1930d8fb3",
      "isDefault": true,
      "orientation": "Horizontal",
      "placement": "PerOrder",
      "type": "PackageInsert",
      "createdAt": "2023-04-11T00:00:00.000Z",
      "updatedAt": "2023-04-11T00:00:00.000Z"
    }
  ]
}