Skip to content

Example payload

Example payload - Imperial

{
  "metadata": [
    {
      "key": "currency",
      "value": "USD"
    },
    {
      "key": "printhouseUid",
      "value": "US_DEMO"
    },
    {
      "key": "unit",
      "value": "imperial"
    },
    {
      "key": "po-number",
      "value": "PO-12345"
    }
  ],
  "jobId": "2e7a4b1c-49a3-47e5-bd3a-5a6e4c2f1a9b",
  "attemptId": "2e7a4b1c-49a3-47e5-bd3a-5a6e4c2f1a9c",
  "created": "2025-03-14T09:15:27.123456+01:00",
  "quoteId": "6c5a77c0-1f3d-4c1e-9c39-2af0ab9f9d11",
  "jobName": "Q-2025-001234 Demo Stitched Book",
  "estimateNumber": 12345,
  "customer": {
    "id": "0c3b3f44-7f2a-4f78-8e16-2db7b7f2a9d9",
    "name": "Example Customer",
    "defaultVatRate": 20,
    "contacts": [
      {
        "name": "Alice Johnson",
        "email": "[email protected]",
        "phoneNumber": "+1-555-123-4567"
      }
    ],
    "pointOfContacts": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "Bob Williams",
        "type": "sales",
        "email": "[email protected]",
        "phoneNumber": "+1-555-987-6543"
      },
      {
        "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "name": "Carol Davis",
        "type": "estimator",
        "email": "[email protected]",
        "phoneNumber": "+1-555-456-7890"
      }
    ]
  },
  "sentBy": {
    "name": "John Smith",
    "email": "[email protected]"
  },
  "createdBy": {
    "name": "Jane Doe",
    "email": "[email protected]"
  },
  "estimate": [
    {
      "status": "won",
      "pricing": {
        "price": 799.99,
        "totalPrice": 7200.00,
        "deliveryPrice": 150.00,
        "rebates": 5,
        "rebateValue": 360.00,
        "taxPrice": 684.00,
        "manualAdjustment": {
          "amount": 100,
          "reason": "Rush order surcharge",
          "type": "add"
        }
      },
      "products": [
        {
          "parts": [
            {
              "attributes": [
                { "key": "paperCoat", "value": "Silk" },
                { "key": "paperWeight", "value": "100" },
                { "key": "color", "value": "4/4" },
                { "key": "pageCount", "value": "24" },
                { "key": "bleed", "value": 0.125 },
                { "key": "sheetCount", "value": 3030 },
                { "key": "machineName", "value": "Xerox iGen" },
                { "key": "substrateBrand", "value": "Mohawk" }
              ],
              "productId": "9ab07bfa-010c-4bdf-bd2f-f5f4e455e8c0",
              "productSku": "inner",
              "productionSteps": [
                {
                  "tags": ["digital"],
                  "attributes": [
                    { "key": "substrateSKU", "value": "Silk-100-11x17" },
                    { "key": "substrateCoat", "value": "Silk" },
                    { "key": "substrateName", "value": "11x17" },
                    { "key": "substrateWidth", "value": 11 },
                    { "key": "substrateHeight", "value": 17 },
                    { "key": "substrateThickness", "value": 4.5 },
                    { "key": "substrateBrand", "value": "Mohawk" }
                  ],
                  "machineName": "Xerox iGen",
                  "machineType": "digital"
                }
              ]
            },
            {
              "attributes": [
                { "key": "color", "value": "4/4" },
                { "key": "pageCount", "value": "4" },
                { "key": "paperCoat", "value": "Gloss" },
                { "key": "paperWeight", "value": "130" },
                { "key": "lamination", "value": "Gloss" },
                { "key": "laminationCoverage", "value": "Both Sides" },
                { "key": "spotFinish", "value": "None" },
                { "key": "bleed", "value": 0.125 },
                { "key": "sheetCount", "value": 505 },
                { "key": "machineName", "value": "Xerox iGen" },
                { "key": "substrateBrand", "value": "Sappi" }
              ],
              "productId": "50db5dc0-9c8a-4194-9a32-fe7bb19485b1",
              "productSku": "cover",
              "productionSteps": [
                {
                  "tags": ["digital"],
                  "attributes": [
                    { "key": "substrateSKU", "value": "Gloss-130-11x17" },
                    { "key": "substrateCoat", "value": "Gloss" },
                    { "key": "substrateName", "value": "11x17" },
                    { "key": "substrateWidth", "value": 11 },
                    { "key": "substrateHeight", "value": 17 },
                    { "key": "substrateThickness", "value": 5.5 },
                    { "key": "substrateBrand", "value": "Sappi" }
                  ],
                  "machineName": "Xerox iGen",
                  "machineType": "digital"
                }
              ]
            }
          ],
          "attributes": [
            { "key": "finishedSizeOrientation", "value": "Portrait" },
            { "key": "fscClaim", "value": false },
            { "key": "finishedSize", "value": "8.5x11" },
            { "key": "bindingType", "value": "Saddle Stitch" },
            { "key": "productName", "value": "Demo Stitched Book" },
            { "key": "totalWeight", "value": 2.8 },
            { "key": "spineWidth", "value": 0.125 }
          ],
          "productId": "8f3c4e2a-1111-4111-8111-111111111111",
          "productSku": "demo-stitched-book",
          "productionSteps": [
            {
              "machineName": "Stitcher",
              "machineType": "binding"
            },
            {
              "machineName": "packaging_station",
              "machineType": "packaging"
            }
          ]
        }
      ],
      "quantity": 5000,
      "versions": [
        {
          "cover": "Cover 1",
          "inner": "Inner 1",
          "quantity": 1000,
          "versionId": "Version 1"
        },
        {
          "cover": "Cover 2",
          "inner": "Inner 2",
          "quantity": 1000,
          "versionId": "Version 2"
        },
        {
          "cover": "Cover 3",
          "inner": "Inner 3",
          "quantity": 1000,
          "versionId": "Version 3"
        },
        {
          "cover": "Cover 4",
          "inner": "Inner 4",
          "quantity": 1000,
          "versionId": "Version 4"
        },
        {
          "cover": "Cover 5",
          "inner": "Inner 5",
          "quantity": 1000,
          "versionId": "Version 5"
        }
      ],
      "estimateId": "e2c4bd1a-7a1f-4f4a-8d7f-6a3e2c1b0d9e",
      "priceModel": "va_per_press_hour"
    }
  ],
  "delivery": {
    "shipments": [
      {
        "destination": "Continental US",
        "deliveryTime": "Standard",
        "deliveryMethod": "Next Day Delivery",
        "products": [
          {
            "productSku": "pallet_standard",
            "attributes": [
              { "key": "quantity", "value": "10" }
            ],
            "productionSteps": [],
            "parts": [
              {
                "productSku": "small_box",
                "attributes": [
                  { "key": "quantity", "value": "50" }
                ],
                "productionSteps": []
              },
              {
                "productSku": "medium_box",
                "attributes": [
                  { "key": "quantity", "value": "100" }
                ],
                "productionSteps": []
              }
            ]
          }
        ]
      }
    ]
  },
  "isConsolidatedDelivery": true,
  "schemaVersion": "v1"
}

