Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

POST /api/v2/orders/{orderIdentifier}/print_ticket

This endpoint is used to delete print a workticket for an order. The order will be printed using the settings for workstation 00.

...

Accepts

  • 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

  • A reason for deletion. This is required if the system setting Orders1:Enter reason code when deleting order is checked, and ignored if it is uncheckedAn LPT port to print to. This refers to the LPT settings for workstation 00.

Success

On a successful request the order will be flagged for deletion, and an HTTP 200 code will be returned with a the last known state of the order. This will match the structure returned by Fetch a Single Order.

Error

...

workticket for the order will be printed to the requested printer. An HTTP 201 code will be returned along with an

...

informational message.

Code Block
languagejson
{
  "errororderNumber": "No record found123456",
  "detailstrayNumber": [
    "Provided: 9999999"
  ]
}
  • If the job tracker module is not installed, an HTTP 400 code will be returned with an error

Code Block
languagejson
{31776",
  "errorpoNumber": "Job Tracker module required for cancel methodSP40KGTA",
  "details": []
 }
  • If the order is already marked for cancellation an HTTP 400 code will be returned with an error

Code Block
languagejson
{
  "error": "Order already completed",
  "details": []
 }
  • If the system requires a delete reason and none have been configured, an HTTP 400 code will be returned with an error

Code Block
languagejson
{
  "error": "The delete reasons file is empty",
  "details": []
}
  • If the system requires a delete reason and no valid reason was provided, an HTTP 400 code will be returned with an error

Code Block
languagejson
{
  "error": "Delete reason code does not exist",
  "details": [
    "Provided: 9999"
  ]
}
  • If the order has been through a station that prevents it from being cancelled, an HTTP 400 code will be returned with an error

Code Block
languagejson
{
  "error": "Order has been through a non-cancel station",
  "details": []
}message": "Printing in process"
}

Error