Objects

Job

An object that holds all information about a Job.

Field	Type	Description
`reference`	String	The reference for the Job
`product`	String	The unique identifier (UUID) of the selected print product
`quantity`	Number	The number of copies or units
`options`	JobOption[]	An array that can hold additional options or features related to the entire print job, such as binding for multipage products
`components`	JobComponent[]	An array representing the different components or parts of the print job
`meta`	JobMeta	An object of data for your convenience

JobComponent

An object that holds all information about a Job's component.

Field	Type	Description
`label`	String	One of `general\|cover\|pages` depending on single or multipage
`size`	String	The size of the Job
`material`	String	The stock to be used for the Job
`options`	JobComponentOption[]	An array of finishing items, such as lamination, perforation
`range_start`	Number	The page count for Job
`range_end`	Number	The page count for Job
`artwork`	Artwork	The artwork for the Job

JobOption

An object that contains a finishing item attached to the main Job.

Please note this is different to JobComponentOption.

Field	Type	Description
`finishing_item`	String	The finishing alias or UUID
`configuration`	Object (optional)	An optional configuration object specific to the finishing item

JobComponentOption

An object that contains a finishing item attached to a Job Component.

Please note this is different to JobOption.

Field	Type	Description
`finishing_item`	String	The finishing alias or UUID
`configuration`	Object (optional)	An optional configuration object specific to the finishing item

JobMeta

An object of data for your convenience.

Field	Type	Description
`data`	Object	An unstructured object of arbitrary data for your convenience

Job status

Field	Type	Description
`id`	String	The unique identifier of the job status
`canonical`	String	The canonical identifier for the job status
`value`	String	The value representing the job status
`reason`	String	The reason or description for the job status
`translation`	Translation	The translation object
`user`	User	The user object
`created_at`	DateTime	The DateTime object

Example:

{
  "id": "6e93674d-7384-4141-bacd-94358381e2fc",
  "canonical": "job.status.production_dispatched",
  "value": "production_dispatched",
  "reason": "Palm: fulfilment dispatched",
  "translation": Translation,
  "user": User,
  "created_at": DateTime
}

Artwork

An object that contains an array of files relating to a Job.

Field	Type	Description
`files`	ArtworkFile[]	An array of artwork files

ArtworkFile

An object that contains Artwork information that is bound to a finishing item.

Field	Type	Description
`label`	String	A label or identifier for the artwork component, usually "ink"
`finishing_item`	String	The finishing for which the artwork belongs
`file`	File	The remote file

File

An object that contains information on a remote file.

Field	Type	Description
`mime_type`	String	The mime type of the artwork
`source`	String	The remote URL where the file is accessible

Batch

Job Batch

An object that contains all information about one or more Jobs and its delivery information.

Field	Type	Description
`id`	String	The unique identifier of the Batch
`jobs`	Job[]	An optional configuration object specific to the finishing item
`delivery_option`	DeliveryOption	The DeliveryOption for the associated Jobs
`status`	Status	The status of the Batch

Queued Batch

An object that contains a Job and an associated DeliveryOption queued for Auto Batching.

Field	Type	Description
`id`	String	The unique identifier of the Queued Batch
`job`	Job	The Job to be queued
`delivery_option`	DeliveryOption	The DeliveryOption for the associated Job
`status`	Status	The status of the Queued Batch

Delivery

Delivery Option

