Cloudprinter order API JSON

This documentation describes the Cloudprinter order API JSON v2.1

Table of content

Getting started


To get started with Cloudprinter please contact us at info@cloudprinter.com to get your account created. To each account is associated an API key, which is used as authentication in all API calls.

Basics


This API is Used for deliverying order from Cloudprinter to a production. JSON document posted to the productions API.

The order document in JSON format is posted at the productions order endpoint. The document consists of one order, one or more items and reference to the needed production files for the specific product.

Communication

The JSON document is delivered with a HTTP POST request to a API endpoint over HTTPS or HTTP. The HTTP response code 200 indicate success, all other response codes are treated as error.

Order JSON format


The order JSON document containes all needed information for printing and shipping the products. This example is a very basic order with one item.

Example order JSON

{
    "order": {
        "apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
        "id": "123456780000",
        "date": "2016-07-14 08:25:08",
        "priority": "2",
        "creator": {
            "id": 1,
            "name": "Cloudprinter.com",
            "version": "2.1",
            "date": "2016-07-14 08:25:08"
        },
        "client": {
            "id": "1",
            "name": "Cloudprinter.com",
            "date": "2016-01-20 08:25:08",
            "reference": "d15ddd390457e4f581e0835a979465df"
        },
        "addresses": [
            {
                "type": "delivery",
                "company": "Example company",
                "name": "Example name",
                "street1": "Example street 1234",
                "zip": "99999",
                "city": "Example city",
                "country": "US",
                "state": "NY",
                "email": "email@example.com"
            }
        ],
        "shipping": {
            "method": "fedex_national_2_day",
            "consignor": "The Book Company"
        },
        "items": [
            {
                "id": "123456780001",
                "count": "1",
                "title": "Building High-Availability RESTful Services",
                "product": "textbook_cw_a3_p_fc",
                "desc": "Textbook Casewrap (PUR, 3 mm board) A3 Portrait DIG FC 80OFF",
                "pages": "44",
                "files": [
                    {
                        "type": "cover",
                        "format": "pdf",
                        "url": "https://s3-eu-west-1.amazonaws.com/13b37bb1ed6d3403e158abe719b4f6d0.cloudprinter.com/29c1d90b21bd7c8d28ba1fd1ae7646eb_cover.pdf",
                        "md5sum": "4578c3ecf64e47581b175d542f8b0160",
                        "size": "20785",
                    },
                    {
                        "type": "book",
                        "format": "pdf",
                        "url": "https://s3-eu-west-1.amazonaws.com/13b37bb1ed6d3403e158abe719b4f6d0.cloudprinter.com/29c1d90b21bd7c8d28ba1fd1ae7646eb_book.pdf",
                        "md5sum": "1ef89e74e628e223ae94aa4586330833",
                        "size": "77459",
                    }
                ],
                "options": [
                    {
                        "option": "80off",
                        "desc": "80 gsm Offset",
                        "count": "44"
                    },
                    {
                        "option": "cover_gloss",
                        "desc": "Gloss finish on book cover",
                        "count": "1"
                    }
                ]
            }
        ]
    }
}

Parameters

Name Type Description Required
apikey string API key specific to the production required
id string Cloudprinters order id required
date string Order date required
priority string The number of days for production optional
Creator Type Description Required
creator object Information on the creator of the document required
creator : id string ID of the creator service required
creator : name string Name of the creator service required
creator : version string Version of the document creator required
creator : date string Date of document generation required
client object Information on the client business required
client : id string ID of the client business required
client : name string Name of the client business required
client : reference string The order reference of the client business required
client : date string Order date registered by the client business optional
Addresses Type Description Required
addresses array Array of delivery address objects required
addresses : type string Type of address - valid values are: "delivery" required
addresses : company string End customers company name optional
addresses : name string End customers name required
addresses : street1 string End customers street name required
addresses : street2 string End customers street name optional
addresses : zip string End customers zip/postal code required
addresses : city string End customers city name required
addresses : state string End customers state name - ANSI INCITS 38:2009 alpha-2 - required for US optional
addresses : country string End customers country - ISO 3166-1 alpha-2 required
addresses : email string End customers email address - used in case of problems during delivery optional
addresses : phone string End customers phone number - used in case of problems during delivery optional
shipping
shipping object Information on shipping required
shipping : method string The shipping carrier and service for the order required
shipping : consignor string The consignor name for the shipping label required
items
items array Array with one or more item objects required
items : id string Cloudprinters item id required
items : count string The number of copies to produce of this specific item required
items : title string The title of the item project optional
items : product string The name of the product required
items : desc string Short description text of the product optional
items : pages string The number of pages in the book block optional
items : files array Array with one or more file objects required
items : files : type string The type of file - valid values are: "product", "cover", "book" required
items : files : format string The format of file - valid values are: "pdf", "jpg" required
items : files : url string URL to the product file for the specific item required
items : files : md5sum string Md5 sum of the file - used for validation required
items : files : size string Size of the file in bytes - used for validation required
items : options array Array with zero or more option objects optional
items : options : option string Productions product id for the addon required
items : options : desc string The quantity of the addon required required
items : options : count string Short description of the addon required
files
files array Array with zero or more file objects optional
files : type string The type of file - valid values are: "delivery_note", "promotion", "reorder_doc" required
files : url string URL to the order file required
files : md5sum string Md5 sum of the file - used for validation required
files : size string Size of the file in bytes - used for validation required