Print order object

The Print Order APIs allow for the manipulation of print orders and job orders within Marq.

Print order object

The Document Folder APIs allow for the manipulation of folders and team folders within Marq.

Attribute
orderId ID
Unique ID of the project.
printJobs Array of Objects - see Job Order object below
See contactInfo details below.
rushOrder Boolean
Unique ID of the project.
reprint Boolean
Unique ID of the project.
contactInfo Object - see Contact Info object below
See contactInfo details below.
notes String
Special notes can be added by the end-user during the print order checkout flow.
shippingPrice Integer
The price of shipment which is calculated in USD. In special cases where users do not pay for the order through Marq, but are instead billed directly by the print vendor, the shipping price is included in the object.
totalPriceWithoutTax Integer
The total price of the order with the exclusion of taxes. In special cases where users do not pay for the order through Marq, but are instead billed directly by the print vendor, the shipping price is included in the object.
{
    "orderId": number,
    "jobs": array[PrintJob],
    "status": string,
    "created": dateTime,
    "lastModified": dateTime,
    "rushOrder": boolean,
    "reprint": boolean,
    "contactInfo": ContactInfo,
    "notes": string,
    "shippingPrice": integer,
    "totalPriceWithoutTax": integer
}

Contact info object

Attribute
name String
The name of the user that submitted the print order request
email String
The email of the user that submitted the print order request.
billingCodes String
The billing code(s) associated with the user that submitted the print order request. These are often added into Marq for each user as the printer's billing code.
{
    "name": string,
    "email": string,
    "billingCodes": string
}

Job order object

Attribute
jobId ID
Unique ID of the project.
printJobs Array of Objects - see Job Order object below
See contactInfo details below.
rushOrder Boolean
Unique ID of the project.
reprint Boolean
Unique ID of the project.
contactInfo Object - see Contact Info object below
See contactInfo details below.
notes String
Special notes can be added by the end-user during the print order checkout flow.
shippingPrice Integer
The price of shipment which is calculated in USD. In special cases where users do not pay for the order through Marq, but are instead billed directly by the print vendor, the shipping price is included in the object.
totalPriceWithoutTax Integer
The total price of the order with the exclusion of taxes. In special cases where users do not pay for the order through Marq, but are instead billed directly by the print vendor, the shipping price is included in the object.
{
    "jobId": string,
    "title": string,
    "projectURL": string,
    "csvURL": string (optional),
    "quantity": number,
    "shippingAddress": ShippingAddress,
    "shippingMethod": string,
    "jobOptions": JobOptions,
    "notes": string,
    "externalProductId": string
}

Shipping address object

Attribute
name String
Name of person for the shipping address.
address1 String
Street address for shipping.
address2 String
Unit number or additional attributes for shipping address.
city String
City of the shipping address.
state String
State of the shipping address.
country String
Country of the shipping address.
zipcode String
The postal code for the shipping address.
{ 
    "name": string,
    "address1": string,
    "address2": string (optional), 
    "city": string,
    "state": string,
    "country": string,
    "zipcode": string
}

Job options object

Attribute
width Integer
The unit number for the width of the PDF.
height Integer
The unit number for the width of the PDF.
units String
The measurement unit of the PDF (mm, inches, etc.)
description String
The title of the PDF or Marq Project
productType String
The product type selected from the print checkout.
duplex Boolean
Whether the product should be printed on both sides of the paper.
pageCount Integer
The number of pages for the PDF
coating String
The selected coating for the requested print job.
folds String
The selected folds for the requested print job
finish String
The selected finish for the requested print job
coverMedia String
The media to be used for covers for the requested print job.
upgrades Object
Additional upgrades requested based on the product selected in the print request.
{
    "width": number,
    "height": number,
    "units": string,
    "description": string,
    "productType": string,
    "media": string,
    "duplex": boolean (optional),
    "pageCount": number,
    "coating": string (optional),
    "folds": string (optional),
    "finish": string (optional),
    "coverMedia": string (optional),
    "upgrades": object
}

Example payload of print order

{
	"id": "00000000-0000-0000-0000-000000000000",
	"object": "printOrder",
	"jobs": [{
		"id": "00000000-0000-0000-0000-000000000000",
		"title": "Blank Print Document",
		"documentUrl": "<link to pdf>",
		"csvUrl": null,
		"quantity": 100,
		"shippingAddress": {
			"name": "Firstname Lastname",
			"address1": "Address line 1",
			"address2": "",
			"city": "City",
			"state": null,
			"country": "US",
			"zipcode": "11111",
			"phone": "1111111111"
		},
		"shippingMethod": "Misc",
		"options": {
			"width": 210,
			"height": 297,
			"units": "mm",
			"description": "A4 Flyer (Landscape)",
			"productType": "standard",
			"media": "Satin Matt Art (FSC Mix) 350GSM",
			"duplex": false,
			"pageCount": 1,
			"coating": null,
			"folds": null,
			"finish": null,
			"coverMedia": null,
			"upgrades": []
		},
		"notes": null,
		"externalProductId": "BFT001"
	}],
	"status": "Printing",
	"created": "2021-05-27T12:34:56Z",
	"lastModified": "2021-05-27T12:34:56Z",
	"rushOrder": false,
	"reprint": false,
	"contact": {
		"name": "First Last",
		"email": "[email protected]",
		"billingCodes": "N/A"
	},
	"shippingPrice": 0,
	"totalPriceWithoutTax": 55
}