The Wineshipping API is currently on v3 (/v3), which is generally available for all production workloads. v4 (/v4) is now available as a public preview — endpoints and behavior may change before general availability.
| Feature | v3 | v4 |
|---|---|---|
| Base URL (Production) | https://api.wineshipping.com/v3 | https://api.wineshipping.com/v4 |
| Base URL (Test) | https://api-test.wineshipping.com/v3 | https://api-test.wineshipping.com/v4 |
| Authentication | Authentication object in request body | TBD |
| Fulfillment | ✅ Available | Planned |
| Inventory | ✅ Available | Planned |
| Tracking | ✅ Available | Planned |
| Commerce | ✅ Available | TBD |
| Product | ✅ Available | TBD |
v3 is the current production API and is available at https://api.wineshipping.com/v3.
Every v3 request that requires authorization must include an Authentication object in the request body containing a UserKey, Password, and CustomerNo. See the Authentication guide for full details.
These endpoints manage the full lifecycle of customer sales orders.
| Operation | Description |
|---|---|
| CreateSalesOrder | Submit a new customer or DTC sales/fulfillment order. Supports standard shipping, carrier pick-up-at-location, and international orders. |
| UpdateSalesOrder | Modify an existing open sales order. |
| CancelSalesOrder | Cancel an open sales order before it has been fulfilled. |
| GetOrdersOnHold | Retrieve all orders currently on hold for a customer account. |
| GetReturns | Retrieve a list of return sales orders received at a Wineshipping warehouse. |
| GenerateJitLabel | Generate a Just-In-Time (JIT) shipping label or packing slip in PDF or PNG format. |
| BatchSalesOrder | (Deprecated) Create multiple orders in a single request. Use individual CreateSalesOrder calls instead. |
These endpoints manage inbound inventory (purchase orders), inventory transfers, and real-time inventory data.
| Operation | Description |
|---|---|
| CreatePurchaseOrder | Create an inbound inventory receipt request (drop-off at warehouse or customer pickup). |
| UpdatePurchaseOrder | Update an existing open purchase order. |
| CancelPurchaseOrder | Cancel an open purchase order. Only allowed before warehouse work has started. |
| CreateTransferOrder | Request an inventory transfer between two Wineshipping-managed warehouse locations. |
| UpdateTransferOrder | Update an open transfer order. |
| CancelTransferOrder | Cancel an open transfer order. Only allowed before warehouse work has started. |
| GetInventoryTransactions | Retrieve inventory transaction history (sales orders, purchase orders, transfers, adjustments, and more). |
| GetInventoryStatus | Retrieve real-time physical inventory details by item, warehouse, and unit of measure. |
| GetSellable | Retrieve real-time sellable inventory quantities for use in e-commerce, POS, or wine club platforms. |
These endpoints provide shipment and package tracking information.
For reliability and scalability, prefer event-driven tracking via webhooks over polling GetDetails.
| Operation | Description |
|---|---|
| GetDetails | Retrieve order tracking status, carrier tracking number, and shipment details for a single order. |
| GetPackages | Retrieve package-level shipping details including tracking numbers and carrier status. |
These endpoints support pre-order address and carrier services.
| Operation | Description |
|---|---|
| AddressValidation | Validate and correct a U.S. delivery address and classify it as residential or commercial. |
| GetCarrierLocations | Retrieve available carrier hold/pickup locations near a given address. |
| GetDeliveryEstimates | Get estimated delivery dates for FedEx and UPS services to a given U.S. address. |
These endpoints manage SKU definitions and item metadata.
| Operation | Description |
|---|---|
| CreateSKU | Define a new SKU for wine, merchandise, or marketing materials. Supports detailed wine classification and metadata. |
| UpdateSKU | Update the metadata for an existing SKU. |
| RetireSKU | Mark a SKU as retired to prevent future orders from being placed against it. |
v4 is now available as a public preview at https://api.wineshipping.com/v4. The server base URL changes from /v3 to /v4.
v4 is a preview and not yet generally available. Endpoints and response shapes may change without notice before GA. Continue using v3 for all production workloads until v4 reaches general availability.
The initial v4 scope targets the three most critical integration areas:
- Fulfillment — Sales order creation, management, and fulfillment operations.
- Inventory — Inventory management, purchase orders, and transfer orders.
- Tracking — Shipment and package tracking.
Details on Commerce and Product endpoints for v4 are to be determined. Continue using v3 for those capabilities until v4 reaches general availability.
Contact api@wineshipping.com for updates on the v4 release timeline.