List the files an order can be fetched as

GET

/v1/orders/{id}/job/files

const url = 'https://api.pixonaut.app/v1/orders/example/job/files';
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/files \
  --header 'Authorization: Bearer <token>'

Operation ID: orders.job.files.list

Every file one of the order’s prints can be handed out as (printId, required for an order of several), for the order’s machine profile, or machineProfile, another of its printshop’s, or settings, output settings asked for one download (a JSON object of a machine profile’s cut name, marks, crop marks, mark offset, mirror, bleed trim, white and varnish): each part of it (combined, the print with its cut path on a layer that never prints; print, the print alone; cut, the cut path alone, on a page of its own) of the process file and, where the print has one, the separated file. All three parts share the trim and bleed boxes. A machine that names no cut name is handed the print alone, and the other parts are drawn under CutContour. Each file says whether the printshop is handed it, which is the default, and the address it is fetched from; settings answers the settings the files are drawn with, null when none are drawn. A file the order’s file door would refuse with spot_plate_required is left out, and the list is refused so only when it would leave out every file. A failed or cancelled order lists none.

Authorizations

Parameters

Path Parameters

required

string

Query Parameters

machineProfile

string

settings

string

printId

Which of the order’s prints, one of its printIds. Required when the order holds several; left out, the order’s only print.

string

Which of the order’s prints, one of its printIds. Required when the order holds several; left out, the order’s only print.

Responses

200

The order’s files

application/json

object

machineProfileAskedId

required

string | null

machineProfileId

required

string | null

machineProfiles

required

Array<object>

object

required

string

name

required

string

separationMissing

required

boolean

settings

required

object

bleedTrimMm

required

The bleed the file is trimmed to, in mm, or null for the bleed it was rendered with.

number | null

<= 50

cropMarks

required

Whether crop marks are drawn for a rectangular cut.

boolean

cutName

required

The name the cut path is drawn under, or null for a machine that cuts nothing.

string | null

markOffsetMm

required

How much further out than by default the marks sit, in mm.

number

<= 50

mirror

required

Whether the print is mirrored.

boolean

registrationMarks

required

The marks the machine reads off the printed sheet.

string

underbase

required

A UV machine’s white laid under the colour, or null for none.

object

chokeMm

required

How far in from the inked edge the white stops, in mm; 0 leaves it to the RIP.

number

<= 5

coverage

required

Where the white lies.

string

spotName

required

The spot name the printshop’s RIP reads for this channel.

string

>= 1 characters <= 64 characters

varnish

required

A UV machine’s varnish laid over the colour, or null for none.

object

coverage

required

Where the varnish lies when the design marks no layer for spot varnish.

string

spotName

required

The spot name the printshop’s RIP reads for this channel.

string

>= 1 characters <= 64 characters

variants

required

Array<object>

object

file

required

string

handedOut

required

boolean

isDefault

required

boolean

part

required

string

url

required

string

Examples

example

Example

{
  "machineProfileAskedId": null,
  "machineProfileId": "5d6e7f80-9a1b-4c2d-8e3f-4a5b6c7d8e9f",
  "machineProfiles": [
    {
      "id": "5d6e7f80-9a1b-4c2d-8e3f-4a5b6c7d8e9f",
      "name": "Epson F2270 DTG"
    }
  ],
  "separationMissing": false,
  "settings": {
    "bleedTrimMm": null,
    "cropMarks": false,
    "cutName": null,
    "markOffsetMm": 0,
    "mirror": false,
    "registrationMarks": "none",
    "underbase": null,
    "varnish": null
  },
  "variants": [
    {
      "file": "process",
      "handedOut": true,
      "isDefault": true,
      "part": "print",
      "url": "/v1/orders/e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b/job/file?machineProfile=5d6e7f80-9a1b-4c2d-8e3f-4a5b6c7d8e9f&part=print&file=process"
    }
  ]
}

Headers

X-Request-Id

required

string

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.

401

Refused: unauthorized

application/json

object

error

required

string

Examples

unauthorized

{
  "error": "unauthorized"
}

Headers

X-Request-Id

required

string

403

Refused: origin_forbidden, forbidden, feature_disabled, workspace_suspended

application/json

object

error

required

string

feature

The feature the tenant does not have. Always sent with feature_disabled.

string

Examples

feature_disabled

{
  "error": "feature_disabled",
  "feature": "api"
}

forbidden

{
  "error": "forbidden"
}

origin_forbidden

{
  "error": "origin_forbidden"
}

workspace_suspended

{
  "error": "workspace_suspended"
}

Headers

X-Request-Id

required

string

404

Refused: order_not_found, print_not_found, machine_profile_not_found, not_found

application/json

object

error

required

string

Examples

machine_profile_not_found

{
  "error": "machine_profile_not_found"
}

not_found

{
  "error": "not_found"
}

order_not_found

{
  "error": "order_not_found"
}

print_not_found

{
  "error": "print_not_found"
}

Headers

X-Request-Id

required

string

422

Refused: spot_plate_required, print_id_required, invalid_query

application/json

object

cause

Always sent with spot_plate_required.

string

error

required

string

printIds

Always sent with print_id_required.

Array<string>

references

Always sent with spot_plate_required.

Array<string>

Examples

invalid_query

{
  "error": "invalid_query"
}

print_id_required

{
  "error": "print_id_required",
  "printIds": [
    "string"
  ]
}

spot_plate_required

{
  "cause": "printshop_takes_no_plates",
  "error": "spot_plate_required",
  "references": [
    "string"
  ]
}

Headers

X-Request-Id

required

string

429

Refused: rate_limited

application/json

object

error

required

string

Examples

rate_limited

{
  "error": "rate_limited"
}

Headers

X-Request-Id

required

string

500

Refused: db_error. A request that failed unexpectedly answers as text instead.

object

error

required

string

Examples

db_error

{
  "error": "db_error"
}

Headers

X-Request-Id

required

string

Questions? Write to [email protected].

Status · Terms of service · Privacy policy · Subprocessors