Components
Components
Customer
| Parameter |
Type |
Description |
| id (required) |
string (UUID) |
Customer identifier. |
| name |
string |
Human-readable customer name. |
| email |
string |
Customer email address. |
| currency |
string |
Customer's preferred currency (ISO 4217), e.g. GBP, EUR. |
| accountIdentifier |
string |
Account identifier code. |
| customerReferenceId |
string |
Customer reference identifier. |
| defaultVatRate |
number |
Default VAT rate for the customer. |
| vatRegistrationNumber |
string |
VAT registration number. |
| companyRegistrationNumber |
string |
Company registration number. |
| contacts |
array[CustomerContact] |
Customer contact persons. |
| pointOfContacts |
array[PointOfContact] |
Points of contact assigned to the customer (e.g., sales, CSE, estimator). |
| Parameter |
Type |
Description |
| name |
string |
Contact person's name. |
| email |
string |
Contact person's email address. |
| phoneNumber |
string |
Contact person's phone number. |
| Parameter |
Type |
Description |
| id |
string (UUID) |
Point of contact identifier. |
| name |
string |
Point of contact's name. |
| type |
string |
Role type, e.g. sales, cse, estimator. |
| email |
string |
Point of contact's email address. |
| phoneNumber |
string |
Point of contact's phone number. |
UserInfo
Represents a user who performed an action (e.g., created or sent an estimate).
| Parameter |
Type |
Description |
| name |
string |
User's display name. |
| email |
string |
User's email address. |
EstimateItem
| Parameter |
Type |
Description |
| status (required) |
string |
Estimate status; e.g. won. |
| pricing (required) |
object Pricing |
Price breakdown for the item. |
| products (required) |
array[ProductItem] |
Product entries with attributes and production steps. |
| quantity (required) |
int |
Quantity of items in this estimate. |
| versions |
array[Version] |
Product versions with different covers/inners. |
| estimateId (required) |
string (UUID) |
Identifier for this estimate item. |
| priceModel |
string |
Pricing model used, e.g. va_per_press_hour. |
| delivery |
object Delivery |
Per-estimate delivery information. Present when top-level isConsolidatedDelivery is false. |
| ### Pricing |
|
|
| Parameter |
Type |
Description |
| price (required) |
number |
Unit price or primary price reference. |
| totalPrice |
number |
Total price including all costs. |
| rebates |
number |
Rebate percentage applied to the estimate. |
| rebateValue |
number |
Calculated rebate value amount. |
| taxPrice |
number |
Tax amount applied to the estimate. |
| manualAdjustment |
object [ManualAdjustment] |
Manual price adjustment applied to the estimate. |
| deliveryPrice |
number |
Delivery/shipping cost. |
| grossProfitPercentage |
number |
Gross profit percentage. |
| totalMargin |
number |
Total margin amount. |
| vaAmount |
number |
Value added amount. |
| vaPerPressHour |
number |
Value added per press hour. |
| vaPercent |
number |
Value added percentage. |
| subTotal |
number |
Subtotal before adjustments (legacy). |
| finalPrice |
number |
Final payable price for this item (legacy). |
ManualAdjustment
| Parameter |
Type |
Description |
| amount |
number |
Adjustment amount. |
| reason |
string |
Reason for the adjustment, e.g. Tax region surcharge. |
| type |
string |
Adjustment type: set, add, or reduce. |
ProductItem
| Parameter |
Type |
Description |
| productId (optional) |
string |
Stable, source-generated identifier for this product entry. Persists across re-exports of the same job and lets consumers reconcile updates. For top-level products it is the originating quote_product.uuid; for each part (e.g. inner, cover, end paper) it is the corresponding cfg_category_parts.uuid, so every part type carries its own distinct stable ID. |
| productSku (required) |
string |
SKU for this product entry (e.g., pur-softback-books, inner, cover). |
| attributes |
array[AttributeKV] |
Key/value attributes (e.g., pageCount, bindingType). |
| productionSteps |
array[ProductionStep] |
Steps applied to this product entry. |
| parts (optional) |
array[ProductItem] |
Nested product parts for multipart products. |
Common Product Attributes
The following attributes may appear in the attributes array of a ProductItem:
| Attribute Key |
Type |
Description |
| lineItemName |
string |
User-defined line item name for the product (multi-product orders). |
| productName |
string |
Human-readable product name. |
| finishedSize |
string |
Finished product size, e.g. 8.5x11, A4, A5. |
| finishedSizeOrientation |
string |
Orientation of the finished product, e.g. Portrait, Landscape. |
| finishedWidth |
number |
Finished product width in mm (metric) or inches (imperial). |
| finishedHeight |
number |
Finished product height in mm (metric) or inches (imperial). |
| bindingType |
string |
Binding method, e.g. Saddle Stitching, Perfect Binding. |
| pageCount |
string |
Number of pages in the product. |
| paperWeight |
string |
Paper weight in gsm (metric) or lb (imperial). |
| paperCoat |
string |
Paper coating type, e.g. Silk, Gloss, Matte. |
| totalWeight |
number |
Total finished weight of the product in grams (metric) or ounces (imperial). |
| spineWidth |
number |
Text-block spine measurement (inner part thickness × pages / 2) in mm (metric) or inches (imperial). Emitted at the product level for bound products. See also finishedSpineWidth on the cover part. |
| finishedSpineWidth |
number |
Binding-aware finished spine measurement in mm (metric) or inches (imperial). Emitted on the cover part only for case bound (text block + 2×greyboard + tolerance, rounded) and perfect binding (text block + cover wrap thickness). Not emitted for saddle stitching, wire-O, or other bindings. |
| color |
string |
Color specification, e.g. Full colour / both sides, 4/4. |
| lamination |
string |
Lamination type, e.g. Gloss, Matte, None. |
| laminationCoverage |
string |
Lamination coverage, e.g. Both Sides, Front Only, N/A. |
| spotFinish |
string |
Spot finish type, e.g. UV Spot, None. |
| bleed |
number |
Bleed size in inches (imperial) or mm (metric). |
| sheetCount |
number |
Number of sheets required for production. |
| machineName |
string |
Machine assigned for production. |
| substrateBrand |
string |
Brand of the substrate used, e.g. Magnum, Sappi. |
| fscClaim |
boolean |
Whether FSC certification is claimed. |
| model |
string |
Pricing model used, e.g. paper_calc. |
| tags |
array |
Array of tags describing the product, e.g. ["digital"]. |
| isDigital |
boolean |
Whether digital printing is used. |
| gutterGrindOff |
number |
Gutter grind off measurement for bound products. |
| extraGrip |
number |
Extra grip allowance. |
| turnover |
number |
Turnover measurement. |
| hingeGap |
number |
Hinge gap for case-bound products. |
| hangover |
number |
Hangover measurement for covers. |
| spineTolerance |
number |
Spine tolerance allowance. |
| greyBoardThickness |
number |
Grey board thickness for hardcover products. |
ProductionStep
| Parameter |
Type |
Description |
| machineName |
string |
Machine used for the step. |
| machineType |
string |
Machine type/category (see values below). |
| tags |
string[] |
Optional tags for the step, e.g. digital. |
| attributes |
array[AttributeKV] |
Step-specific parameters, e.g. substrateSKU, maxCuttingHeightMM. |
Common machineType values:
| machineType |
Description |
prepress |
Prepress/preparation step. |
substrate |
Substrate/material selection step. |
print |
Printing step. |
cut |
Cutting/guillotine step. |
bind |
Binding step (stitching, perfect binding, etc.). |
binding |
Alternative binding step identifier. |
digital |
Digital printing step. |
offset |
Offset printing step. |
packaging |
Packaging step. |
book_proof |
Book proofing step. |
digital_simple_perforation |
Perforation step. |
paper_band |
Paper banding step. |
rubber_band |
Rubber banding step. |
shrink_wrap |
Shrink wrapping step. |
Common Production Step Attributes
The following attributes may appear in the attributes array of a ProductionStep:
| Attribute Key |
Type |
Description |
| substrateSKU |
string |
SKU identifier for the substrate. |
| substrateCoat |
string |
Substrate coating type, e.g. Silk, Gloss, Matte. |
| substrateName |
string |
Substrate name/size, e.g. 11x17, SRA3. |
| substrateWidth |
number |
Substrate width in inches (imperial) or mm (metric). |
| substrateHeight |
number |
Substrate height in inches (imperial) or mm (metric). |
| substrateWeight |
number |
Substrate weight in gsm (metric) or lb (imperial). |
| substrateThickness |
number |
Substrate thickness in microns (metric) or mils (imperial). |
| substrateBrand |
string |
Brand of the substrate, e.g. Sappi, Antalis. |
| pressHours |
number |
Press hours for print steps. |
| runningHours |
number |
Running hours for print steps. |
| price |
number |
Cost for this production step. |
Delivery
Delivery information containing shipments with their associated products and parts. Delivery can appear in one of two locations depending on the isConsolidatedDelivery flag on the top-level response:
- Consolidated delivery (
isConsolidatedDelivery: true): A single delivery object appears at the top level of EstimateExportResponse, covering all estimates.
- Per-estimate delivery (
isConsolidatedDelivery: false): Each EstimateItem contains its own delivery object. The top-level delivery field will have an empty shipments array.
| Parameter |
Type |
Description |
| shipments (required) |
array[Shipment] |
Array of shipment entries. |
Shipment
| Parameter |
Type |
Description |
| destination (required) |
string |
Delivery destination, e.g. Continental US, UK mainland. |
| deliveryTime (required) |
string |
Delivery time option, e.g. Standard, Express. |
| deliveryMethod (required) |
string |
Delivery method, e.g. Next day working day, Standard Delivery. |
| products (required) |
array[ProductItem] |
Products included in this shipment (e.g., pallets, packages). Uses the same structure as ProductItem. |
Common Shipment Product Attributes
The following attributes may appear in shipment products (e.g., productSku: "shipment-packages"):
| Attribute Key |
Type |
Description |
| itemsPerPackage |
number |
Number of items per package. |
| delivery-quantity |
number |
Delivery quantity. |
| delivery-package |
string |
Package type/size, e.g. 12x9x6. |
| delivery-packageQuantity |
number |
Number of packages for delivery. |
| packagingType |
string |
Packaging type/size, e.g. 12x9x6. |
| price |
number |
Delivery/packaging price. |
| quantity |
string |
Quantity (for pallets, boxes, etc.). |
AttributeKV
| Parameter |
Type |
Description |
| key (required) |
string |
Attribute name, e.g. bleed, substrateSKU. |
| value (required) |
string or number |
Attribute value. |
Version
| Parameter |
Type |
Description |
| cover (required) |
string |
Cover identifier/name for this version. |
| inner (required) |
string |
Inner identifier/name for this version. |
| quantity (required) |
int |
Quantity for this version. |
| versionId (required) |
string |
Unique identifier for this version. |
Represents flexible key/value pairs associated with the payload. Uses the same structure as AttributeKV.
The metadata array includes both required system fields and optional user-defined fields:
Required system fields (always returned):
| Key |
Type |
Description |
currency |
string |
Currency used for pricing (ISO 4217), e.g. USD, EUR, GBP. |
printhouseUid |
string |
Identifier of the sending printhouse, e.g. US_DEMO, GB_ESP. |
unit |
string |
Measurement unit system: metric or imperial. |
Common user-defined fields:
| Key |
Type |
Description |
po-number |
string |
Purchase order number. |
order-reference |
string |
Order reference identifier. |
delivery-date |
string |
Requested delivery date (ISO 8601), e.g. 2026-02-03. |
internal-instructions |
string |
Internal production instructions. |
notes-for-customer |
string |
Notes to be shared with the customer. |
| Parameter |
Type |
Description |
| key (required) |
string |
Field identifier. |
| value (required) |
string or number |
Field value. |