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.

NameValueDescription
Newjob.newThe job is new and has not been processed yet, it may require more information to progress
Readyjob.readyThe job is ready to progress and needs confirmation to proceed
Preflight Queuedjob.preflight.queuedThe job is queued for preflighting
Preflight Manualjob.preflight.manualThe job requires manual preflighting
Production Queuedjob.production.queuedThe job is queued for production
Production Startedjob.production.startedThe job has started production
Production Finishedjob.production.finishedThe job has finished production
Dispatchedjob.dispatchedThe job has been dispatched
Cancelledjob.cancelledThe job has been cancelled

Job Batch statuses

Job Batch statuses are transitioned automatically by PrintedDirect.

NameValueDescription
Newjob_batch.newThe job batch is new and cannot progress yet, it may require more information to progress
Readyjob_batch.readyThe job batch is ready to progress and needs confirmation to proceed
Production Readyjob_batch.production.readyThe job batch and all its jobs are ready for production
Dispatchedjob_batch.dispatchedThe job batch has been dispatched
Deliveredjob_batch.deliveredThe job batch has been delivered
Cancelledjob_batch.cancelledThe job batch has been cancelled

Artwork statuses

NameValueDescription
Newartwork.newThe artwork is new and pending system attention before becoming ready
Readyartwork.readyThe artwork is ready for use
Failedartwork.failedThe artwork has failed to download or be processed

Artifact statuses

NameValueDescription
Newartifact.newThe artifact is new and pending system attention before becoming ready
Readyartifact.readyThe artifact is ready for use
Failedartifact.failedThe artifact has failed to download or be processed

File statuses

NameValueDescription
Newfile.newThe file is new and pending system attention before becoming ready
Readyfile.readyThe file has been downloaded and is ready for use
Failedfile.failedThe file has failed to download or be processed
Deletedfile.deletedThe 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."
    ]
  }
}