Example payload - Metric

{
  "metadata": [
    {
      "key": "currency",
      "value": "EUR"
    },
    {
      "key": "printhouseUid",
      "value": "DE_DEMO"
    },
    {
      "key": "unit",
      "value": "metric"
    },
    {
      "key": "order-reference",
      "value": "ORD-EU-2025-001"
    }
  ],
  "jobId": "3f8b5c2d-5a4e-6b7f-9c1d-1e2f3a4b5c6d",
  "attemptId": "3f8b5c2d-5a4e-6b7f-9c1d-1e2f3a4b5c6e",
  "created": "2025-03-15T14:20:45.789012+01:00",
  "quoteId": "7d6e8f9a-1b2c-3d4e-5f6a-7b8c9d0e1f2a",
  "jobName": "Q-2025-EU-5678 Premium Hardcover Book",
  "estimateNumber": 67890,
  "customer": {
    "id": "1d2e3f4a-5b6c-7d8e-9f0a-1b2c3d4e5f6a",
    "name": "Example Customer",
    "defaultVatRate": 19,
    "contacts": [
      {
        "name": "Klaus Weber",
        "email": "[email protected]",
        "phoneNumber": "+49-30-1234567"
      }
    ],
    "pointOfContacts": [
      {
        "id": "c3d4e5f6-a7b8-9012-cdef-234567890123",
        "name": "Maria Fischer",
        "type": "sales",
        "email": "[email protected]",
        "phoneNumber": "+49-30-7654321"
      },
      {
        "id": "d4e5f6a7-b8c9-0123-defa-345678901234",
        "name": "Thomas Braun",
        "type": "cse",
        "email": "[email protected]",
        "phoneNumber": "+49-30-2468135"
      }
    ]
  },
  "sentBy": {
    "name": "Hans Mueller",
    "email": "[email protected]"
  },
  "createdBy": {
    "name": "Anna Schmidt",
    "email": "[email protected]"
  },
  "estimate": [
    {
      "status": "won",
      "pricing": {
        "price": 1250.50,
        "totalPrice": 3751.50,
        "deliveryPrice": 85.00,
        "rebates": 10,
        "rebateValue": 375.15,
        "taxPrice": 641.28,
        "grossProfitPercentage": 8.61,
        "totalMargin": 174.07,
        "vaAmount": 948.42,
        "vaPerPressHour": 677.06,
        "vaPercent": 46.91,
        "manualAdjustment": {
          "amount": 50,
          "reason": "Premium packaging upgrade",
          "type": "add"
        }
      },
      "products": [
        {
          "parts": [
            {
              "attributes": [
                { "key": "paperCoat", "value": "Matte" },
                { "key": "paperWeight", "value": "170" },
                { "key": "color", "value": "4/4" },
                { "key": "pageCount", "value": "32" },
                { "key": "bleed", "value": 3 },
                { "key": "sheetCount", "value": 2400 },
                { "key": "machineName", "value": "Heidelberg Speedmaster" },
                { "key": "substrateBrand", "value": "Fedrigoni" }
              ],
              "productSku": "inner",
              "productionSteps": [
                {
                  "tags": ["offset"],
                  "attributes": [
                    { "key": "substrateSKU", "value": "Matte-170-450x320" },
                    { "key": "substrateCoat", "value": "Matte" },
                    { "key": "substrateName", "value": "SRA3" },
                    { "key": "substrateWidth", "value": 450 },
                    { "key": "substrateHeight", "value": 320 },
                    { "key": "substrateThickness", "value": 180 },
                    { "key": "substrateBrand", "value": "Fedrigoni" },
                    { "key": "pressHours", "value": 1.3388 },
                    { "key": "runningHours", "value": 1.3388 }
                  ],
                  "machineName": "Heidelberg Speedmaster",
                  "machineType": "offset"
                }
              ]
            },
            {
              "attributes": [
                { "key": "color", "value": "4/4" },
                { "key": "pageCount", "value": "4" },
                { "key": "paperCoat", "value": "Gloss" },
                { "key": "paperWeight", "value": "300" },
                { "key": "lamination", "value": "Matte" },
                { "key": "laminationCoverage", "value": "Both Sides" },
                { "key": "spotFinish", "value": "None" },
                { "key": "bleed", "value": 3 },
                { "key": "sheetCount", "value": 300 },
                { "key": "machineName", "value": "Heidelberg Speedmaster" },
                { "key": "substrateBrand", "value": "Sappi" },
                { "key": "finishedSpineWidth", "value": 4.85 }
              ],
              "productSku": "cover",
              "productionSteps": [
                {
                  "tags": ["offset"],
                  "attributes": [
                    { "key": "substrateSKU", "value": "Gloss-300-450x320" },
                    { "key": "substrateCoat", "value": "Gloss" },
                    { "key": "substrateName", "value": "SRA3" },
                    { "key": "substrateWidth", "value": 450 },
                    { "key": "substrateHeight", "value": 320 },
                    { "key": "substrateThickness", "value": 350 },
                    { "key": "substrateBrand", "value": "Sappi" },
                    { "key": "pressHours", "value": 0.062 },
                    { "key": "runningHours", "value": 0.062 }
                  ],
                  "machineName": "Heidelberg Speedmaster",
                  "machineType": "offset"
                }
              ]
            }
          ],
          "attributes": [
            { "key": "finishedSizeOrientation", "value": "Portrait" },
            { "key": "fscClaim", "value": true },
            { "key": "finishedSize", "value": "A4" },
            { "key": "bindingType", "value": "Perfect Binding" },
            { "key": "productName", "value": "Premium Hardcover Book" },
            { "key": "totalWeight", "value": 125 },
            { "key": "spineWidth", "value": 4.5 }
          ],
          "productSku": "premium-hardcover-book",
          "productionSteps": [
            {
              "machineName": "Perfect Binder",
              "machineType": "binding"
            },
            {
              "machineName": "packaging_station",
              "machineType": "packaging"
            }
          ]
        }
      ],
      "quantity": 3000,
      "versions": [
        {
          "cover": "Cover A",
          "inner": "Inner A",
          "quantity": 1500,
          "versionId": "Version A"
        },
        {
          "cover": "Cover B",
          "inner": "Inner B",
          "quantity": 1500,
          "versionId": "Version B"
        }
      ],
      "estimateId": "f3a4b5c6-7d8e-9f0a-1b2c-3d4e5f6a7b8c",
      "priceModel": "va_per_press_hour"
    }
  ],
  "delivery": {
    "shipments": [
      {
        "destination": "Germany",
        "deliveryTime": "Standard",
        "deliveryMethod": "Standard delivery",
        "products": [
          {
            "productSku": "pallet_euro",
            "attributes": [
              { "key": "quantity", "value": "1" }
            ],
            "productionSteps": [],
            "parts": [
              {
                "productSku": "package_30x20x15",
                "attributes": [
                  { "key": "quantity", "value": "45" }
                ],
                "productionSteps": []
              }
            ]
          }
        ]
      }
    ]
  },
  "isConsolidatedDelivery": true,
  "schemaVersion": "v1"
}

