Enhance REST API to Print Parcel Carrier Labels

Providing a more flexible and integrated shipping experience, now you can easily print carrier labels using the Print Shipping Label API. When you are working with different carriers used for shipping, you can easily print labels sent from these carriers without changing the design or format of the data sent.

  • Now, if label_designer_code is not sent or is blank, then the Print Shipping Label API looks at the Label Rules Engine to determine the label template. The API now allows the label_designer_code to be optional in the request.
  • If no rule exists in the Label rules engine UI for Shipping Label type, then the API sends the error "Label Rule not found."

NEW CARRIER FLAG IN LABEL RULES ENGINE UI 

Now, printing of carrier labels is supported in the Print Shipping Label API:

  • by directly passing the template name(code) of the label type ‘wsaddon’ for the API parameter label_designer_code. API will then get the carrier label for the OBLPN and print the carrier label merged with the wsaddon label if the carrier label exists for the OBLPN. Note that if the carrier label does not exist for the OBLPN, the API will not error out but will print only the wsaddon label that has been passed in the request.
  • Now if label_designer_code is blank or not passed in the request, API goes through the Label Rules Engine UI. Here, a flag print_carrier_label_only has been added to the Label Rules Engine UI for the SHIPPING label type.

Print Carrier Label Only Flag

Print Carrier Label Only Flag

The following table describes the behavior for printing carrier labels through API when configured in the Label Rules Engine UI:

Label Designer (label type) Print Carrier Label Only Resulting Behavior

Populated (Shipping)

Field is automatically grayed out (inactive) when the label designer is set.

Prints Shipping Label only
Populated (wsaddon) Field is automatically grayed out (inactive) when the label designer is set. Prints Carrier label merged with wsaddon label

Field is automatically grayed out (inactive) when the flag is set.

Yes

Prints Carrier label only

Blank

No

Error

NOTE: When the carrier/wsaddon label is configured in Label Rules Engine UI, the printing of the carrier and/or wsaddon label is also supported from the following:

  • ‘Print Shipping Label’ action button from OB Container UI(ObContainerView).
  •  RF Print Ship Label(rf.outbound.cwrfprintshiplbl).

STEPS TO ENABLE

To enable printing of carrier labels in the Print Shipping Label API:

  1. Either, you can directly pass the label designer code of the label type ‘wsaddon’ for the API parameter label_designer_code.
  2. Or, do not pass the label_designer_code in the request and set the configuration in the Label Rules Engine UI, set the Print Carrier Label Only flag to Yes, for the Shipping label type.

NOTE: The new configuration in the Label Engine UI, also works for printing carrier labels through the ‘Print Shipping label’ action button from OB Container UI and RF Print Ship Label.

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.