Fetch the print file of an order
const url = 'https://api.pixonaut.app/v1/orders/example/job/file?part=combined&file=process';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.pixonaut.app/v1/orders/example/job/file?part=combined&file=process' \ --header 'Authorization: Bearer <token>'Operation ID: orders.job.files.get
A file the printshop prints the order from, of one of its prints (printId, required for an order of several): by default its machine profile’s default part of the file it was sent, as its delivery links hand it out. machineProfile names another of its printshop’s profiles, or settings output settings for this one download (as the list of its files takes them); part another part (combined, print or cut), and file the process or separated file. The parts share the trim and bleed boxes, and the artwork is the same bytes in combined and print. With no machine, or one that names no cut name, the default part is print, the stored file; combined then carries a CutContour path, and a rectangular die is drawn as a cut path too. Not for a failed or cancelled order.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Which of the order’s prints, one of its printIds. Required when the order holds several; left out, the order’s only print.
Which of the order’s prints, one of its printIds. Required when the order holds several; left out, the order’s only print.
Responses
Section titled “Responses”The print file
Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: unauthorized
object
Examples
unauthorized
{ "error": "unauthorized"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: origin_forbidden, forbidden, feature_disabled, workspace_suspended
object
The feature the tenant does not have. Always sent with feature_disabled.
Examples
feature_disabled
{ "error": "feature_disabled", "feature": "api"}forbidden
{ "error": "forbidden"}origin_forbidden
{ "error": "origin_forbidden"}workspace_suspended
{ "error": "workspace_suspended"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: order_not_found, print_not_found, machine_profile_not_found, part_not_offered, separation_not_found, file_not_found, not_found
object
Examples
file_not_found
{ "error": "file_not_found"}machine_profile_not_found
{ "error": "machine_profile_not_found"}not_found
{ "error": "not_found"}order_not_found
{ "error": "order_not_found"}part_not_offered
{ "error": "part_not_offered"}print_not_found
{ "error": "print_not_found"}separation_not_found
{ "error": "separation_not_found"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: spot_plate_required, ink_mask_missing, print_profile_unavailable, print_raster_too_large, print_id_required, invalid_query
object
Always sent with spot_plate_required.
Always sent with print_id_required.
Always sent with print_raster_too_large.
Always sent with spot_plate_required.
Examples
ink_mask_missing
{ "error": "ink_mask_missing"}invalid_query
{ "error": "invalid_query"}print_id_required
{ "error": "print_id_required", "printIds": [ "string" ]}print_profile_unavailable
{ "error": "print_profile_unavailable"}print_raster_too_large
{ "error": "print_raster_too_large", "reason": "string"}spot_plate_required
{ "cause": "printshop_takes_no_plates", "error": "spot_plate_required", "references": [ "string" ]}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: rate_limited
object
Examples
rate_limited
{ "error": "rate_limited"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: db_error. A request that failed unexpectedly answers as text instead.
object
Examples
db_error
{ "error": "db_error"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Questions? Write to [email protected].