⌘K
Create Order
Create an order.
Parameters
channelName
nullable string
Name of the channel the order was created from.
companyName
nullable string
Company name override to use for shipping labels. If not provided, your API integration name will be used.
branding
object
Placement of branding items for the order. Branding data can be configured inside the Artelo application. Leave empty if no branding should be used.
Show child attributes
insertId
string
Unique identifier of the branding for the package insert. Requires a value for
insertPlacement.stickerId
string
Unique identifier of the branding for the package sticker. Requires a value for
stickerPlacement.insertPlacement
enum
How package inserts should be placed on the order. Leave empty if no package inserts should be used. If set without a value for
insertId, the default insert branding will be used.Possible enum values
PerOrderThe branding item is used once per order. This is typically used for orders going to a single customer.
PerUnitThe branding item is placed once per unit. This is typically used for products that are sold individually.
stickerPlacement
enum
How branding stickers should be placed on the order. Leave empty if no branding stickers should be used. If set without a value for
stickerId, the default sticker branding will be used.Possible enum values
PerOrderThe branding item is used once per order. This is typically used for orders going to a single customer.
PerUnitThe branding item is placed once per unit. This is typically used for products that are sold individually.
createdAt
date
Required
Timestamp when the order was created.
currency
enum
Required
Currency to use for the order.
Possible enum values
ARSAUDBRLCADEURGBPHKDShow more values
customerAddress
object
Required
Address of the customer to ship the order to.
Show child attributes
city
string
Required
City of the customer address.
country
enum
Required
ISO 3166 country code of the customer address. Click here for full list of supported countries.
Possible enum values
USADAEAFAGAIALShow more values
email
string
Email of the customer.
name
string
Required
Name or company of the customer address.
state
string
Required
State or region of the customer address.
street1
string
Required
First line of the customer address.
street2
string
Second line of the customer address.
zipcode
string
Required
Zipcode of the customer address.
dangerouslySkipDPICheck
boolean
Skip DPI check for all images in the order. If set to true, created orders will not throw an error if the DPI of one or more designs falls below the 150 threshold. This may result in blurry or pixelated prints.
arteloDiscount
number
Required
Deprecated
Wholesale discount applied in the order
currency. Use wholesaleDiscount instead.instructions
string
Order instructions for the production facility.
items
array of objects
Required
Items included in the order. At least one item is required.
Show child attributes
arteloProductId
string
id of the Artelo Product associated with the order item. If left empty, the Artelo product will be inferred from the productInfo field. If arteloProductId and productInfo are left empty, an error is thrown.orderItemId
string
Required
Readable id used to identify the order item.
productInfo
Product Input
Details of the product to be created. Use this when no existing Artelo product is created. If left empty, the Artelo product will be inferred from the
arteloProductId field. If arteloProductId and productInfo are left empty, an error is thrown.Show child attributes
catalogProductId
enum
Required
Artelo product type identifier.
Possible enum values
IndividualArtPrintSetOf2ArtPrintsSetOf3ArtPrintsSetOf4ArtPrintsSetOf5ArtPrintsSetOf6ArtPrintsSetOf8ArtPrintsShow more values
frameColor
nullable enum
Required
Frame color of the product. This is only relevant for framed products.
Possible enum values
NaturalOakBlackOakWhiteOakWalnutOakWhiteMetalBlackMetalSilverMetalShow more values
includeFramingService
boolean
Required
Whether or not to include framing a print-in-frame service for the product. This is only relevant for unframed products or frames without prints.
includeHangingPins
boolean
Required
Whether or not to include hanging pins for the product. This is only relevant for unframed products.
includeMats
boolean
Required
Whether or not to include hanging mats for the product. This is only relevant for unframed products or frames that do not support mats.
orientation
nullable enum
Orientation of the product. This is not relevant for gallery products.
Possible enum values
VerticalHorizontalpaperType
nullable enum
Paper type of the product. This should be
null for products without prints.Possible enum values
SemiGlossPosterMattePosterSemiMatteLinenPosterGlossyPosterRagSatinPhotoGlossyPhotoLusterPhotoShow more values
size
enum
Required
Size of the product.
Possible enum values
x6x6x8x8x10x10x12x12x14x14x16x16x18x18Show more values
unitCost
number
Required
Unit cost of the product.
designs
array of Design Inputs
Designs contained in the product.
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.
quantity
number
Required
Quantity of order item units.
unitPrice
number
Required
Price of each unit in the order item.
orderId
string
Required
Readable id used to identify the order. This is what you will see in the Artelo application.
shippingCost
number
Shipping cost charged to the customer in the order
currency.tax
number
Sales tax charged to the customer in the order
currency.total
number
Required
Total amount charged to the customer in the order
currency. This includes order items that are not associated with Artelo products.vat
number
VAT (Value Added Tax) charged to the customer in the order
currency.Returns
The newly created
Order object.POST
/orders/create
cURL
Response