Perform Job Track Checkin

Owned by Jonathan Pugsley
Last updated: Jan 12, 2024
4 min read

POST /api/v2/job_track/stations/{code}

This endpoint is used to create a job tracker record for a particular order at a particular station

image-20240112-152041.png

Accepts

  • A job tracker station code, which must be the unique identifying code for the station

    • image-20240112-150809.png

      This station can be retrieved using LP. Case matters (lpwill not retrieve a record).

  • An order identifier, which can be the order number, tray number, or purchase order number

    • This order can be retrieved using 72544, 337178, or Example

    • Tray numbers can only be used to look up active orders

    • If lookup is done by po number then you must be using unique values in this field

  • An operator identifier, which must be the unique identifying code for a job tracker station flagged as an operator. Whether this parameter is optional or required depends on the settings of the job tracker station being checked into.

Returns

Success

  • A JSON object representing the checkin event

Property

Description

orderNumber

string

The identifier for the order

trayNumber

string

The tray number the order is attached to

poNumber

string

Job reference (PO NUM field)

code

string

The code for the station

customerDesc

string

The customer description for the station

desc

string

The description for the station

statusDateTime

string

The date and time the status was applied to the order in format yyyy-mm-ddThh:mm:ss.fffZ (ISO 8601)

Error

  • If the code parameter does not match any station in the system an HTTP 400 code will be returned with the standard error body

    { "error": "Checkin not performed", "details": [ "Station not found" ] }

  • If the order identifier parameter does not match any order in the system an HTTP 400 code will be returned with an error

    { "error": "Checkin not performed", "details": [ "Order not found" ] }

  • If the operator parameter is provided and does not match any station in the system an HTTP 404 code will be returned with an error

    { "error": "Checkin not performed", "details": [ "Operator not found" ] }

  • If the operator parameter is provided and does not match any station in the system an HTTP 400 code will be returned with an error

    { "error": "Checkin not performed", "details": [ "Operator not found" ] }

  • If the operator parameter is provided and matches a station in the system that is not an operator an HTTP 400 code will be returned with an error

    { "error": "Checkin not performed", "details": [ "Operator is a non-operator station" ] }

  • If the operator parameter is provided and matches a station in the system that is not an operator an HTTP 404 code will be returned with an error

    { "error": "Checkin not performed", "details": [ "Operator is a non-operator station" ] }

  • If the job tracker station requires an operator and none was provided an HTTP 400 code will be returned with an error

    { "error": "Checkin not performed", "details": [ "Station requires an operator" ] }

  • If the job tracker station being checked into is an operator an HTTP 400 code will be returned with an error

    { "error": "Checkin not performed", "details": [ "Station is an operator" ] }

  • If the order is already complete an HTTP 400 code will be returned with an error

    { "error": "Checkin not performed", "details": [ "Order already completed" ] }

  • If the order is flagged for deletion an HTTP 400 code will be returned with an error

    { "error": "Checkin not performed", "details": [ "Order deleted" ] }

  • If the order is on hold an HTTP 400 code will be returned with an error

    { "error": "Checkin not performed", "details": [ "Order on hold" ] }

  • If the order is unvalid and the job station does not allow unvalid jobs then an HTTP 400 code will be returned with an error

    { "error": "Checkin not performed", "details": [ "Order un-valid" ] }

  • If the there is a job tracker flow verification error an HTTP 400 code will be returned with an error (there are a wide variety of possible error messages based on the job flows that may be required)

    { "error": "Could not complete order", "details": [ "Needs Backside Coat!" ]