Previous Topic

Next Topic

Book Contents

Book Index

Working with integrations and bills of lading

Bills of lading are accessible through SmartTurn web services. The following web services operations are available for bills of lading. For specific details, contact your SmartTurn representative for a copy of the SmartTurn Web Services API.

  • lookUpBOLs: This operation retrieves bills of lading in their entirety, based on specified criteria.
  • setBOLCustomFields: This operation sets any of the custom fields for any of the BOL #s provided. (Bills of lading can have custom fields of Business Process Outbound and Inventory.) To set Outbound custom fields, the bill of lading must be In Progress or Closed. To set Inventory (line item) custom fields, the bill of lading must be In Progress.
    • Because of the known issues around bill of lading custom fields, this operation is especially useful. For example, you could use the lookUpBOLs operation, determine what the custom field values should be (for example, by doing a lookUpSalesOrders operation for the SO #s listed on the bill of lading), and then using this operation to set the bill of lading custom field values.
  • updateBOLPkgAttributes: This operation sets any of the package attributes (Tracking #, Tracking URL, Total Est Charges, etc.) for any of the packages of the BOL#s provided. The bill of lading must be In Progress or Closed for this operation to succeed.
  • closeDocuments: This operation sets the Status of the BOL#s provided to Closed. All of packages become Closed and the inventory leaves the warehouse. (See also Closing bills of lading: this operation is equivalent to the Ship All Packages action.)
  • shipClosedBOLPackages: This operation sets the Status of the BOL#s provided to Closed. All of the inventory from the Closed packages leaves the warehouse. All of the inventory from any other packages is dropped at the packing station. (See also Closing bills of lading: this operation is equivalent to the Ship Closed Packages action.)
  • commitDocuments: This operation sets the Status of the BOL#s provided to Committed. The bills of lading must already be Closed. The header fields and package attributes are no longer editable. (See also Committing bills of lading.)
  • consumeDocuments: This operation sets the Status of the BOL#s provided to Consumed. The bills of lading must already be Committed. This operation is not available through the user interface. It is used to indicate that not only has the bill of lading been updated with information, such as Tracking #s, that is only available after the document is Closed, but that that communication is completed and the end result has been accepted by another system.

See Also

Bills of Lading

Viewing bills of lading

Creating bills of lading

Editing bills of lading

Actions on the BOL packages

Actions on the BOL items

Closing bills of lading

Committing bills of lading

Working with custom fields and bills of lading

Bill of lading field descriptions

© 2014 Dicentral Corporation http://smartturn.dicentral.com