Statuses and Error Codes
Status objects in PrintedDirect always have a canonical and a translation. An example payload:
{
"canonical": "job.status.production_dispatched",
"translation": {
"locale": "en",
"name": "Production Dispatched",
"summary": "The job has been dispatched"
}
}
Job statuses
Job statuses can be transitioned automatically by PrintedDirect, or by user action.
Name | Canonical | Summary |
---|---|---|
Pending | job.status.incomplete | The job is pending verification from the system |
Ready | job.status.ready | The job is ready and awaiting confirmation from the shop to progress to production |
Imposition Queued | job.status.imposition_queued | The job is awaiting imposition |
Imposition Manual | job.status.imposition_manual | The job requires manual imposition |
Production Queued | job.status.production_queued | The job is sitting in the production queue awaiting to be processed |
Production Started | job.status.production_started | The job has started the production process |
Production Finished | job.status.production_finished | The job has finished the production process |
Production Dispatched | job.status.production_dispatched | The job has been dispatched |
Cancelled | job.status.cancelled | The job has been cancelled |
Job Batch statuses
Job Batch statuses are transitioned automatically by PrintedDirect.
Name | Canonical | Summary |
---|---|---|
Incomplete | job_batch.status.incomplete | The job batch is incomplete and waiting on jobs to be ready or delivery information to be verified |
Ready | job_batch.status.ready | The job batch is verified and ready |
Dispatched | job_batch.status.dispatched | This job batch is dispatched |
Cancelled | job_batch.status.cancelled | This job batch is delivered |
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."
]
}
}
Table of Contents