| destinationAddress |
"destinationAddress":{
"company":"Bob's Big Books",
"firstName":"Bob",
"lastName":"Loblaw",
"street1":"123 Bobberson Cres.",
"street2":"",
"city":"Bobville",
"stateOrProvince":"ON",
"postalCode":"A1A 1A1",
"country":"CA",
"phone":"555.555.5555",
"email":"bob@gmail.com"
}
Shipping address. It has the following properties:
- company: The company of the person associated with the shipping address.
- firstName: The first name of the person associated with the shipping
address.
- lastName: The last name of the person associated with the shipping
address.
- street1: The street address of the shipping address.
- street2: An optional additional field for the street address of the
shipping address.
- city: The city, town, or village of the shipping address.
- stateOrProvince: The two-letter abbreviation of the region of the
shipping address.
- postalCode: The postal code (zip, postcode, Eircode, …) of the shipping
address.
- country: The two-letter code (ISO
3166-1 format) for the country of the shipping address.
- phone: The phone number at the shipping address.
- email: Email address, for shipping notifications.
|
| items |
Print On Demand Products
"items":[
{
"orderItemID":"OR-1234-1",
"productType":"Brochure",
"printFileURL":"https://catsandbirds.ca/wp-content/uploads/sites/3/2017/09/31617-sv-cats-and-birds_19_4.pdf",
"productCode":"sku 721",
"quantity":4,
"productName":"Tri-fold Brochure",
"bindingLocation": "right",
"bindingType": "Saddle Stitch",
"foldType": "Bi-Fold",
"orientation": "Portrait",
"insideCoverColors": 4,
"outsideCoverColors": 4,
"substrateText": "120# Gloss Cover",
"textPageColors": 4,
"finishedWidth": 8.5,
"finishedHeight": 11,
"pageCount": 1,
"substrateCover": "140# Matte Cover",
"coating": "UV Front Only",
"spine_mm": 9,
"sku": "sku 721",
"type": "STOCK"
}
]
Warehouse Products
"items":[
{
"orderItemID":"OR-1234-1",
"productCode":"sku 721",
"quantity":4,
"sku": "sku 721",
"type": "STOCK"
}
]
A list of line item objects, each containing information about an item in
the order. Each object has the following properties:
- orderItemID: Required The way this item is identified in your
system.
- productType: Required Specify the type of product. Available
values: Brochure, Flyer, Business Cards, Postcards, Poster, Perfect Bind,
Hard Cover, Saddle Stitch, Twin Wire, Notepad
- printFileURL: Required URL for the PDF file that will be printed.
Please include any necessary tokens or keys.
- coverPrintFileURL: Optional URL for the PDF file that will be
printed for the cover. Please include any necessary tokens or keys.
- productCode: Optional Your identification for this type of
product, such as a SKU code.
- quantity: Required How many copies?
- productName: Optional A uesful name for the product. We will use
it on packing slips and invoices. If it is not provided, we will make a generic
name from the product type and size.
- bindingLocation: Optional Default is left. Only applicable for
books
- bindingType: Optional Only applicable for books, and can be
surmised from
the accepted ProductType values. Available values: Hard Cover, Padded in 50's at
top,
Perfect Bound, Postit notes, Saddle Stitch, Three Hole Punch, Wire Bound.
- foldType: Required for Brochures, optional for others. Available values:
Bi-Fold,
Letterfold, Scored, Scared, Tri-Fold, Z-Fold
- orientation Optional Portrait or Landscape.
- insideCoverColors: Optional Default is 4 colors (CMYK). Other
values are
0 (single sided), 1 (black and white)
- outsideCoverColors: Optional Default is 4 colors (CMYK).
- substrateText Required (type of paper) Choose from the
list of substrates we have, or talk to your rep about specific paper
- substrateCover: Required for books Value can be "Self Cover" or a
value
from the list of substrates
- textPageColors: Optional Default is 4 colors (CMYK). Other values
are 0
(not printed) and 1 (black and white)
- finishedWidth: Required In inches
- finishedHeight: Required In inches
- pageCount: Required for books Optional for non-books. Front and
back is two pages.
- coating: Optional Lamination added to the paper after printing.
Available
values: None, Lamination Gloss, Lamination Matte, Lamination Silk, Lamination
Soft Touch,
UV Gloss (Both Sides), UV Gloss (Front Side), UV Matte (Both Sides)
- spine_mm: Recommended for hard-cover books Width of spine in mm.
- sku: Your identification for this type of product, such as a SKU code. (Warehouse orders only)
- type: Indicate 'STOCK' for warehouse orders only
|