Print Packing Slips using a REST API
Providing improved efficiency and automation, you can now print packing slips for one or more OBLPNs to a specified printer from an external system (such as Material Handling Equipment (MHE.) Enabling automated printing of packing slips allows for seamless integration with external systems, like MHE. Automating this process saves time, reduces manual interventions, and increases overall operational efficiency.
NOTE: For a GET request, the ZPL data will be base64 encoded in the "data" section.
URLs
POST .../wms/lgfapi/v10/print/document/oblpn_packing_slip
GET.../wms/lgfapi/v10/print/document/oblpn_packing_slip/doc_designer_code=foo
API Parameters
| Category | Name | Type | Required | Comments |
|---|---|---|---|---|
| options | doc_designer_code | string | C | Document template to be printed. |
| options | web_report_path | string | C | This field is mandatory. the path for the web report template. |
| options |
web_report_format |
string | C |
This field is mandatory. the file format of the report xls/csv/pdf. NOTE: For GET method all three file formats are supported. For POST, only .pdf is supported. |
| options | printer_name | string |
Defaults to cwuser.default_document_printer. |
|
| options | document_count | integer |
Number of documents to print. Must be greater than 0. Default = 1. |
PALLET PACKING SLIPS
The Pallet Packing Slip API allows you to print pallet packing slips. Note that this API will not do any template determination logic as seen in the UI. Doc designer code is required as part of the API parameters. Any determination would need to be done in the outside system.
This API supports the following HTTP methods:
- GET - Returns the ZPL representation of the document.
- HEAD - only supports checking if the object exists since lookup models don't have create_ts.
- POST - Submits the document for printing.
URLs
POST .../wms/lgfapi/v10/print/document/pallet_packing_slip
GET.../wms/lgfapi/v10/print/document/pallet_packing_slip/?doc_designer_code=foo
API PARAMETERS
| Category | Name | Type | Required | POST Request | Comments |
|---|---|---|---|---|---|
| options | web_report_path | string | X | X | This field is mandatory. This is the path of the web report template. |
| options | web_report_format | string | X | X |
This field is mandatory. the file format of the report xls/csv/pdf. NOTE: For GET method all three file formats are supported. For POST, only .pdf is supported. |
| options | printer_name | string | Defaults to cwuser.default_document_printer. | ||
| options | document_count | integer | Number of documents to print. Must be greater than 0. Default = 1. |
ORDER PACKING SLIPS
The Order Packing Slip API allows you to print pallet packing slips. Note that this API will not do any template determination logic as seen in the UI. Doc designer code is required as part of the API parameters. Any determination would need to be done in the outside system.
This API supports the following HTTP methods:
- GET - Returns the ZPL representation of the document.
- HEAD - only supports checking if the object exists since lookup models don't have create_ts.
- POST - Submits the document for printing.
URLs
POST.../wms/lgfapi/v10/print/document/order_packing_slip
GET.../wms/lgfapi/v10/print/document/order_packing_slip/?doc_designer_code=foo
API PARMETERS
| Category | Name | Type | Required | GET Request | POST Request | Comments |
|---|---|---|---|---|---|---|
| options | doc_designer_code | string | X | X | X | Document template to be printed |
| options | web_report_path | string | X | X | This field is mandatory. the path of the web report template | |
| options | web_report_format | string | X | X |
This field is mandatory. the file format of the report xls/csv/pdf. NOTE: For GET method all three file formats are supported. For POST, only .pdf is supported. |
|
| options | printer_name | string | X | Defaults to cwuser.default_document_printer. | ||
| options | document_count | integer | X | Number of documents to print. Must be greater than 0. Default = 1. |
Steps to Enable
Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.