Example payload - Multi-Product, Non-Consolidated Delivery

This example shows two products — a Hardback Book and a Leaflet — each shipped independently to different destinations. When isConsolidatedDelivery is false, each estimate item carries its own delivery object and the top-level delivery has an empty shipments array.

{
  "metadata": [
    { "key": "currency", "value": "GBP" },
    { "key": "printhouseUid", "value": "GB_ESP" }
  ],
  "jobId": "d3f50f3b-7b97-4687-b024-6c82c805ed51",
  "attemptId": "b9568dc0-a378-4308-804c-8c1ee5b48f6a",
  "created": "2025-06-10T10:30:00.000000+01:00",
  "quoteId": "dbac84a1-3178-461d-a295-ee019cb8c7f9",
  "jobName": "Q-2025-003000 Multi-Product Order",
  "estimateNumber": 30000,
  "customer": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Example Customer UK",
    "defaultVatRate": 20,
    "contacts": [
      {
        "name": "Sam Taylor",
        "email": "[email protected]",
        "phoneNumber": "+44-20-7946-0958"
      }
    ],
    "pointOfContacts": []
  },
  "sentBy": {
    "name": "Emma Wilson",
    "email": "[email protected]"
  },
  "createdBy": {
    "name": "Emma Wilson",
    "email": "[email protected]"
  },
  "estimate": [
    {
      "status": "draft",
      "pricing": {
        "price": 690.07,
        "totalPrice": 698.57,
        "deliveryPrice": 8.5,
        "rebates": 0,
        "rebateValue": 0
      },
      "products": [
        {
          "productSku": "hardback-casebound-books",
          "attributes": [
            { "key": "lineItemName", "value": "Hardback Book" },
            { "key": "finishedSize", "value": "A4" },
            { "key": "bindingType", "value": "Case Binding (Hardcover)" },
            { "key": "spineWidth", "value": 3.42 }
          ],
          "productionSteps": [
            {
              "machineName": "PUR 2",
              "machineType": "bind",
              "attributes": [{ "key": "price", "value": 0 }]
            },
            {
              "machineName": "MOUNT 1",
              "machineType": "mount",
              "attributes": [{ "key": "price", "value": 27.30 }]
            }
          ],
          "parts": [
            {
              "productSku": "inner",
              "attributes": [
                { "key": "color", "value": "4/4" },
                { "key": "pageCount", "value": "90" }
              ],
              "productionSteps": []
            },
            {
              "productSku": "cover",
              "attributes": [
                { "key": "color", "value": "4/0" },
                { "key": "pageCount", "value": "2" },
                { "key": "finishedSpineWidth", "value": 8 }
              ],
              "productionSteps": []
            }
          ]
        }
      ],
      "quantity": 10,
      "estimateId": "a15d0f26-7796-4e4d-a8b2-6a305cd381c9",
      "priceModel": "va_per_press_hour",
      "delivery": {
        "shipments": [
          {
            "destination": "UK mainland",
            "deliveryTime": "Standard",
            "deliveryMethod": "Next day working day",
            "products": [
              {
                "productSku": "shipment-packages",
                "attributes": [
                  { "key": "packagingType", "value": "12x9x3" },
                  { "key": "delivery-package", "value": "12x9x3" },
                  { "key": "price", "value": 8.5 }
                ]
              }
            ]
          }
        ]
      }
    },
    {
      "status": "draft",
      "pricing": {
        "price": 112.50,
        "totalPrice": 118.00,
        "deliveryPrice": 5.5,
        "rebates": 0,
        "rebateValue": 0
      },
      "products": [
        {
          "productSku": "leaflets-flyers-unfolded",
          "attributes": [
            { "key": "lineItemName", "value": "Leaflet" },
            { "key": "finishedSize", "value": "A5" },
            { "key": "finishedSizeOrientation", "value": "Portrait" },
            { "key": "color", "value": "4/4" },
            { "key": "productName", "value": "Leaflets & Flyers (un-folded)" }
          ],
          "productionSteps": [
            {
              "machineName": "Ricoh C9500",
              "machineType": "print",
              "attributes": [{ "key": "price", "value": 95.0 }]
            },
            {
              "machineName": "Guillotine 2",
              "machineType": "cut",
              "attributes": [{ "key": "price", "value": 17.5 }]
            }
          ],
          "parts": []
        }
      ],
      "quantity": 5000,
      "estimateId": "f82a1c44-9910-4b2d-bc33-7d1e9fa02b77",
      "priceModel": "va_per_press_hour",
      "delivery": {
        "shipments": [
          {
            "destination": "Scotland",
            "deliveryTime": "Standard",
            "deliveryMethod": "2-3 working days",
            "products": [
              {
                "productSku": "shipment-packages",
                "attributes": [
                  { "key": "packagingType", "value": "10x7x3" },
                  { "key": "delivery-package", "value": "10x7x3" },
                  { "key": "price", "value": 5.5 }
                ]
              }
            ]
          }
        ]
      }
    }
  ],
  "delivery": {
    "shipments": []
  },
  "isConsolidatedDelivery": false,
  "isMultiProduct": true,
  "pricing": {
    "price": 802.57,
    "deliveryPrice": 14.0,
    "rebateValue": 0,
    "rebates": 0,
    "taxPrice": 0,
    "totalPrice": 816.57,
    "grossProfitPercentage": 0,
    "totalMargin": 0,
    "vaAmount": 73.37,
    "vaPerPressHour": 382.91,
    "vaPercent": 57.29
  },
  "schemaVersion": "v1"
}

