Statuses and Error Codes
Status objects in PrintedDirect always have a value and translations. For example:
Status Object
{
"value": "job.production.queued",
"translations": {
"label": "Production Queued",
"description": "The job is sitting in the production queue awaiting to be processed."
}
}
Job statuses
Job statuses can be transitioned automatically by PrintedDirect, or by user action.
| Name | Value | Description |
|---|---|---|
| New | job.new | The job is new and has not been processed yet, it may require more information to progress |
| Ready | job.ready | The job is ready to progress and needs confirmation to proceed |
| Preflight Queued | job.preflight.queued | The job is queued for preflighting |
| Preflight Manual | job.preflight.manual | The job requires manual preflighting |
| Production Queued | job.production.queued | The job is queued for production |
| Production Started | job.production.started | The job has started production |
| Production Finished | job.production.finished | The job has finished production |
| Dispatched | job.dispatched | The job has been dispatched |
| Cancelled | job.cancelled | The job has been cancelled |
Job Batch statuses
Job Batch statuses are transitioned automatically by PrintedDirect.
| Name | Value | Description |
|---|---|---|
| New | job_batch.new | The job batch is new and cannot progress yet, it may require more information to progress |
| Ready | job_batch.ready | The job batch is ready to progress and needs confirmation to proceed |
| Production Ready | job_batch.production.ready | The job batch and all its jobs are ready for production |
| Dispatched | job_batch.dispatched | The job batch has been dispatched |
| Delivered | job_batch.delivered | The job batch has been delivered |
| Cancelled | job_batch.cancelled | The job batch has been cancelled |
Artwork statuses
| Name | Value | Description |
|---|---|---|
| New | artwork.new | The artwork is new and pending system attention before becoming ready |
| Ready | artwork.ready | The artwork is ready for use |
| Failed | artwork.failed | The artwork has failed to download or be processed |
Artifact statuses
| Name | Value | Description |
|---|---|---|
| New | artifact.new | The artifact is new and pending system attention before becoming ready |
| Ready | artifact.ready | The artifact is ready for use |
| Failed | artifact.failed | The artifact has failed to download or be processed |
File statuses
| Name | Value | Description |
|---|---|---|
| New | file.new | The file is new and pending system attention before becoming ready |
| Ready | file.ready | The file has been downloaded and is ready for use |
| Failed | file.failed | The file has failed to download or be processed |
| Deleted | file.deleted | The file has been deleted and is no longer available |
Error codes
Error objects from our API will always be in the 4xx range, and contain a canonical and a message. Sometimes a Violations object is returned to indicate specific fields that failed validation.
Example without violations:
{
"error": {
"canonical": "api.wizard.error.conflict",
"message": "The job provided is not valid due to conflicts between the selected options. Most common conflicts are between materials and finishings where they disable each other. Potentially the size provided cannot be supported by the finishings/material either. These can be detected by making selections one-by-one against the wizard endpoint."
}
}
Example with violations:
{
"error": {
"message": "Your payload has violations that need to be looked at.",
"canonical": "api.request.error.payload"
},
"violations": {
"delivery_address.phone": [
"Please provide a valid phone number. The phone number must be valid for the provided country or country code."
]
}
}