⌘K
Price Check
Calculate the full cost breakout for a prospective order without creating it. Accepts the same input as
/orders/create and returns the same cost components Artelo computes when an order is placed.Parameters
orderId
string
Required
Readable id used to identify the order. This is what you will see in the Artelo application.
currency
enum
Required
Currency to use for the order.
Possible enum values
AEDAFNALLAMDANGAOAARSShow 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.
phone
string
Phone number of the customer. Required for international orders.
company
string
Company name for the customer address.
name
string
Required
Name of the customer.
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.
tin
string
Customer tax identification number. Required when country is MX.
zipcode
string
Required
Zipcode of the customer address.
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
canvasDesignedFor
nullable enum
Required
Designed-for target for canvas products.
Possible enum values
ExactCutStretch0dot75Stretch1dot5canvasBorderStyle
nullable enum
Required
Border style for canvas products.
Possible enum values
NoneWrapMirrorcatalogProductId
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.
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
SatinCanvasArchivalSemiMatteCanvasSemiGlossPosterMattePosterSemiMatteLinenPosterGlossyPosterRagSatinPhotoShow more values
size
enum
Required
Size of the product.
Possible enum values
x4x4x5x5x6x6x8x8x8dot5x8dot5x10x10x12x12Show more values
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 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.
quantity
number
Required
Quantity of order item units.
unitPrice
number
Required
Price of each unit in the order item.
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.
Returns
The cost breakout and total for the prospective order.
POST
/orders/price-check
cURL
curl -X POST 'https://www.artelo.com/api/open/orders/price-check' \
-H 'Authorization: Bearer your-token' \
-d '{
"orderId": "sample-id",
"currency": "USD",
"customerAddress": {
"city": "Miami",
"country": "US",
"email": "john@doe.com",
"phone": "+15551234567",
"company": "Acme Co.",
"name": "John Doe",
"state": "Florida",
"street1": "No 1 rosbridge street",
"tin": "XAXX010101000",
"zipcode": "90110"
},
"items": [
{
"arteloProductId": "9019ec20-a391-4ae9-aa86-1ac2a2edd076",
"orderItemId": "test-id",
"productInfo": {
"canvasDesignedFor": "ExactCut",
"canvasBorderStyle": "None",
"catalogProductId": "IndividualArtPrint",
"frameColor": "BlackMetal",
"includeFramingService": false,
"includeHangingPins": false,
"includeMats": false,
"orientation": "Horizontal",
"paperType": "ArchivalMatteFineArt",
"size": "x10x10",
"designs": [
{
"fitOptions": {},
"imageId": "image-id",
"overrides": {
"height": 400,
"rotation": 30,
"width": 400,
"x": 0,
"y": 0
},
"sourceImage": {
"url": "https://sample.com/x.png"
}
}
]
},
"quantity": 1,
"unitPrice": 10
}
],
"branding": {
"insertId": "e7c7b7d7-d8d5-4f9a-a3a5-b8a8c3d3c2c1",
"stickerId": "e7c7b7d7-d8d5-4f9a-a3a5-b8a8c3d3c2c1",
"insertPlacement": "PerOrder",
"stickerPlacement": "PerOrder"
}
}'Response
{
"orderCosts": {
"amountRefunded": 0,
"arteloShipping": 10,
"branding": 1,
"customPricingAdjustment": 0,
"gst": 0,
"holidayFees": 0,
"hst": 0,
"productionCost": 5,
"pst": 0,
"total": 16,
"usSalesTax": 0,
"wholesaleDiscount": 0
},
"orderItemCosts": [
{
"amountRefunded": 0,
"arteloShipping": 0,
"branding": 0,
"customPricingAdjustment": 0,
"gst": 0,
"holidayFees": 0,
"hst": 0,
"orderItemId": "test-id",
"productionCost": 5,
"pst": 0,
"total": 5,
"usSalesTax": 0,
"wholesaleDiscount": 0
}
]
}