Example payload - Multi-Product, Consolidated Delivery

This example shows the same two products — a Hardback Book and a Leaflet — but with delivery consolidated into a single shipment at the top level. When isConsolidatedDelivery is true, the top-level delivery is populated with the shared shipment and individual estimate items do not contain a delivery field.

{
  "metadata": [
    { "key": "currency", "value": "GBP" },
    { "key": "printhouseUid", "value": "GB_ESP" }
  ],
  "jobId": "e4a61c22-8813-4c3e-bd44-7e2f0ab913a8",
  "attemptId": "c1679ed1-b489-5419-905d-9d2f0bc024b9",
  "created": "2025-06-11T14:00:00.000000+01:00",
  "quoteId": "f5b92d33-9924-5d4f-ce55-8f3a1dc135c0",
  "jobName": "Q-2025-003001 Multi-Product Consolidated Order",
  "estimateNumber": 30001,
  "customer": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Example Customer UK",
    "defaultVatRate": 20,
    "contacts": [
      {
        "name": "Sam Taylor",
        "email": "[email protected]",
        "phoneNumber": "+44-20-7946-0958"
      }
    ],
    "pointOfContacts": []
  },
  "sentBy": {
    "name": "Emma Wilson",
    "email": "[email protected]"
  },
  "createdBy": {
    "name": "Emma Wilson",
    "email": "[email protected]"
  },
  "estimate": [
    {
      "status": "draft",
      "pricing": {
        "price": 690.07,
        "totalPrice": 694.07,
        "deliveryPrice": 0,
        "rebates": 0,
        "rebateValue": 0
      },
      "products": [
        {
          "productSku": "hardback-casebound-books",
          "attributes": [
            { "key": "lineItemName", "value": "Hardback Book" },
            { "key": "finishedSize", "value": "A4" },
            { "key": "bindingType", "value": "Case Binding (Hardcover)" }
          ],
          "productionSteps": [],
          "parts": [
            {
              "productSku": "inner",
              "attributes": [{ "key": "color", "value": "4/4" }],
              "productionSteps": []
            },
            {
              "productSku": "cover",
              "attributes": [{ "key": "color", "value": "4/0" }],
              "productionSteps": []
            }
          ]
        }
      ],
      "quantity": 10,
      "estimateId": "a15d0f26-7796-4e4d-a8b2-6a305cd381c9",
      "priceModel": "va_per_press_hour",
      "delivery": null
    },
    {
      "status": "draft",
      "pricing": {
        "price": 112.50,
        "totalPrice": 112.50,
        "deliveryPrice": 0,
        "rebates": 0,
        "rebateValue": 0
      },
      "products": [
        {
          "productSku": "leaflets-flyers-unfolded",
          "attributes": [
            { "key": "lineItemName", "value": "Leaflet" },
            { "key": "finishedSize", "value": "A5" },
            { "key": "color", "value": "4/4" }
          ],
          "productionSteps": [],
          "parts": []
        }
      ],
      "quantity": 5000,
      "estimateId": "f82a1c44-9910-4b2d-bc33-7d1e9fa02b77",
      "priceModel": "va_per_press_hour",
      "delivery": null
    }
  ],
  "delivery": {
    "shipments": [
      {
        "destination": "UK mainland",
        "deliveryTime": "Standard",
        "deliveryMethod": "Next day working day",
        "products": [
          {
            "productSku": "shipment-packages",
            "attributes": [
              { "key": "packagingType", "value": "16x12x8" },
              { "key": "delivery-package", "value": "16x12x8" },
              { "key": "price", "value": 14.0 }
            ]
          }
        ]
      }
    ]
  },
  "isConsolidatedDelivery": true,
  "isMultiProduct": true,
  "pricing": {
    "price": 802.57,
    "deliveryPrice": 14.0,
    "rebateValue": 0,
    "rebates": 0,
    "taxPrice": 0,
    "totalPrice": 820.57,
    "grossProfitPercentage": 0,
    "totalMargin": 0,
    "vaAmount": 73.37,
    "vaPerPressHour": 382.91,
    "vaPercent": 57.29
  },
  "schemaVersion": "v1"
}