API Methods for order processing and fulfillment.
REST API (3.1.3)
The REST 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.
Request
Successful execution of this method will generate a new shipment order in Wineshipping's system and will return a transaction reference identifier. Store this identifier back into your system for reference later in the event there is an issue with your order.
Credentials are required for all API operations.
test
Usually the order number in your point of sale (POS) system.
| RETAIL | Used for daily orders. |
| CLUB | Used for club and subscription orders. |
| DTT | Used for 'Direct-To-Trade' orders that go directly to a retailer. |
| WHOLESALE | Used for orders that go to a distributor. |
| DELIVERY_TO_WINERY | Used for orders that move inventory on behalf of the winery without changing ownership (aka RTW). |
Indicates there is a gift message with this order
Required if GiftCard set to 1
Total Shipping cost collected on an Order - useful for compliance
Unique identifier of the order to be used when cancelling or updating an order. The TransactionReferenceValue is returned by the CreateSalesOrder response. If TransactionReferenceNumber is provided OrderNo is ignored.
If set to True or 1, the order will be placed on Fulfillment Hold and will not automatically be fulfilled by Wineshipping until either set to false using UpdateSalesOrder or manually fulfilled via ACP
- Testhttps://api-test.wineshipping.com/v3/api/SalesOrder/CreateSalesOrder
- Productionhttps://api.wineshipping.com/v3/api/SalesOrder/CreateSalesOrder
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- Quick Start
- Common
- Inventory Pickup Request
- Inventory Delivery Request
- Unit Price
- Shipping And Sales Tax Collected
- FedEx HAL
curl -i -X POST \
https://api-test.wineshipping.com/v3/api/SalesOrder/CreateSalesOrder \
-H 'Authorization: WineshippingAuth <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C445598CB576468EA35FBB22C55584EF",
"Password": "AF63FDAC1E704DC1AC9460F669ABF107",
"CustomerNo": "10703"
},
"OrderInfo": {
"TransmissionId": "TransID-083021",
"BatchId": "TSTORDER",
"BatchDescription": "Club Mixed Red 3PK",
"OrderNo": "TESTORDER-1",
"PONo": "",
"ShipmentKey": "",
"OrderType": "CLUB",
"OrderSource": "private concierge",
"OrderDate": "2026-01-01T14:15:22Z",
"GiftCard": 1,
"GiftCardMessage": "gift message text",
"Tags": "",
"SpecialInstructions": ""
},
"RecipientContactInfo": {
"FirstName": "Jane",
"LastName": "Doe",
"Company": "Wineshipping",
"Address": "50 Technology Ct",
"Address2": "",
"City": "Napa",
"State": "CA",
"ZipCode": "94558",
"Country": "US",
"PhoneNumber": "7079339063",
"EmailAddress": "someone@wineshipping.com"
},
"ShipmentInfo": {
"ShippingCarrier": "FEX",
"ShippingCarrierService": "GRND",
"RequestedShipmentDate": "01/01/2025",
"Insurance": 0,
"IcePack": 0,
"WineshippingWarehouseLocation": "APC01"
},
"ItemsInfo": [
{
"ItemNo": "1466-SE",
"ItemDescription": "2016 CAB SAUV RESERVE NAPA VALLEY",
"ItemQuantity": 6
}
]
}'"D94BC05C-A1C3-4CBB-8DA1-E59C73AD2CAE"
Tell us about your experience with this schema
Request
Use this operation to update an existing open sales order. If you are using the IsCancelOnly flag, please migrate to use the Cancel Sales Order method instead.
Unique identifier of the order to be used when cancelling or updating an order. The TransactionReferenceValue is returned by the CreateSalesOrder response. If TransactionReferenceNumber is provided OrderNo is ignored.
- Testhttps://api-test.wineshipping.com/v3/api/SalesOrder/UpdateSalesOrder
- Productionhttps://api.wineshipping.com/v3/api/SalesOrder/UpdateSalesOrder
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-test.wineshipping.com/v3/api/SalesOrder/UpdateSalesOrder?IsCancelOnly=true' \
-H 'Authorization: WineshippingAuth <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C445598CB576468EA35FBB22C55584EF",
"Password": "AF63FDAC1E704DC1AC9460F669ABF107",
"CustomerNo": "10703"
},
"OrderInfo": {
"TransmissionId": "TransID-083021",
"OrderNo": "TESTORDER-1",
"PONo": "string",
"ShipmentKey": "string",
"OrderType": "RETAIL",
"OrderSource": "Tasting Room",
"OrderDate": "2026-08-24T14:15:22Z",
"GiftCard": 0,
"GiftCardMessage": "gift message text",
"Tags": "string",
"SpecialInstructions": "string",
"ConsumerTaxCollected": "string",
"ConsumerShippingPrice": "string",
"BatchId": "TSTORDER",
"BatchDescription": "Club Mixed Red 3PK"
},
"BillingContactInfo": {
"FirstName": "Jon",
"LastName": "Doe",
"Company": "Wineshipping",
"Address": "50 Technology Ct",
"Address2": "Suite A",
"City": "Napa",
"State": "CA",
"ZipCode": "94558",
"Country": "US",
"PhoneNumber": "7079339063",
"EmailAddress": "someone@wineshipping.com"
},
"DeliveryContactInfo": {
"HoldAtLocation": 0,
"LocationCode": "string",
"Company": "Wineshipping",
"Address": "50 Technology Ct.",
"Address2": "Suite 101",
"City": "Napa",
"State": "CA",
"ZipCode": "94558",
"Country": "USA",
"PhoneNumber": "707-933-9063"
},
"RecipientContactInfo": {
"FirstName": "Jane",
"LastName": "Doe",
"Company": "Wineshipping",
"Address": "50 Technology Ct",
"Address2": "string",
"City": "Napa",
"State": "CA",
"ZipCode": "94558",
"Country": "US",
"PhoneNumber": "7079339063",
"EmailAddress": "someone@wineshipping.com"
},
"ShipmentInfo": {
"ShippingCarrier": "FEX",
"ShippingCarrierService": "GRND",
"RequestedShipmentDate": "8/31/2025",
"Insurance": 0,
"IcePack": 0,
"WineshippingWarehouseLocation": "APC01"
},
"ItemsInfo": [
{
"ItemNo": "1466-SE",
"ItemDescription": "2016 CAB SAUV RESERVE NAPA VALLEY",
"ItemQuantity": 6,
"QuantityUnit": "RETAIL",
"InventoryTaxStatus": "string",
"AdditionalFields": {},
"ExternalLineNumber": "100001",
"Group": "gift-set-1"
}
],
"TransactionReferenceNumber": "string",
"AdditionalFields": {}
}'Tell us about your experience with this schema
Request
Use this operation to cancel an existing open sales order. Successful execution of this method will cancel the sales order in Wineshipping system. If the order cannot be cancelled for some reason standard HTTP Status Code and a reason will be returned.
Credentials are required for all API operations.
- Testhttps://api-test.wineshipping.com/v3/api/SalesOrder/CancelSalesOrder
- Productionhttps://api.wineshipping.com/v3/api/SalesOrder/CancelSalesOrder
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-test.wineshipping.com/v3/api/SalesOrder/CancelSalesOrder \
-H 'Authorization: WineshippingAuth <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C445598CB576468EA35FBB22C55584EF",
"Password": "AF63FDAC1E704DC1AC9460F669ABF107",
"CustomerNo": "10703"
},
"OrderNumber": "string",
"TransactionReferenceNumber": "string"
}'Tell us about your experience with this schema
Request
Use this operation to retrieve a list of on-hold orders for a customer. Successful execution of this method will generate a list of on hold orders from Wineshipping's system and if no orders are on hold, HTTP status code Not Found response will be returned.
- Testhttps://api-test.wineshipping.com/v3/api/SalesOrder/GetOrdersOnHold
- Productionhttps://api.wineshipping.com/v3/api/SalesOrder/GetOrdersOnHold
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-test.wineshipping.com/v3/api/SalesOrder/GetOrdersOnHold \
-H 'Authorization: WineshippingAuth <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"UserKey": "C445598CB576468EA35FBB22C55584EF",
"Password": "AF63FDAC1E704DC1AC9460F669ABF107",
"CustomerNo": "10703"
}'[ { "CustomerNo": "string", "CustomerName": "string", "OrderNo": "string", "OrderType": "string", "OrderDate": "string", "ShipmentDate": "string", "ShippingSite": "string", "ShippingWarehouse": "string", "HoldReason": "string", "HoldReasonDescription": "string", "ShippingCarrier": "string", "ShippingCarrierService": "string", "OrderOnHoldItems": [ … ] } ]
Tell us about your experience with this schema
Request
Use this operation to retrieve a list of return sales orders for a customer. Successful execution of this method will generate a list of returns from Wineshipping system.
- Testhttps://api-test.wineshipping.com/v3/api/SalesOrder/GetReturns
- Productionhttps://api.wineshipping.com/v3/api/SalesOrder/GetReturns
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-test.wineshipping.com/v3/api/SalesOrder/GetReturns \
-H 'Authorization: WineshippingAuth <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C445598CB576468EA35FBB22C55584EF",
"Password": "AF63FDAC1E704DC1AC9460F669ABF107",
"CustomerNo": "10703"
},
"OrderNumbers": [
"AQA_ICN82DP4UC"
],
"StartTime": "2026-01-01T15:58:52.526Z",
"EndTime": "2026-01-01T15:58:52.526Z",
"DispositionCode": "Return to Winery",
"Warehouse": "APC01",
"IncludeTotalRecordCount": true,
"Skip": 0,
"Top": 0
}'{ "TotalRecordCount": 0, "Skip": 0, "Top": 0, "MoreRecords": true, "ReturnSalesOrderHeaders": [ { … } ] }
Tell us about your experience with this schema
Request
This method is used to generate a Just-In-Time shipping label for your Orders. It can be used to print just a label or a packingslip and a label. You can choose from PDF or PNG format.
Credentials are required for all API operations.
Reference to your order, use CreateSalesOrder to post the order before generating a jit label
- Testhttps://api-test.wineshipping.com/v3/api/SalesOrder/GenerateJitLabel
- Productionhttps://api.wineshipping.com/v3/api/SalesOrder/GenerateJitLabel
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-test.wineshipping.com/v3/api/SalesOrder/GenerateJitLabel \
-H 'Authorization: WineshippingAuth <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C445598CB576468EA35FBB22C55584EF",
"Password": "AF63FDAC1E704DC1AC9460F669ABF107",
"CustomerNo": "10703"
},
"OrderNo": "#1234",
"AlternateLabelFormat": "FullPDF"
}'OK
encoded PDF per data format, base64 encoded PDF is standard
{ "OrderNo": "#1234", "DataFormat": "application/pdf;base64", "File": "Base64 encoded string" }
Tell us about your experience with this schema
Request
This operation is used to create new orders in batch. The response will contain order creation status for each order along with individual order transaction number for reference later in the event there is an issue with an order.
- Testhttps://api-test.wineshipping.com/v3/api/SalesOrder/BatchSalesOrder
- Productionhttps://api.wineshipping.com/v3/api/SalesOrder/BatchSalesOrder
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-test.wineshipping.com/v3/api/SalesOrder/BatchSalesOrder \
-H 'Authorization: WineshippingAuth <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C445598CB576468EA35FBB22C55584EF",
"Password": "AF63FDAC1E704DC1AC9460F669ABF107",
"CustomerNo": "10703"
},
"BatchId": "BATCHID",
"BatchDescription": "500 mix group",
"SalesOrdersInfo": [
{
"Authentication": {
"UserKey": "C445598CB576468EA35FBB22C55584EF",
"Password": "AF63FDAC1E704DC1AC9460F669ABF107",
"CustomerNo": "10703"
},
"OrderInfo": {
"TransmissionId": "TransID-083021",
"OrderNo": "TESTORDER-1",
"PONo": "string",
"ShipmentKey": "string",
"OrderType": "RETAIL",
"OrderSource": "Tasting Room",
"OrderDate": "2026-08-24T14:15:22Z",
"GiftCard": 0,
"GiftCardMessage": "gift message text",
"Tags": "string",
"SpecialInstructions": "string",
"ConsumerTaxCollected": "string",
"ConsumerShippingPrice": "string",
"BatchId": "TSTORDER",
"BatchDescription": "Club Mixed Red 3PK"
},
"BillingContactInfo": {
"FirstName": "Jon",
"LastName": "Doe",
"Company": "Wineshipping",
"Address": "50 Technology Ct",
"Address2": "Suite A",
"City": "Napa",
"State": "CA",
"ZipCode": "94558",
"Country": "US",
"PhoneNumber": "7079339063",
"EmailAddress": "someone@wineshipping.com"
},
"DeliveryContactInfo": {
"HoldAtLocation": 0,
"LocationCode": "string",
"Company": "Wineshipping",
"Address": "50 Technology Ct.",
"Address2": "Suite 101",
"City": "Napa",
"State": "CA",
"ZipCode": "94558",
"Country": "USA",
"PhoneNumber": "707-933-9063"
},
"RecipientContactInfo": {
"FirstName": "Jane",
"LastName": "Doe",
"Company": "Wineshipping",
"Address": "50 Technology Ct",
"Address2": "string",
"City": "Napa",
"State": "CA",
"ZipCode": "94558",
"Country": "US",
"PhoneNumber": "7079339063",
"EmailAddress": "someone@wineshipping.com"
},
"ShipmentInfo": {
"ShippingCarrier": "FEX",
"ShippingCarrierService": "GRND",
"RequestedShipmentDate": "8/31/2025",
"Insurance": 0,
"IcePack": 0,
"WineshippingWarehouseLocation": "APC01"
},
"ItemsInfo": [
{
"ItemNo": "1466-SE",
"ItemDescription": "2016 CAB SAUV RESERVE NAPA VALLEY",
"ItemQuantity": 6,
"QuantityUnit": "RETAIL",
"InventoryTaxStatus": "string",
"AdditionalFields": {},
"ExternalLineNumber": "100001",
"Group": "gift-set-1"
}
],
"TransactionReferenceNumber": "string",
"AdditionalFields": {}
}
]
}'{ "TransactionReferenceNumber": "string", "CreateSalesOrderStatuses": [ { … } ] }