Submitting an order with paper products

Submit Order contains all the information necessary for the Print partner to produce and dispatch the order. The request is sent by Gelato Connect API to a {orderSubmitUrl} that is obtained from the Subscribe request

POST /{orderSubmitUrl}

Request example

{
  "version": "1.1",
  "id": "3777007",
  "orderDate": "2019-08-28T16:03:28Z",
  "dispatchDate": "2019-08-28T16:03:28Z",
  "brandedPackaging": "custom-client-name",
  "items": [
    {
      "id": "1136473013",
      "count": 1,
      "type": "print",
      "product": {
        "modelUid": "photobook_hard_cover_product",
        "desc": "Photobook Hard cover product",
        "attributes": [
          {
            "name": "PaperType",
            "value": "170-gsm-coated-silk",
            "properties": [
              {
                "name": "weightGsm",
                "value": "170"
              }
            ]
          },
          {
            "name": "PaperFormat",
            "value": "pb-large",
            "properties": [
              {
                "name": "Size1Mm",
                "value": "205.00"
              },
              {
                "name": "Size2Mm",
                "value": "279.00"
              }
            ]
          },
          {
            "name": "ColorType",
            "value": "4-4"
          },
          {
            "name": "BindingType",
            "value": "glued-left"
          },
          {
            "name": "CoverPaperType",
            "value": "130-gsm-coated-silk"
          },
          {
            "name": "CoverColorType",
            "value": "4-4"
          },
          {
            "name": "Orientation",
            "value": "hor"
          },
          {
            "name": "CoatingType",
            "value": "matt-lamination"
          },
          {
            "name": "ProtectionType",
            "value": "1-0"
          },
          {
            "name": "PagesCount",
            "value": "34"
          }
        ]
      },
      "assets": [
        {
          "format": "pdf",
          "type": "text""contentType": "application/pdf",
          "url": "https://s3-eu-west-1.amazonaws.com/printcloud.storage-staging/staging/print_jobs/2019-08-05/print_job_6T_PfkZfw9-1a1sTzwUXFg/print_job.pdf"
        }
      ]
    }
  ],
  "shipping": {
    "shipmentMethodUid": "dhl_express",
    "address": [
      {
        "type": "sender",
        "firstName": "John",
        "lastName": "Smith",
        "companyName": "Gelato As",
        "addressLine1": "Baker street",
        "addressLine2": "26-29",
        "addressLine3": "ex. 3",
        "postalCode": "123456",
        "city": "London",
        "stateCode": "AL",
        "countryCode": "GB",
        "email": "[email protected]",
        "phone": "+1 (123) 456 78 90"
      },
      {
        "type": "delivery",
        "firstName": "John",
        "lastName": "Smith",
        "addressLine1": "Baker street",
        "addressLine2": "26-29",
        "postalCode": "123456",
        "city": "London",
        "stateCode": "AL",
        "administrativeAreaLevel1": "AL",
        "countryCode": "GB",
        "email": "[email protected]",
        "phone": "+1 (123) 456 78 90"
      }
    ],
    "customs": {
      "priceTotal": 123456.78,
      "tax": 123.56,
      "currencyCode": "EUR"
    }
  }
}

Request

PrintOrder

Parameter	Type	Description
version (required)	string	Gelato Connect API version. Sample: 1.0
id (required)	string	Gelato internal ID for the submitted print order. Sample: d290f1ee
orderDate (required)	string	Date the order is submitted by Gelato via Gelato Connect API to the partner, in ISO8601. _Sample: 2008-09-15T15:53:00.
dispatchDate (required)	string	Date the order is expected to be shipped out by the partner, in ISO8601. _Sample: 2008-09-15T15:53:00.
brandedPackaging (optional)	string	Specific packaging workflow, used for order packaging. Sample: custom-client-name
items (required)	OrderItem[]	An array of items included in the order.
shipping (required)	Shipping	Shipping details.

OrderItem

Parameter	Type	Description
id (required)	string	Gelato internal ID for the submitted item. Sample: d290f1ee
count (required)	number	Number of times the submitted items shall be produced. Sample: 45
type (required)	string	Type of the item, either "print" or "stock" (for options). Sample: print
product (required)	object	Details about the product.
modelUid (required)	string	Gelato unique ID for the requested product type. Example: hardcover_photobook; flat_format; folded_format.
desc (required)	string	Description of the product model. Sample: Hard Cover Photobook
attributes (required)	ProductAttribute[]	An array of attributes for the product.
assets (required)	Asset[]	An array of assets related to the item.

Shipping

Parameter	Type	Description
shipmentMethodUid (required)	string	Alias of the carrier and method to be used for dispatch. Sample: dhl_express
address (required)	Address[]	An array of addresses.
customs (required)	Customs	Customs information.

Address

Parameter	Type	Description
type (required)	string	Type of address: sender or delivery supported for now. Sample: delivery
firstName (required)	string	First name. Sample: John
lastName (required)	string	Last name. Sample: Doe
companyName (optional)	string	Company Name. Sample: Gelato
addressLine1 (required)	string	Address1 or Street 1. Sample: Baker street
addressLine2 (optional)	string	Address 2 or Street 2. Sample: 26-29
addressLine3 (optional)	string	Address 3 or Street 3. Sample: ex 3
postalCode (required)	string	ZIP code or Postal code. Sample: 123456
city (required)	string	City. Sample: London
stateCode (optional)	string	State or Province. Sample: AL
administrativeAreaLevel1	string	Indicates a first-order civil entity below the country level. Within the United States, these administrative levels are states. Sample: AL
countryCode (required)	string	Country as a 2 character code i.e. US, CA, etc. Sample: GB
email (required)	string	Email address. Sample: [email protected]
phone (optional)	string	Phone number. Sample: +1 (123) 456 78 90

Customs

Parameter	Type	Description
priceTotal (required)	number	Default 0.00. Sample: 123456.78
tax (required)	number	Tax value of the order. Default 0.00 if no custom info needed. Sample: 123.56
currencyCode (required)	string	Currency code. Sample: USD

ProductAttribute

Parameter	Type	Description
name (required)	string	The unique name for the product attribute. Each product is defined by a set of attributes and values and these need to be recognised by the receiving production system. Sample: PaperFormat
value (required)	string	The value of the product attribute. Each product is defined by a set of attributes and values and these need to be recognised by the receiving production system. Sample: A4
properties	Property[]	An array of properties.

Property

Parameter	Type	Description
name	string	The unique name for the product property. Sample: SizeMm1
value	string	The value of the product property. Sample: 205.00

Asset

Parameter	Type	Description
format (required)	string	The format of the submitted asset. Valid values: pdf, png, jpeg. Sample: pdf
contentType (required)	string	The content type of the submitted asset. Valid values: application/pdf, image/png, image/jpeg. Sample: application/pdf
url (required)	string	HTTPS link to the asset valid for x hours/days. Sample: https://s3-eu-west-1.amazonaws.com/printcloud.storage/print_jobs/2019-08-07/print_job_1235456/print_job.pdf
type (optional)	string	The type of the content in the asset. It will only be provided if the content of the item is split among multiple files. Valid values: text, cover, front, back, frontpreview, back_preview, inlbl, inlbl_preview, bcklbl, bcklbl_preview, shsll, shsll_preview, shslr, shslr_preview. _Sample: cover.