API/Interface¶
ShipHawk WMS maintains a robust set of APIs to get and post data into NetSuite using RESTful web services. ShipHawk WMS also integrates with variety of other supply chain systems and document formats as well. These are all presented below.
API/Interface Options¶
This section describes the real time API ShipHawk WMS maintains with the NetSuite and other external systems. ShipHawk WMS has also been integrated with other packaged and custom ERPs. Inquiries should be made to ShipHawk if you are interested in using ShipHawk WMS with an ERP other than NetSuite.
NetSuite Integration¶
ShipHawk WMS has been specifically engineered to operate seamlessly with the NetSuite solution. ShipHawk has been working with the NetSuite platform since 2007 to develop and refine a real-time, high-performance, reliable integration with NetSuite that creates a unified experience for the operation. ShipHawk WMS uses multi-threaded RESTful web services to communicate with NetSuite. Each RESTful service will retrieve (GET) or place/update (POST) data into NetSuite in real time. A summary of each endpoint is presented below.
“GET” APIs from NetSuite¶
GET-01 Fulfillment Orders¶
This is an API to get Fulfillment Order headers and details for items to be picked, packed, and shipped at the warehouse. This API includes the Fulfillment Order Number, Referenced Sales Order Number, Customer Purchase Order Number, Customer Attributes, Location (to be shipped from), various Dates (Transaction, Ship By, Cancel By, more), Division/Class, Addresses (Bill To, Ship To, Forwarder, Intermediate Consignee, and more), Instructions and Messages (Warehouse, Shipper, Customer), and one or many Items and Quantities to be shipped. This API will retrieve all Item Fulfillments created by Sales Orders, Transfer Orders, and/or Return to Vendor (RTV) transactions in NetSuite. Any Item Fulfillment attribute that can be referenced with a NetSuite saved search can be integrated with ShipHawk WMS through this API.
GET-02 Purchase Orders¶
This is an API to get Purchase Order headers and details for items to be received at the warehouse. This API includes the Purchase Order Number, Receipt Type, Location (to be received at),various Dates (Transaction, Due Date/Receive By, more), Vendor Attributes, Terms/Incoterms, Instructions and one or many Items and Quantities to be shipped. This API casts all Purchase Orders, Advanced Shipping Notices (a custom NetSuite configuration setup by ShipHawk in your environment), Transfer Orders, or Return Authorizations as Expected Receipts in ShipHawk WMS. If an ASN is being processed through the API, each line will be related to a PO Number and Line Number for reference. This way, the operation can receive goods against a single ASN in the warehouse (such as an overseas container shipment), but ShipHawk WMS will confirm back the actual receipts against the referenced Purchase Orders listed in NetSuite. Any Purchase Order attribute that can be referenced with a NetSuite saved search can be integrated with ShipHawk WMS through this API.
GET-03 Employee Authentication¶
This is an API to validate employee authentication and role to be set for warehouse operations in ShipHawk WMS. ShipHawk WMS does not maintain employee credentials; rather, relies on this NetSuite API to authenticate and authorize/establish an employee role, location, division, and workstation, all defined within NetSuite.
GET-04 Item Master¶
This is an API to get any newly defined or updated Items Attributes defined in NetSuite. Any Item (Kit, Assembly, Group, Non-Inventory, Description, more) attribute that can be referenced with a NetSuite saved search can be integrated with ShipHawk WMS through this API.
GET-05 Inventory Balance on Hand¶
This is an API to get the current Inventory Balance on Hand (physical inventory) in NetSuite so that it can be compared with the current Warehouse Inventory Balance on Hand to report/alert variances.
GET-06 ShipHawk WMS Rules and Lists¶
This is an API to get all rules and lists used by ShipHawk WMS but maintained solely within NetSuite.
“POST” APIs to NetSuite¶
POST-01 Receipts¶
This is an API to post actual Receipts processed at the warehouse referenced against a Purchase Order, Transfer Order, or Return Authorization, and a line item.
POST-02 Shipments¶
This is an API to post actual Shipments processed at the warehouse referenced against a Fulfillment Order and corresponding line items. This API will include actual quantities shipped, tracking numbers, freight charges, weight and other item attributes captured during processing at the warehouse. Consolidated orders will be de-consolidated and freight charges will be prorated across Fulfillments as dictated by requirements.
POST-03 Inventory Adjustments, Transfers, and Builds¶
This is an API to post changes to Inventory quantities, statuses, or locations using Inventory Adjustments, Inventory Transfers, and Inventory Builds.
POST-04 Inventory Balance on Hand Synchronization¶
This is an API to post adjustments to synchronize balance on hand comparisons between the ERP and WMS.
POST-05 Bin Inventory Synchronization¶
This is an API to post changes in Custom Bin Table for reference within NetSuite
POST-06 Task/Move Synchronization¶
This is an API to post changes in Custom Move Table for reference within NetSuite
POST-07 RocketShipIt Carrier Manifesting Integration¶
This is an API to rate shop, create labels, and manifest shipments for UPS®, FEDEX®, USPS®, DHL®, and Canadian Post®. UPS®, FEDEX®, USPS®, DHL®, and Canadian Post® trademarks are property of their respective owners.
POST-08 EasyPost Carrier Manifesting Integration¶
This is an API to rate shop, create labels, and manifest international shipments including customs documentation
POST-09 SPS Advanced Shipping Notice (ASN) Integration¶
This is an API to create standard SPS structures in NetSuite necessary to create EDI ASN 856 transactions for all major retailers
POST-10 SPS Ship Label Integration¶
This is an API to create retrieve SSCC-18 compliance labels from SPS’s Label API for all major retailers
POST-11 Documentation Processing Integration¶
This is an API to process PDF, Word, Excel, CSV, EDI X12 and other document based files into ShipHawk WMS or NetSuite content.
POST-12 PrintNode Integration¶
This is an API to process manage physical printers and devices from a web-based application. ShipHawk WMS uses PrintNote to direct PDF documents to traditional printers and ZPL files to raw label printers. ShipHawk WMS also uses PrntNode to read weight scales. No data is ever actually sent to PrintNode, rather, URLs are passed to the service and the local print server retrieves the files based on those URLs for printing. See figure below on ShipHawk WMS/PrintNode integration architecture.
POST-13 Borderlinx Integration¶
This is an API to efficiently process cross-border international shipments using the Borderlinx cloud service.