Windfall NG API Details
Swagger documentation
Here are the API details. The API key provided here points to our UAT system which is a copy of the production system used for testing. We do update this site from time to time so don't count on data staying there. We always refresh the data from production.
When you are done testing and ready to move into production, we will issue a new API key for the production environment and provide you a new endpoint.
There is no cost for testing against the stage environment. When you move to production the pricing is as follows:
Pricing
Free Tier - up to 100 transactions per month
Small Business - $250/month up to 5,000 transactions per month
Large Business - $500/month up to 10,0000 transactions per month
Enterprise - Contact us
The API_Key needs to be in the header of the request.
Base URL for requests is:
https://uat-svc.windfallonline.com/WindfallAPI/
Swagger documentation page
https://uat-svc.windfallonline.com/WindfallAPI/swagger/ui/index#/
Brief descriptions:
1. /Importer/Articles - Request to Insert and updates articles for a customer
2. /Inventory/ActiveInventory - Returns a current list of inventory on hand.
3. /InventoryAdjustment/AdjustmentReport - (in development) Returns all inventory transactions that were not performed against an API work order since the last request was made
4. /InventoryAdjustment/Transactions (in development)
5. /WorkOrder/CreateInboundWorkOrderByInventory - Request to create an inbound work order with specific inventory numbers.
6. /WorkOrder/CreateInboundWorkOrderByArticle - Request to create an inbound work order by an article number.
7. /WorkOrder/CreateOutboundWorkOrderByInventory - Request to create an outbound work order with specific inventory numbers.
8. /WorkOrder/CreateOutboundWorkOrderByGrouping - Request to create an outbound work order by the inventory grouping.
9. /WorkOrder/CreateMoveWorkOrderByInventory - Request to create an internal mover work order with specific inventory numbers.
10. /WorkOrder/CreateMoveWorkOrderByGrouping - Request to create an internal move work order by the inventory grouping.
11. /WorkOrder/UpdateWorkOrder
12. /WorkOrderReport/ReceiptDetails - Returns all receipts for inbound work orders for any order that was sent in via the api since the last request was made
13. /WorkOrderReport/ShippingDetails - Returns all shipments for outbound work orders for any order that was sent in via the api since the last request was made
Finally, here is a short little description on the two fields that are required for all API methods:
B2BTradingPartnerCode
The B2BTradingPartnerCode is a value to help us identify which warehouse the user wants to make a work order under. You can find this B2BTradingPartnerCode by logging in as the admin user to Windfall NG, press the “Administration” tab on the left-hand side navigation bar, then press the “Warehouses” tab, then select the warehouse you wish to view. You should be able to see the B2BTradingPartnerCode in plain text when viewing a warehouses details. You will need to provide the user with ALL the B2BTradingPartnerCodes that they will want to send requests with and make work orders for.
CustomerName
The CustomerName is typically what you will see when viewing the customer list when pressing the “Customers” tab on the left-hand side navigation bar in Windfall NG. If the customer is a COMMERCIAL type customer, then the customer name will be exactly as you see it in the customer list. However, if the customer is a HOUSEHOLD GOODS type customer, then you will need to look up the company name for that customer. Make sure the user is aware of this fact, and provide them with the company name of any customer that might be household goods customer.