Warehouse API is an API service which third party warehouses can utilize for fulfillment purposes. If you are a warehouse looking to integrate using the API, please see the file attatched below. If you would like to integrate a warehouse which supports OrderPort's Warehouse API, continue reading this document for integration setup and management. 

Table of Contents

• Enabling the Module
• Getting the API Information
• Fulfillment
• Order Logs
• API Transferred Information
• Custom Zone Shipping Rates
• Manual Fulfillment Mode: Fulfillment Module
• Auto Fulfillment Mode: Backorder Notification

Enabling the Module

Before starting the setup process, please reach out to your warehouse manager and send them this document. Only continue if they confirm that they can work with the API. 

Once you receive confirmation, you can enable the Warehouse API module by sending a request to helpdesk@orderport.net. 

Getting the API Information

You can generate the API information for your warehouse in OrderPort Admin > Integrations > Warehouse API. Click New Configuration, then select your warehouse under the Fulfiller dropdown. Make sure to set the configuration as enabled. Copy all the API information and send it to your warehouse. 

Fulfillment

You may link your OrderPort locations to warehouse configurations through the Fulfillment tab. Each of your inventory locations may be mapped to the configuration(s) you have set up. 

If you assign a configuration to a warehouse or tasting room, the fulfill mode dropdown will become available. There are two fulfill mode options: automatic and manual. 

Automatic mode will make orders available to the warehouse as soon as the order is paid for, without any action on your part. If you use the Auto fulfill mode, please see the Auto Fulfillment section below.

Manual mode will put the orders into the OrderPort Fulfillment module where you will be prompted to push them to the warehouse. Under the manual system, you may still choose to fulfill them within OrderPort without sending the order to the warehouse. To learn more about the manual workflow, please see the Manual Fulfillment Mode section below.

The "Notify On Export" option allows you to configure when your customer is notified about the order being shipped. If you choose Yes, the customer will be notified as soon as the order is sent to the warehouse. If you choose No, the customer will be notified when the warehouse ships the order.

Order Logs

You can view all shipping orders that were made at a linked inventory location here. Each order has a status. Utilize the Status Legend to understand what each status means. 

Orders with statuses of "Fuflilment Restricted", "Rejected By Warehouse", or "Returned From Warehouse" must be marked as ready for fulfillment before they can be sent back. View the logs to resolve the error, make the necessary edits, then mark it ready in the dropdown to the right. 

API Transferred Information

The API makes available all of the below information. Depending on how the API is utilized, some of this information might not be utilized.

• Order number
• Order date
• Order source
• Order type
• Club name (if the order is from a wine club release)
• Customer number
• Billing address
• Shipping address
• Shipping method
• Shipping notes
• Order total
• Fees and taxes
• Products (quantity, SKU, part no, product type, weight, discount, name, total)
• Future ship date (when applicable) 

The API also supports receiving the tracking number and ship date from the warehouse, if implemented by the warehouse.

Custom Zone Shipping Rates

You should contact your warehouse admin to get flat rate shipping methods. These must be added into OrderPort as Custom Zone Shipping Rates so that you are charging the correct shipping costs to your customers. For help with this process, please see this document: https://training.orderport.net/kb/onboarding/docs/shipping-module/#Custom-Zone-Shipping-Rates. 

Do not hesitate to contact helpdesk@orderport.net if you need additional assistence.

Manual Fulfillment Mode: Fulfillment Module

If you use the manual export function, you will use the Fulfillment module to send orders into the warehouse. In OrderPort Admin, the Fulfillment Module is under the Products category. 

Orders will initially be in the To Import section. Once you finish inventory checks and push the order through, they will fall into the Warehouse API carrier terminal. For more information on the Fulfillment process, please see this document: Fulfillment Module Quick Guide.

You will find the Warehouse API orders at the bottom of the carrier terminals section.

Now, for each order, you will have the option to fulfill the order yourself, or to send it off to the warehouse. To fulfill it yourself, send the orders to OrderPort Fulfillment. To send it to the warehouse, click FF House. If you would like to request the warehouse to ship out the order on a specific date, set a future ship date prior to sending it out.  

Auto Fulfillment Mode: Backorder Notification

If you use the auto fulfill mode, you need to be aware of the backorder function. If an order is made, but there is insufficient inventory to fulfill the order, the order will be backordered and will not process. In order to be notified of backorders, you must subscribe to the backorder notification in the Marketing module. 

Go to the Marketing module, then to the Notifications tab. Search for the Backorder Alert notification and add yourself to the BCC for it.