The Wineshipping API is a programmatic communications interface designed to enable Wineshipping’s customer and partner applications to natively transmit and manage shipping orders, inventory, package tracking, and other key business and operational functions.
Try out the API methods in in our postman collection.
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/
https://api-test.wineshipping.com/v3/
https://api.wineshipping.com/v3/
This operation is used to create an inbound inventory request. Successful execution of this operation will generate a new purchase order in Wineshipping system. The inbound request can be a pickup from customer address or a drop-off at a Wineshipping warehouse location. A transaction reference identifier is returned in this operation. Store this identifier in your application and systems as applicable. This reference ID is available in the event a problem occurs with the associated request.
Credentials are required for all API operations.
Inventory Location Warehouse Code, see Codes & Descriptions for warehouse locations.
Inventory Status Code, see Codes & Descriptions for possible values
Array of up to 5 items is allowed, and if omitted, all items will be included in the results.
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/InventoryMovement/CreatePurchaseOrder
https://api-test.wineshipping.com/v3/api/InventoryMovement/CreatePurchaseOrder
https://api.wineshipping.com/v3/api/InventoryMovement/CreatePurchaseOrder
curl -i -X POST \
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/InventoryMovement/CreatePurchaseOrder \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"CustomerNo": "10703"
},
"OrderInfo": {
"CustomerReferenceNo": "14932418",
"TransportMethod": "DROPOFF",
"RequestedDate": "08/30/2024",
"ReceiveToLocation": "APC01",
"InventoryStatusCode": "GOOD-NO-TX",
"ReferenceNo": "RN-14932419-D",
"FirstName": "John",
"LastName": "Smith",
"Company": "KV",
"Address": "50 Technology Ct",
"Address2": "",
"City": "Napa",
"State": "CA",
"ZipCode": "94558",
"PhoneNumber": "707-933-9063",
"EmailAddress": "someone@wineshipping.com",
"SpecialInstruction": ""
},
"ItemsInfo": [
{
"ItemNo": "DROPOFF_ITEM-1",
"ItemDescription": "Item Description - 30",
"ItemQuantity": 2500
},
{
"ItemNo": "DROPOFF_ITEM-2",
"ItemDescription": "Item Description - 31",
"ItemQuantity": 3600
},
{
"ItemNo": "DROPOFF_ITEM-3",
"ItemDescription": "Item Description - 32",
"ItemQuantity": 4200
}
]
}'
Credentials are required for all API operations.
Inventory Location Warehouse Code, see Codes & Descriptions for warehouse locations.
Inventory Status Code, see Codes & Descriptions for possible values
Array of up to 5 items is allowed, and if omitted, all items will be included in the results.
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/InventoryMovement/UpdatePurchaseOrder
https://api-test.wineshipping.com/v3/api/InventoryMovement/UpdatePurchaseOrder
https://api.wineshipping.com/v3/api/InventoryMovement/UpdatePurchaseOrder
curl -i -X POST \
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/InventoryMovement/UpdatePurchaseOrder \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"CustomerNo": "10000"
},
"OrderInfo": {
"CustomerReferenceNo": "14932418",
"ReferenceNo": "RN-14932419-D",
"SpecialInstruction": "New instructions"
}
}'
This operation is used to cancel a purchase order request. A transaction reference identifier is required to post using this operation. A transaction reference identifier will be returned upon use of the operation. Store this identifier in your application and systems as applicable. This reference ID is available in the event a problem occurs with the associated request. Successful execution of this method will cancel an open Purchase Order in Wineshipping's system and will return a transaction reference identifier. Note: that Purchase Orders can only be canceled and are considered 'Open' as long as work has not been started.
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/InventoryMovement/CancelPurchaseOrder
https://api-test.wineshipping.com/v3/api/InventoryMovement/CancelPurchaseOrder
https://api.wineshipping.com/v3/api/InventoryMovement/CancelPurchaseOrder
curl -i -X POST \
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/InventoryMovement/CancelPurchaseOrder \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"CustomerNo": "10703"
},
"CustomerReferenceNo": "string"
}'
This operation is used to create a inventory transfer request between two Wineshipping managed inventory locations. Successful execution of this operation will generate a new transfer order in Wineshipping system. A transaction reference identifier is returned in this operation. Store this identifier in your application and systems as applicable. This reference ID is available in the event a problem occurs with the associated request.
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/InventoryMovement/CreateTransferOrder
https://api-test.wineshipping.com/v3/api/InventoryMovement/CreateTransferOrder
https://api.wineshipping.com/v3/api/InventoryMovement/CreateTransferOrder
curl -i -X POST \
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/InventoryMovement/CreateTransferOrder \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"CustomerNo": "10703"
},
"TransferInfo": {
"CustomerReferenceNo": "00B3164C",
"RequestedDate": "5/1/2025",
"TransferFromWarehouse": "APC01",
"InventoryStatusCode": "GOOD-NO-TX",
"TransferToWarehouse": "VCX01",
"FirstName": "John",
"LastName": "Doe",
"PhoneNumber": "7079339063",
"EmailAddress": "john.doe@wineshipping.com",
"SpecialInstruction": ""
},
"ItemsInfo": [
{
"ItemNo": "1466-SE",
"ItemDescription": "2016 CAB SAUV RESERVE NAPA VALLEY",
"ItemQuantity": 6,
"UnitPrice": 0
}
]
}'
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/InventoryMovement/UpdateTransferOrder
https://api-test.wineshipping.com/v3/api/InventoryMovement/UpdateTransferOrder
https://api.wineshipping.com/v3/api/InventoryMovement/UpdateTransferOrder
curl -i -X POST \
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/InventoryMovement/UpdateTransferOrder \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"CustomerNo": "10703"
},
"TransferInfo": {
"TransferOrderNumber": "string",
"CustomerReferenceNo": "string",
"RequestedDate": "2019-08-24T14:15:22Z",
"InventoryStatusCode": "string",
"FirstName": "string",
"LastName": "string",
"PhoneNumber": "string",
"EmailAddress": "string",
"SpecialInstruction": "string"
},
"ItemsInfo": [
{
"ItemNo": "string",
"ItemDescription": "string",
"ItemQuantity": 0
}
]
}'
This operation is used to cancel a transfer order request. A transaction reference identifier is required to post using this operation. A transaction reference identifier will be returned upon use of the operation. Store this identifier in your application and systems as applicable. This reference ID is available in the event a problem occurs with the associated request. Successful execution of this method will cancel an Open Purchase Order in Wineshipping's system and will return a transaction reference identifier. Please note that Transfer Orders can only be canceled and are considered "open" as long as work has not been started.
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/InventoryMovement/CancelTransferOrder
https://api-test.wineshipping.com/v3/api/InventoryMovement/CancelTransferOrder
https://api.wineshipping.com/v3/api/InventoryMovement/CancelTransferOrder
curl -i -X POST \
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/InventoryMovement/CancelTransferOrder \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"CustomerNo": "10703"
},
"CustomerReferenceNo": "string"
}'
This method allows a customer to retrieve inventory transactions. Inventory transactions include Sales Orders, Purchase Orders, Transfer In, Transfer Out, Production Lines, Inventory Adjustments and Inventory Status Changes. There are multiple input filters available for use, including filters to retrieve specific types of inventory transactions, to retrieve transactions processed on a particular date, or to retrieve transactions in a specific Wineshipping warehouse.There are also pagination and skip/top query parameters that allow customers to further control the inventory transactions that are returned in the response.
Credentials are required for all API operations.
Required unless TransactionDate is specified. UTC 2024-02-10T08:12:39.483Z
Not required but only works when TransactionStartDateTime is specified. UTC 2017-02-10T08:12:39.483Z
Required unless TransactionType is specified instead
Inventory Location Warehouse Code, see Codes & Descriptions for warehouse locations.
(COMING SOON)
This field contains Inventory Transaction Reference Codes that explain the reason why a transaction occured
Inventory Status Code, see Codes & Descriptions for possible values
Array of up to 5 items is allowed, and if omitted, all items will be included in the results.
(COMING SOON)
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/Inventory/GetTransactions
https://api-test.wineshipping.com/v3/api/Inventory/GetTransactions
https://api.wineshipping.com/v3/api/Inventory/GetTransactions
curl -i -X POST \
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/Inventory/GetTransactions \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"CustomerNo": "10703"
},
"TransactionType": "Inventory Adjustment",
"Warehouse": "APC01",
"Reference": "",
"InventoryStatus": "GOOD-NO-TX",
"ItemNumbers": [
""
],
"Skip": 0,
"Top": 2500
}'
{ "TransactionReferenceNumber": "79f019f0-1a6e-4777-8c0d-d475ba2aaa3e", "TotalRecordCount": 2, "Skip": 0, "Top": 10000, "MoreRecords": false, "InventoryTransactions": [ { … }, { … } ] }
This operation provides inventory information with warehouse, status, quantity on hand, quantity reserved on orders, quantity on backorder, quantity available, and quantity on an inbound PO. This operation optionally accepts a warehouse code to return related inventory records for a specific Wineshipping warehouse, if omitted the operation will return inventory records for all warehouses. The operation also accepts an array of items to query inventory records, if omitted returns inventory records for all items in the warehouse specified.
Credentials are required for all API operations.
Inventory Location Warehouse Code, see Codes & Descriptions for warehouse locations.
Array of up to 5 items is allowed, and if omitted, all items in the specified warehouse will be included in the results.
Array of up to 5 inventory status codes are allowed, and if omitted, all inventory statuses will be included in the results. Followings are generic status codes. If you have a custom Wineshipping inventory type please work with IT to get the inventory codes. See Codes & Descriptions for possible values
Start returning results after skipping the specified number of results. Default is set to zero. Identifies a subset of the results identified by the input filter. The subset is defined by seeking N results and selecting only the remaining results (starting with N+1). N is an integer greater than or equal to zero specified in the request.
Limit the number of results to the specified value; Default is 2500. Any value outside the range of 0 to 2500, is set to 2500. Identifies a subset of the results based on input filter. The subset is defined by selecting only the first N results, where N is an integer greater than or equal to zero specified in the request.
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/Inventory/GetStatus
https://api-test.wineshipping.com/v3/api/Inventory/GetStatus
https://api.wineshipping.com/v3/api/Inventory/GetStatus
curl -i -X POST \
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/Inventory/GetStatus \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"CustomerNo": "10703"
},
"Warehouse": "APC01",
"ItemNumbers": [
"string"
],
"InventoryStatuses": [
"GOOD-NO-BD"
],
"IncludeTotalRecordCount": false,
"Skip": 0,
"Top": 2500,
"IncludeUnavailableItems": false
}'
{ "TotalRecordCount": 12, "Skip": 0, "Top": 10, "MoreRecords": true, "WarehouseInventoryStatuses": [ { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … } ] }
This operation provides the total, aggregated inventory available to sell. This operation optionally accepts a list of warehouse codes to return sellable inventory totals for a specific subset of Wineshipping warehouses, otherwise all physical locations with sellable inventory are considered.
This method is specifically designed to efficiently sync available inventory quantities with Commerce, pos or other order management systems for all skus. See the GetInventoryStatus for retrieving more detailed inventory information for an individual sku.
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/Inventory/GetSellable
https://api-test.wineshipping.com/v3/api/Inventory/GetSellable
https://api.wineshipping.com/v3/api/Inventory/GetSellable
curl -i -X POST \
https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/Inventory/GetSellable \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "string",
"Password": "string",
"CustomerNo": "string"
},
"Warehouses": [
"string"
],
"OrderType": "string",
"OrderSource": "string",
"ItemNumbers": [
"string"
],
"Verbose": true,
"IncludeUnavailableItems": true,
"IncludeIncomingInventory": true,
"IncludeLibraryInventory": true,
"IncludeStorageInventory": true,
"PageNumber": 0,
"PageSize": 0
}'
{ "TotalRecordCount": 0, "SalesChannel": "string", "Items": [ { … } ] }