⌘K
The Order Object
Attributes
createdAt
date
Timestamp when the order was created.
currency
string
Currency to use for the order.
customerAddress
Address
Address of the customer to ship the order to.
Show child attributes
city
string
City of the customer address.
countryCode
string
ISO 3166 country code of the customer address. Click here for full list of supported countries.
id
string
Unique identifier of the customer address.
name
string
Full name of the customer.
phone
string
Phone number of the customer.
state
string
State or region of the customer address.
street1
string
First line of the customer address.
street2
string
Second line of the customer address.
zipcode
string
Zipcode of the customer address.
customerEmail
string
Email address of the customer.
details
Order Details
Financial details of the order.
Show child attributes
amountRefunded
number
Refund amount applied in the order
currency.arteloShipping
number
Shipping charged by Artelo in the order
currency.branding
number
Branding cost charged by Artelo in the order
currency.discount
number
Discount applied in the order
currency.gst
number
GST (Goods and Services Tax) in the order
currency. This is only relevant for orders in Canada.hst
number
HST (Harmonized Sales Tax) in the order
currency. This is only relevant for orders in Canada.productionCost
number
Production cost charged by Artelo in the order
currency.pst
number
Combination of PST (Provincial Sales Tax) or QST (Quebec Sales Tax) in the order
currency. This is only relevant for orders in Canada.usSalesTax
number
Sales tax in the order
currency.id
string
Unique identifier of the order.
insertPlacement
enum
How package inserts should be used in the order.
Possible enum values
PerOrderPerUnitinstructions
string
Order instructions for the production facility.
orderId
string
Readable id used to identify the order. This is what you will see in the Artelo client.
orderItems
array of objects
Items included in the order.
Show child attributes
arteloProductId
nullable string
Unique identifier of the Artelo product associated with the order item.
isPersonalizable
boolean
Whether or not the order is personalizable.
product
Product
Artelo
Product connected to the order item.Show child attributes
designs
array of Designs
Designs contained in the product.
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.
frameStyle
enum
Frame style of the product. This is only relevant for framed products.
Possible enum values
PremiumMetalPremiumOakUnframedMetalOakid
string
Unique identifier of the product.
paperStyle
enum
Paper style of the product. This is only relevant for products without prints.
Possible enum values
FineArtPhotoPostercatalogProductId
enum
Artelo product type identifier.
Possible enum values
IndividualArtPrintSetOf2ArtPrintsSetOf3ArtPrintsSetOf4ArtPrintsSetOf5ArtPrintsSetOf6ArtPrintsSetOf8ArtPrintsShow more values
frameColor
nullable enum
Frame color of the product. This is only relevant for framed products.
Possible enum values
NaturalOakBlackOakWhiteOakWalnutOakWhiteMetalBlackMetalSilverMetalShow more values
includeFramingService
boolean
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
Whether or not to include hanging pins for the product. This is only relevant for unframed products.
includeMats
boolean
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 is only relevant for products without prints.
Possible enum values
SemiGlossPosterMattePosterSemiMatteLinenPosterGlossyPosterRagSatinPhotoGlossyPhotoLusterPhotoShow more values
size
enum
Size of the product.
Possible enum values
x6x6x8x8x10x10x12x12x16x16x18x18x20x20Show more values
unitCost
number
Unit cost of the product.
quantity
number
Quantity of order item units.
shipments
array of objects
Shipments associated with the order.
Show child attributes
shippingProvider
string
Shipstation code of the shipping provider.
trackingNumber
string
Tracking number of the shipment.
trackingUrl
nullable string
Tracking URL of the shipment.
status
enum
Status of the order.
Possible enum values
PendingFulfillmentActionThe order requires user action before it can be sent to production.
AwaitingPaymentThe order has been received by Artelo but is not yet paid for in the connected integration.
ReceivedThe order is received and is waiting to be sent to production. This period is to allow for cancellations to take place before production begins.
PaidThe order has been paid for but has not yet been sent to production.
WarehouseProcessingThe production facility is currently processing the order.
ShippedThe order has been shipped.
CanceledThe order was canceled.
Show more values
stickerPlacement
enum
How branding stickers should be placed on the order.
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.
Order Object