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 |
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 |
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 |
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
}
Miscellaneous
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 |
Example:
{
"error": {
"canonical": "api.request.error.payload",
"message": "Your payload has violations that need to be looked at."
},
"violations": {
"delivery_address.phone": [
"Please provide a valid phone number. The phone number must be valid for the provided country or country code."
]
}
}