Logo
Logo
⌘K

The Order Object

Attributes

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.

createdAt

date

Timestamp when the order was created.

customerAddress

Address

Address of the customer to ship the order to.
Show child attributes

city

string

City of the customer address.

company

string

Company name for 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.

email

string

Email address 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

Apartment, suite, etc. Optional second line of the customer address.

tin

string

Customer tax identification number. Required when country is MX.

zipcode

string

Zipcode of the customer address.

details

Order Details

Financial details of the order.
Show child attributes

amountRefunded

number

Refund amount applied in USD.

arteloShipping

number

Shipping charged by Artelo in USD.

branding

number

Branding cost charged by Artelo in USD.

wholesaleDiscount

number

Wholesale discount applied in USD.

gst

number

GST (Goods and Services Tax) in USD. This is only relevant for orders in Canada.

hst

number

HST (Harmonized Sales Tax) in USD. This is only relevant for orders in Canada.

productionCost

number

Production cost charged by Artelo in USD.

pst

number

Combination of PST (Provincial Sales Tax) or QST (Quebec Sales Tax) in USD. This is only relevant for orders in Canada.

usSalesTax

number

Sales tax in USD.

id

string

Unique identifier of the order.

insertPlacement

enum

How package inserts should be used in the order.
Possible enum values
PerOrder
PerUnit

instructions

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 app.

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.

orderItemId

string

Readable id used to identify 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
PremiumMetal
PremiumOak
Unframed
Metal
Oak

id

string

Unique identifier of the product.

paperStyle

enum

Paper style of the product. This should be null for products without prints.
Possible enum values
Canvas
FineArt
Photo
Poster

canvasDesignedFor

nullable enum

Designed-for target for canvas products.
Possible enum values
ExactCut
Stretch0dot75
Stretch1dot5

canvasBorderStyle

nullable enum

Border style for canvas products.
Possible enum values
None
Wrap
Mirror

catalogProductId

enum

Artelo product type identifier.
Possible enum values
IndividualArtPrint
SetOf2ArtPrints
SetOf3ArtPrints
SetOf4ArtPrints
SetOf5ArtPrints
SetOf6ArtPrints
SetOf8ArtPrints
Show more values

frameColor

nullable enum

Frame color of the product. This is only relevant for framed products.
Possible enum values
NaturalOak
BlackOak
WhiteOak
WalnutOak
WhiteMetal
BlackMetal
SilverMetal
Show 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.

orientation

nullable enum

Orientation of the product. This is not relevant for gallery products.
Possible enum values
Vertical
Horizontal

paperType

nullable enum

Paper type of the product. This should be null for products without prints.
Possible enum values
SatinCanvas
ArchivalSemiMatteCanvas
SemiGlossPoster
MattePoster
SemiMatteLinenPoster
GlossyPoster
RagSatinPhoto
Show more values

size

enum

Size of the product.
Possible enum values
x4x4
x5x5
x6x6
x8x8
x8dot5x8dot5
x10x10
x12x12
Show more values

unitCost

number

Unit cost of the product.

details

Order Details

Financial details of the order item.
Show child attributes

amountRefunded

number

Refund amount applied in USD.

arteloShipping

number

Shipping charged by Artelo in USD.

branding

number

Branding cost charged by Artelo in USD.

wholesaleDiscount

number

Wholesale discount applied in USD.

gst

number

GST (Goods and Services Tax) in USD. This is only relevant for orders in Canada.

hst

number

HST (Harmonized Sales Tax) in USD. This is only relevant for orders in Canada.

productionCost

number

Production cost charged by Artelo in USD.

pst

number

Combination of PST (Provincial Sales Tax) or QST (Quebec Sales Tax) in USD. This is only relevant for orders in Canada.

usSalesTax

number

Sales tax in USD.

quantity

number

Quantity of order item units.

productionStatus

nullable enum

Production status of the order item.
Possible enum values
Frame Production Delay
There is a delay in the frame production process.
QC Issue
The order has a quality control issue that needs to be resolved before it can resume production.
Processing
The order's design files are being processed for printing.
Queued to Print
The order is ready to be printed.
Printing
The order is being printed.
Cutting
The order is printed and currently being cut.
Sorting
The order is being sorted for the packaging process.
Show more values

shipments

array of objects

Shipments associated with the order.
Show child attributes

carrierCode

string

ShipStation code of the shipping carrier.

trackingNumber

string

Tracking number of the shipment.

trackingUrl

nullable string

Tracking URL of the shipment.

productionStatus

enum

