Overview & Integration Best Practices
The Wineshipping API is available to clients and technology partners for creating orders, tracking shipments, creating products, managing inventory, and more using Wineshipping’s industry-leading logistics platform.
Operations & Functions
Fulfillment
This is the first focal point for integration. We refer to customer orders as either sales or fulfillment orders. We refer to managing items and inventory as purchase orders or transfer orders.
Essential Integration
Create a sales/fulfillment order - An easy to use offering with a robust set of order information & options to support what makes your direct-to-consumer(DTC) or Wholesale experience unique. It supports pick-up at location services from select carriers.
Processing and publishing orders is a two step process. Do not immediately call the GetDetails call which is rate limitied.
Additional Integrations
- Update an Order
- Cancel an Order
- Get On-Hold orders to manage fulfillment
- Get data on orders returned to a Wineshipping warehouse
Tracking
For scalability and reliability it is advised to use the event driven tracking method.
Send an email to api@wineshipping.com to enable a webhook integration which is the preferred method for managing tracking information.
Tracking Recommended Integration
Get tracking numbers and shipment status changes back to your systems and your customers as they happen with event driven tracking via webhooks. Alternatively use the Track Packages method for situations where ad-hoc individual order status lookups are sufficient.
The webhooks and api return information includes:
- Order processing status
- Package tracking, carrier status and messaging
- Inventory reservation
- Embedded carrier tracking page link(s)
- Delivery date estimation
Inventory
Inventory apis are used to manage inventory and product information
Inventory Recommended Integration
Execute a real time check or inventory sync with your shopping cart, pos or wine club using Get Sellable Inventory
Optionally, access detailed, real time physical inventory information and inventory transactions for inventory management reporting or for integration with your ERP system.
- By item and item description
- By warehouse location
- By unit of measure
- Inventory status and quantities
- On-Hand, Reserved, Available, Backorder, On-Order
- Damages, Returns status
Products
Create Items for wine, merchandise, and marketing materials
- Define detailed product classification and information for wine items only