Logo
⌘K

Update Order Item Designs

Replace every design on an order item. Only allowed while the order is PendingFulfillmentAction.
Parameters

dangerouslySkipDPICheck

boolean

Skip the DPI check for the designs. If set to true, designs below the 150 DPI threshold are accepted, which may result in blurry or pixelated prints.

designs

array of Design Inputs

Required

Every design for the order item, in slot order. The number of designs must match the number of prints in the item's product (for example, 3 for SetOf3ArtPrints). They replace all of the item's current designs.
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.

orderId

string

Required

Unique id of the order.

orderItemId

string

Required

Unique id of the order item.
Returns

The order item's new designs and the updated Order. Read the order's productionStatus to see whether it still needs action; order items have no productionStatus until production starts.

POST

/orders/update-item-designs

curl -X POST 'https://www.artelo.com/api/open/orders/update-item-designs' \
  -H 'Authorization: Bearer your-token' \
  -d '{
    "designs": [
      {
        "fitOptions": {},
        "imageId": "image-id",
        "overrides": {
          "height": 400,
          "rotation": 30,
          "width": 400,
          "x": 0,
          "y": 0
        },
        "sourceImage": {
          "url": "https://sample.com/x.png"
        }
      }
    ],
    "orderId": "de14efbe-daec-4e2d-b967-80ca9a5f9c17",
    "orderItemId": "5f0c2d8e-7b1a-4c3e-9d2f-6a8b1e4c7d90"
  }'
Response
{
  "designs": [
    {
      "id": "0b6f3a52-91d4-4f0e-8c7a-2e5d9b1c4f68",
      "imageId": "c2a4e6f8-1b3d-4e5f-9a7c-8d6b4a2c0e1f",
      "order": 0
    }
  ],
  "order": {
    "createdAt": "2024-09-30T13:56:29.057Z",
    "channelName": null,
    "companyName": null,
    "customerAddress": {
      "company": "Acme Inc.",
      "city": "Miami",
      "countryCode": "US",
      "id": "address-id",
      "name": "John Doe",
      "phone": "+15551234567",
      "state": "Florida",
      "email": "john@doe.com",
      "street1": "No 1 rosbridge street",
      "street2": "#123",
      "tin": "",
      "zipcode": "900110"
    },
    "details": {
      "amountRefunded": 0,
      "arteloShipping": 10,
      "branding": 1,
      "giftMessage": 1,
      "wholesaleDiscount": 0,
      "gst": 1,
      "hst": 1,
      "packaging": 0,
      "productionCost": 5,
      "pst": 1,
      "usSalesTax": 0
    },
    "giftMessage": {
      "font": "Script",
      "message": "Congratulations on your first home! Wishing you many happy years there.\n- Sarah, Coastal Realty"
    },
    "id": "de14efbe-daec-4e2d-b967-80ca9a5f9c17",
    "insertPlacement": "PerOrder",
    "insertId": "b1e38b9-442c-41bc-a849-32929a879537",
    "instructions": "Handle it with care",
    "orderId": "this-is-the-order",
    "orderItems": [
      {
        "arteloProductId": "a63d3478-9401-4046-9057-40abdabdc8ef",
        "id": "5f0c2d8e-7b1a-4c3e-9d2f-6a8b1e4c7d90",
        "orderItemId": "item-001",
        "isPersonalizable": false,
        "productionStatus": null,
        "details": {
          "amountRefunded": 0,
          "arteloShipping": 10,
          "branding": 1,
          "giftMessage": 0,
          "wholesaleDiscount": 0,
          "gst": 1,
          "hst": 1,
          "packaging": 0,
          "productionCost": 5,
          "pst": 1,
          "usSalesTax": 0
        },
        "product": {
          "catalogProductId": "IndividualArtPrint",
          "frameColor": "BlackMetal",
          "frameStyle": "Metal",
          "includeFramingService": true,
          "includeHangingPins": true,
          "includeMats": true,
          "orientation": "Horizontal",
          "packagingType": "Standard",
          "paperStyle": "FineArt",
          "paperType": "ArchivalMatteFineArt",
          "size": "x10x10"
        },
        "quantity": 10
      }
    ],
    "productionStatus": "Pending Approval",
    "shipments": [],
    "shippingStatus": "Shipping Pending",
    "status": "PendingFulfillmentAction",
    "stickerPlacement": "PerUnit",
    "stickerId": "e7e38b9-442c-41bc-a849-32929a879537"
  }
}