Field	Type	Description
`id`	String	Unique identifier for the object.
`price`	Price	Pricing details of the item.
`created_at`	DateTime	Creation timestamp.
`turnaround`	Turnaround	Turnaround details.
`evaluation_date`	DateTime	Evaluation date timestamp.
`delivery_address`	Delivery Address	Delivery address details.
`delivery_service`	Delivery Service	Delivery service information.
`production_house`	Production House	Details of the production house.
`turnaround_price`	Price	Price details for the turnaround.
`production_strategy`	Turnaround	Production strategy details.
`delivery_date_latest`	DateTime	Latest delivery date.
`lifetime_finish_date`	DateTime	Lifetime finish date.
`jobs_production_house`	Production House	Jobs' production house details.
`turnaround_parameters`	Turnaround Parameters	Turnaround parameters.
`delivery_date_earliest`	DateTime	Earliest delivery date.
`delivery_service_group`	Delivery Service Group	Delivery service group information.
`delivery_service_price`	Price	Delivery service price details.
`end_of_production_date`	DateTime	End of production date.
`delivery_collection_date`	DateTime	Collection date of the delivery.
`primary_production_house`	Production House	Primary production house details.
`production_strategy_price`	Price	Production strategy price details.
`created_using_fast_routine`	Boolean	Whether it was created using fast routine.
`delivery_time_frame_latest`	String	Latest delivery time frame.
`delivery_time_frame_earliest`	String	Earliest delivery time frame.
`assumed_start_of_production_date	DateTime	Assumed start of production date.

Show example

{
  "id": "1d8618bf-b930-451b-808f-5af419fe0e95",
  "price": {
    "base": 719,
    "value": "7.19",
    "currency": "GBP",
    "formatted": "£7.19"
  },
  "created_at": {
    "iso": "2024-08-15T18:32:38+01:00"
  },
  "turnaround": {
    "id": "0883953c-513e-3922-93ba-7ae6278abc47",
    "name": "Standard",
    "alias": "standard"
  },
  "evaluation_date": {
    "iso": "2024-08-15T18:32:38+01:00"
  },
  "delivery_address": {
    "id": "0ba3ad8e-e104-42cb-b948-fdc3d30545b2",
    "city": "Cramlington",
    "name": "Mainland UK",
    "email": "customer@example.com",
    "phone": "+448008401430",
    "country": {
      "iso": "GB",
      "iso3": "GBR",
      "name": "United Kingdom"
    },
    "postcode": "NE231BB",
    "created_at": {
      "iso": "2024-08-15T18:32:37+01:00"
    },
    "updated_at": {
      "iso": "2024-08-15T18:32:38+01:00"
    },
    "address_type": "residential",
    "address_line1": "Unit 2",
    "address_line2": "Arcot Ct"
  },
  "delivery_service": {
    "id": "7488975a-9d34-4fc7-b88b-7acf75e4eb80",
    "is_tracked": true,
    "service_code": "ParcelDpdNextDay",
    "is_signed_for": true,
    "delivery_carrier": {
      "name": "DPD",
      "alias": "dpd",
      "provider_for_dispatch": "manual",
      "provider_for_availability_and_rates": "manual"
    },
    "delivery_finish_time_configurations": [
      {
        "delivery_time_frame_latest": "18:00",
        "delivery_time_frame_earliest": "07:00"
      }
    ]
  },
  "production_house": {
    "id": "43cfc3e4-e422-30be-99a7-7d8ccf4c386a",
    "name": "The Printed Group",
    "type": "production-house",
    "email": "simon.dunn@printed.com",
    "phone_number": "+1-793-392-7194"
  },
  "turnaround_price": {
    "base": 0,
    "value": "0.00",
    "currency": "GBP",
    "formatted": "£0.00"
  },
  "production_strategy": {
    "id": "0883953c-513e-3922-93ba-7ae6278abc47",
    "name": "Standard",
    "alias": "standard"
  },
  "delivery_date_latest": {
    "iso": "2024-08-20T22:00:59+01:00"
  },
  "lifetime_finish_date": {
    "iso": "2024-08-16T17:00:00+01:00"
  },
  "jobs_production_house": {
    "id": "43cfc3e4-e422-30be-99a7-7d8ccf4c386a",
    "name": "The Printed Group",
    "type": "production-house",
    "email": "simon.dunn@printed.com",
    "phone_number": "+1-793-392-7194"
  },
  "turnaround_parameters": {
    "productionTimeCase": "default"
  },
  "delivery_date_earliest": {
    "iso": "2024-08-20T08:00:00+01:00"
  },
  "delivery_service_group": {
    "id": "0ca014ec-3378-45cd-bba2-dcd66d5bea90",
    "name": "Next day"
  },
  "delivery_service_price": {
    "base": 719,
    "value": "7.19",
    "currency": "GBP",
    "formatted": "£7.19"
  },
  "end_of_production_date": {
    "iso": "2024-08-19T17:01:00+01:00"
  },
  "delivery_collection_date": {
    "iso": "2024-08-19T18:00:00+01:00"
  },
  "primary_production_house": {
    "id": "43cfc3e4-e422-30be-99a7-7d8ccf4c386a",
    "name": "The Printed Group",
    "type": "production-house",
    "email": "simon.dunn@printed.com",
    "phone_number": "+1-793-392-7194"
  },
  "production_strategy_price": {
    "base": 0,
    "value": "0.00",
    "currency": "GBP",
    "formatted": "£0.00"
  },
  "created_using_fast_routine": false,
  "delivery_time_frame_latest": "22:00",
  "delivery_time_frame_earliest": "08:00",
  "assumed_start_of_production_date": {
    "iso": "2024-08-16T17:00:00+01:00"
  }
}

Delivery Service

Field	Type	Description
`id`	String	Unique identifier for the delivery service.
`is_tracked`	Boolean	Indicates if the service is tracked.
`service_code`	String	Code for the delivery service.
`is_signed_for`	Boolean	Indicates if the service requires a signature.
`delivery_carrier`	Delivery Carrier	Details about the delivery carrier.
`delivery_finish_time_configurations`	Delivery Time Configurations	Time frame configurations for delivery.

Delivery Carrier

Field	Type	Description
`name`	String	Name of the carrier.
`alias`	String	Alias of the carrier.
`provider_for_dispatch`	String	Provider for dispatching.
`provider_for_availability_and_rates`	String	Provider for availability and rates.

Delivery Service Group

Field	Type	Description
`id`	String	Unique identifier for the delivery service group.
`name`	String	Name of the delivery service group.

Delivery Time Configurations

Field	Type	Description
`delivery_time_frame_earliest`	String	Earliest time frame for delivery (e.g., 07:00).
`delivery_time_frame_latest`	String	Latest time frame for delivery (e.g., 18:00).

Price

Field	Type	Description
`base`	Integer	Base price of the item.
`value`	String	Value of the item.
`currency`	String	Currency of the price.
`formatted`	String	Formatted String of the price.

Miscellaneous

Status

Field	Type	Description
`canonical`	String	The canonical of the status
`translation`	Translation	The translations for the status

Translation

Field	Type	Description
`locale`	String	The locale of the translation
`name`	String	The translated name of the object
`summary`	String	A summary or description of the object

Example:

{
  "locale": "en",
  "name": "Production Dispatched",
  "summary": "The job has been dispatched."
}

User

Field	Type	Description
`id`	String	The unique identifier of the user
`email`	String	The email address of the user
`name`	String	The name of the user
`job_title`	String	The job title of the user

Example:

{
  "id": "5933e6bb-9f93-36b9-a428-4b89010a2e82",
  "name": "System",
  "email": "system@printeddirect.com",
  "job_title": "Automated Workflow"
}

DateTime

Field	Type	Description
`iso`	String	The date and time in ISO 8601 format

Example:

{
  "iso": "2024-02-28T16:31:29+00:00"
}

Errors

Error

Field	Type	Description
`message`	String	A descriptive message explaining the error
`canonical`	String	A canonical error code for reference purposes

Violations

The violations object contains a list of fields that have errors and corresponding error messages.

Field name	Type	Description
`field_name`	String	The name of the field that has a validation violation
`string[]`	String	A descriptive message explaining the validation violation

Show example

Glossary

Developer Documentation

Developer Documentation

Objects

Job

Job

JobComponent

JobOption

JobComponentOption

JobMeta

Job status

Artwork

Artwork

ArtworkFile

File

Batch

Job Batch

Queued Batch

Delivery

Delivery Option

Delivery Service

Delivery Carrier

Delivery Service Group

Delivery Time Configurations

Price

Miscellaneous

Status

Translation

User

DateTime

Errors

Error

Violations