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.
Credentials are required for all API operations.
test
Usually the order number in your point of sle 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. |
If set to True, the order will be placed on Fulfillment Hold and will not automatically be fulfilled by Wineshipping until either set to flase using UpdateSalesOrder or manually fulfilled via ACP
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.
curl -i -X POST \
https://developer.wineshipping.com/_mock/api/v3.1/openapi/api/SalesOrder/CreateSalesOrder \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"CustomerNo": "10703"
},
"OrderInfo": {
"TransmissionId": "TransID-083021",
"BatchId": "TSTORDER",
"BatchDescription": "Club Mixed Red 3PK",
"OrderNo": "TESTORDER-1",
"PONo": "",
"ShipmentKey": "",
"OrderType": "CLUB",
"OrderSource": "private concierge",
"OrderDate": "2024-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"
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.
curl -i -X POST \
'https://developer.wineshipping.com/_mock/api/v3.1/openapi/api/SalesOrder/UpdateSalesOrder?IsCancelOnly=true' \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"CustomerNo": "10703"
},
"OrderInfo": {
"TransmissionId": "TransID-083021",
"OrderNo": "TESTORDER-1",
"PONo": "string",
"ShipmentKey": "string",
"OrderType": "RETAIL",
"OrderSource": "Tasting Room",
"OrderDate": "2024-08-24T14:15:22Z",
"GiftCard": 1,
"GiftCardMessage": "gift message text",
"Tags": "string",
"SpecialInstructions": "string",
"HoldOrder": true,
"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/2024",
"Insurance": 0,
"IcePack": 0,
"WineshippingWarehouseLocation": "APC01"
},
"ItemsInfo": [
{
"ItemNo": "1466-SE",
"ItemDescription": "2016 CAB SAUV RESERVE NAPA VALLEY",
"ItemQuantity": 6,
"QuantityUnit": "RETAIL",
"InventoryTaxStatus": "string",
"AdditionalFields": [
{
"name": "string",
"value": "string"
}
]
}
],
"TransactionReferenceNumber": "string",
"AdditionalFields": [
{
"name": "string",
"value": "string"
}
]
}'curl -i -X POST \
https://developer.wineshipping.com/_mock/api/v3.1/openapi/api/SalesOrder/CancelSalesOrder \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"CustomerNo": "10703"
},
"OrderNumber": "string",
"TransactionReferenceNumber": "string"
}'curl -i -X POST \
https://developer.wineshipping.com/_mock/api/v3.1/openapi/api/SalesOrder/GetOrdersOnHold \
-H 'Content-Type: application/json' \
-d '{
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"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": [ … ] } ]
curl -i -X POST \
https://developer.wineshipping.com/_mock/api/v3.1/openapi/api/SalesOrder/GetReturns \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"CustomerNo": "10703"
},
"OrderNumbers": [
"string"
],
"StartTime": "string",
"EndTime": "string",
"DispositionCode": "string",
"Warehouse": "string",
"IncludeTotalRecordCount": true,
"Skip": 0,
"Top": 0
}'{ "TotalRecordCount": 0, "Skip": 0, "Top": 0, "MoreRecords": true, "ReturnSalesOrderHeaders": [ { … } ] }
Credentials are required for all API operations.
Reference to your order, use CreateSalesOrder to post the order before generating a jit label
curl -i -X POST \
https://developer.wineshipping.com/_mock/api/v3.1/openapi/api/SalesOrder/GenerateJitLabel \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"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" }
curl -i -X POST \
https://developer.wineshipping.com/_mock/api/v3.1/openapi/api/SalesOrder/BatchSalesOrder \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"CustomerNo": "10703"
},
"BatchId": "BATCHID",
"BatchDescription": "500 mix group",
"SalesOrdersInfo": [
{
"Authentication": {
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"CustomerNo": "10703"
},
"OrderInfo": {
"TransmissionId": "TransID-083021",
"OrderNo": "TESTORDER-1",
"PONo": "string",
"ShipmentKey": "string",
"OrderType": "RETAIL",
"OrderSource": "Tasting Room",
"OrderDate": "2024-08-24T14:15:22Z",
"GiftCard": 1,
"GiftCardMessage": "gift message text",
"Tags": "string",
"SpecialInstructions": "string",
"HoldOrder": true,
"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/2024",
"Insurance": 0,
"IcePack": 0,
"WineshippingWarehouseLocation": "APC01"
},
"ItemsInfo": [
{
"ItemNo": "1466-SE",
"ItemDescription": "2016 CAB SAUV RESERVE NAPA VALLEY",
"ItemQuantity": 6,
"QuantityUnit": "RETAIL",
"InventoryTaxStatus": "string",
"AdditionalFields": [
{
"name": "string",
"value": "string"
}
]
}
],
"TransactionReferenceNumber": "string",
"AdditionalFields": [
{
"name": "string",
"value": "string"
}
]
}
]
}'{ "TransactionReferenceNumber": "string", "CreateSalesOrderStatuses": [ { … } ] }