Request packing slip integration | Magento Order Management Documentation (Archived)

The packing slip integration feature allows you flexibility to customize the experience to your needs and workflow.

Customization of the packing slip

By default, the Order Management System (OMS) generates an HTML packing slip that can be customized with a logo, header, and footer. You can also use the request packing slip message magento.logistics.pick_list_management.request_packing_slip to integrate with an external application that will generate the packing slip. This packing slip can use any format that is supported by the browser.

The request packing slip message will send the information about the package to be sent, and expects a URL as a result. The URL is a link to the document that has been generated. It will be opened and printed on the user’s browser.

It may be used to generated a single packing slip or a batch of packing slips (the user may print all the packing slips from the pick list at once).

Integrate the functionality

To integrate the packing slip generation functionality, you must subscribe your packing slip generation service URL to the service bus method: magento.logistics.pick_list_management.request_packing_slip.

With your own serviceId, this id will be configured in the System Integrator (SI) Portal to allow a specific client to use it. This configuration is available in Omnichannel > Packing slip generation.

This configuration is available in the SI Portal, which is not accessible externally yet. Please contact Magento support.

Example

{
  "jsonrpc": "2.0",
  "method": "magento.service_bus.remote.register",
  "params": {
      "id": "serviceId",
      "url": "https://myservice.com",
      "subscribes": [
          "magento.logistics.pick_list_management.request_packing_slip"
      ]
  }
}

See the Magento Integration Bus topic for more information about how to subscribe to the message bus.

Once subscribed, your service URL “https://myservice.com” receives requests from the service bus and then responds with the magento.logistics.pick_list_management.request_packing_slip message.