Submitting an order for a mounted poster
Submit Order contains all the information necessary for the Print partner to produce and dispatch the order for a mounted poster.
The request is sent by Gelato Connect API to a {apparelOrderSubmitUrl} that is obtained from the Subscribe request
POST /{orderSubmitUrl}
Request example
{
"version": "1.1",
"id": "1468187424",
"printHouseUid": "NO_TES",
"orderDate": "2022-09-19T15:42:52.000+00:00",
"dispatchDate": "2022-09-22T08:00:00.000+00:00",
"brandedPackaging": "",
"items": [
{
"type": "product_bundle",
"parts": [
{
"id": "2469452430",
"count": 1,
"type": "stock",
"unit_price": 43.666667,
"product": {
"modelUid": "frame_product",
"desc": "Frame product",
"attributes": [
{
"name": "GlassType",
"value": "plexiglass",
"properties": [
{
"name": "ThicknessMaxMm",
"value": "1.0"
},
{
"name": "ThicknessMinMm",
"value": "2.0"
},
{
"name": "Description",
"value": "Plexiglass"
}
]
},
{
"name": "FrameColor",
"value": "white",
"properties": [
{
"name": "ColorCMYK",
"value": "0.0.0.0"
},
{
"name": "Description",
"value": "White"
}
]
},
{
"name": "FrameMaterial",
"value": "wood",
"properties": [
{
"name": "SubstrateModuleRef",
"value": "wood"
},
{
"name": "Description",
"value": "Wood"
}
]
},
{
"name": "FrameProperties",
"value": "w12xt22-mm",
"properties": [
{
"name": "FrameThicknessDelta",
"value": "2.0"
},
{
"name": "Description",
"value": "Frame width 12mm - thickness 22mm"
},
{
"name": "FrameWidth",
"value": "12.00"
},
{
"name": "FrameWidthDelta",
"value": "2.0"
},
{
"name": "FrameThickness",
"value": "22.00"
}
]
},
{
"name": "FrameSize",
"value": "300x300-mm",
"properties": [
{
"name": "Description",
"value": "300x300mm"
},
{
"name": "Size2Mm",
"value": "300.00"
},
{
"name": "UnitSystem",
"value": "metric"
},
{
"name": "Size1Mm",
"value": "300.00"
}
]
}
]
},
"assets": null
},
{
"id": "2469453430",
"count": 1,
"type": "print",
"unit_price": 43.666667,
"product": {
"modelUid": "flat_product",
"desc": "Flat Print product",
"attributes": [
{
"name": "PaperType",
"value": "170-gsm-coated-silk",
"properties": [
{
"name": "WeightGsm",
"value": "170"
},
{
"name": "Coating",
"value": "coated-silk"
},
{
"name": "Color",
"value": "white"
},
{
"name": "UnitSystem",
"value": "metric"
},
{
"name": "Description",
"value": "170gsm coated silk"
},
{
"name": "ColorCMYK",
"value": "0,0,0,0"
},
{
"name": "IsPremium",
"value": "false"
},
{
"name": "IsRecycled",
"value": "false"
},
{
"name": "ThicknessMm",
"value": "0.155"
}
]
},
{
"name": "SpotFinishingType",
"value": "none",
"properties": [
{
"name": "Description",
"value": "None"
},
{
"name": "ProcessedSides",
"value": "0-0"
},
{
"name": "SpotThickness",
"value": "0"
},
{
"name": "ProcessType",
"value": "none"
}
]
},
{
"name": "ColorType",
"value": "4-0",
"properties": [
{
"name": "SidesNumber",
"value": "1"
},
{
"name": "Description",
"value": "cmyk-none colors"
}
]
},
{
"name": "ShapeEdgeType",
"value": "none",
"properties": [
{
"name": "Shape",
"value": "none"
},
{
"name": "Size",
"value": ""
},
{
"name": "Description",
"value": "None"
}
]
},
{
"name": "Variable",
"value": "no",
"properties": [
{
"name": "IsEnabled",
"value": "false"
},
{
"name": "Description",
"value": "Variable is disabled"
}
]
},
{
"name": "PaperFormat",
"value": "300x300-mm",
"properties": [
{
"name": "UnitSystem",
"value": "metric"
},
{
"name": "Description",
"value": "30 x 30 cm"
},
{
"name": "Size1Mm",
"value": "300.00"
},
{
"name": "Size2Mm",
"value": "300.00"
}
]
},
{
"name": "CoatingType",
"value": "none",
"properties": [
{
"name": "Description",
"value": "No coating"
}
]
},
{
"name": "ProtectionType",
"value": "none",
"properties": [
{
"name": "Description",
"value": "No protection"
}
]
},
{
"name": "Orientation",
"value": "ver",
"properties": [
{
"name": "Description",
"value": "Vertical (portrait) orientation"
}
]
}
]
},
"assets": [
{
"contentType": "application/pdf",
"format": "pdf",
"url": "https://s3.eu-west-1.amazonaws.com/printcloud.storage-staging/staging/print_plates/print_house_DE_ORW/2022-09-25/292222049/pj_2469453430.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJQJ66FZGVVRIBBUQ%2F20220925%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220925T163241Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Signature=bd3ec21aa1bf11170ab355de66644aa580d147eeef4e8a0f986e83c7578b6792",
"type": "text"
}
]
},
{
"count": 1,
"type": "print",
"unit_price": 43.666667,
"product": {
"modelUid": "fulfillment_service",
"desc": "Fulfillment Service",
"attributes": [
{
"name": "FulfillmentService",
"value": "poster-mounting",
"properties": [
{
"name": "Description",
"value": "Poster in frame mounting service"
}
]
},
{
"name": "FrameSize",
"value": "300x300-mm",
"properties": [
{
"name": "Description",
"value": "300x300mm"
},
{
"name": "Size2Mm",
"value": "300.00"
},
{
"name": "UnitSystem",
"value": "metric"
},
{
"name": "Size1Mm",
"value": "300.00"
}
]
}
]
}
}
]
}
],
"shipping": {
"shipmentMethodUid": "dhl_global_parcel",
"address": [
{
"type": "delivery",
"firstName": "Test",
"lastName": "Test",
"addressLine1": "00 Tournore Park",
"addressLine2": "Abbeyside",
"postalCode": "X35AV91",
"city": "Dungarvan , Waterford",
"countryCode": "IE",
"email": "[email protected]",
"phone": "+353000000000"
},
{
"type": "sender",
"firstName": "",
"lastName": "",
"companyName": "Optimalprint",
"addressLine1": "Krokamp",
"addressLine2": "128",
"postalCode": "24539",
"city": "Neumünster",
"countryCode": "DE",
"email": ""
}
],
"customs": {
"priceTotal": "131.00",
"tax": "30.13",
"currencyCode": "EUR"
}
}
}
Request
MountedPosterPrintOrder
| 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 ISO*8601. Sample: 2008-09-15T15:53:00. |
| dispatchDate (required) | string | Date the order is expected to be shipped out by the partner, in ISO*8601. Sample: 2008-09-15T15:53:00. |
| brandedPackaging (optional) | string | Specific packaging workflow, used for order packaging. Sample: custom-client-name. |
| items (required) | MountedPosterOrderItem[] | An array of mounted poster order items. |
| shipping (required) | Shipping | Shipping details. |
MountedPosterOrderItem
| Parameter | Type | Description |
|---|---|---|
| type (required) | string | Type of the item, either "print" or "stock" (for options). Sample: print. |
| parts (required) | OrderItem[] | An array of parts (order items) for the mounted poster order item. |
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, front*preview, back_preview, inlbl, inlbl_preview, bcklbl, bcklbl_preview, shsll, shsll_preview, shslr, shslr_preview. _Sample: cover. * |