Production status of the order.
Possible enum values
Canceled
The order was canceled.
Ignored
The order was ignored in Artelo and will not be processed.
Pending Swap Request
The order has a swap request awaiting approval.
Received
The order is received and is waiting to be sent to production, allowing for cancellations before production begins.
Customer Unpaid
The order has been received by Artelo but is not yet paid for in the connected integration.
Needs Address Review
The order's shipping address needs review before it can be sent to production.
Missing Designs
The order is waiting for designs to be added before it can be sent to production.
Show more values

shippingStatus

enum

Shipping status of the order.
Possible enum values
Canceled
The order was canceled.
Shipping Pending
The shipping label for the order hasn't been created yet.
Shipping Purchased
The shipping label for the order has been purchased but the order has not yet been shipped.
Shipped
The order has been shipped and is on its way to the customer.
In Transit
The carrier has the order and it is on its way to the customer.
Shipment Error
The carrier encountered an issue while shipping the order.
Delivery Issue
The carrier encountered an issue while delivering the order.
Show more values

status

enum

Status of the order.
Possible enum values
PendingFulfillmentAction
The order requires user action before it can be sent to production.
Received
The order is received and is waiting to be sent to production. This period is to allow for cancellations to take place before production begins.
InProduction
The production facility is currently processing the order.
Shipped
The order has been shipped.
Delivered
The order has been delivered.
Canceled
The order was canceled.
ImagesProcessing
The order's design images are still being processed.
Show more values

stickerPlacement

enum

How branding stickers 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.

stickerId

string

Unique identifier of the branding for the package sticker. Requires a value for stickerPlacement.

insertId

string

Unique identifier of the branding for the package insert. Requires a value for insertPlacement.
Order Object
{
  "channelName": "Walmart",
  "companyName": "Custom Company LLC",
  "createdAt": "2024-09-30T13:56:29.057Z",
  "customerAddress": {
    "city": "Miami",
    "company": "Acme Co.",
    "countryCode": "US",
    "id": "de14efbe-daec-4e2d-b967-80ca9a5f9c17",
    "name": "John Doe",
    "email": "johndoe@gmail.com",
    "phone": "+15551234567",
    "state": "Florida",
    "street1": "No 1 rosbridge street",
    "tin": "XAXX010101000",
    "zipcode": "90110"
  },
  "details": {
    "amountRefunded": 0,
    "arteloShipping": 7,
    "branding": 2,
    "wholesaleDiscount": 0,
    "gst": 1,
    "hst": 1,
    "productionCost": 0,
    "pst": 0,
    "usSalesTax": 0
  },
  "id": "9de08b35-0ed5-4046-8339-32f051037189",
  "insertPlacement": "PerOrder",
  "orderId": "1230945",
  "orderItems": [
    {
      "arteloProductId": "ee7e38b9-442c-41bc-a849-32929a879537",
      "orderItemId": "item-001",
      "isPersonalizable": false,
      "product": {
        "designs": [
          {
            "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
          }
        ],
        "frameStyle": "Metal",
        "id": "sample-id",
        "paperStyle": "FineArt",
        "canvasDesignedFor": "ExactCut",
        "canvasBorderStyle": "None",
        "catalogProductId": "IndividualArtPrint",
        "frameColor": "BlackMetal",
        "includeFramingService": false,
        "includeHangingPins": false,
        "includeMats": false,
        "orientation": "Horizontal",
        "paperType": "ArchivalMatteFineArt",
        "size": "x10x10",
        "unitCost": 19.99
      },
      "details": {
        "amountRefunded": 0,
        "arteloShipping": 7,
        "branding": 2,
        "wholesaleDiscount": 0,
        "gst": 1,
        "hst": 1,
        "productionCost": 0,
        "pst": 0,
        "usSalesTax": 0
      },
      "quantity": 2,
      "productionStatus": "Packaging"
    }
  ],
  "shipments": [
    {
      "carrierCode": "UPS",
      "trackingNumber": "1234567890",
      "trackingUrl": "http://wwwapps.ups.com/WebTracking/processRequest?HTMLVersion=5.0&Requester=NES&AgreeToTermsAndConditions=yes&loc=en_US&tracknum=1234567890"
    }
  ],
  "productionStatus": "Packaging",
  "shippingStatus": "Delivered",
  "status": "Shipped",
  "stickerPlacement": "PerOrder",
  "stickerId": "e7c7b7d7-d8d5-4f9a-a3a5-b8a8c3d3c2c1",
  "insertId": "e7c7b7d7-d8d5-4f9a-a3a5-b8a8c3d3c2c1"
}