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.
Use the Wineshipping Address Validation and Classification API operation to validate/correct and classify recipient addresses before you send the order to Wineshipping for fulfillment service. This API operation formats an input to some degree, and returns validation and classification indicators along with formatted addresses if any matching addresses are found. The operation also support searching pickup location as an option for UPS and FedEx only. Successful execution of this method will return a transaction reference identifier.Store this identifier back into your system for reference later in the event there is an issue with a specific address validation and classification result.
Credentials are required for all API operations.
curl -i -X POST \
https://developer.wineshipping.com/_mock/api/v3.1/openapi/api/Address/Validation \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
"Password": "A781281230444BD7BC72F7753B944A71",
"CustomerNo": "10703"
},
"ClientReferenceCode": "",
"ShippingCarrier": "FEX",
"Address": {
"StreetLines": [
"169 W Chocolate Ave"
],
"City": "Hershey",
"State": "PA",
"ZipCode": "17033",
"Country": "US"
}
}'{ "TransactionReferenceNumber": "1c7633da-c999-4522-a57a-cf765fc6bbec", "AddressValidationIndicator": "VALID", "AddressClassificationIndicator": "BUSINESS", "AddressCandidates": [ { … } ], "PALDetails": [] }
This operation returns the carrier pickup locations addresses where wine shipments are allowed. You can fitler your search by carrier, city, state, zip code and/or paginate through the result set.
Note: The information provided by the Wineshipping Get Carrier Locations API service is based on the corresponding FedEx and/or UPS service information available at the time of inquiry, and is subject to change without notice. Due to these factors, Wineshipping cannot guarantee the accuracy of current or future information generated by this API service.
Credentials are required for all API operations.
curl -i -X POST \
https://developer.wineshipping.com/_mock/api/v3.1/openapi/api/Address/GetCarrierLocations \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"CustomerNo": "10703",
"UserKey": "USER123",
"Password": "pass123"
},
"ShippingCarrier": "FEX",
"ZipCode": "94558",
"SearchRadius": 25
}'{ "TransactionReferenceNumber": "70584f7f-e8e1-4127-a5f7-96e837493bdb", "TotalRecordCount": 2, "Skip": 0, "Top": 10, "MoreRecords": false, "CarrierLocations": [ { … }, { … } ] }
This operation provides delivery date estimation for Wineshipping fulfillment using FedEx and UPS carrier services within the USA. It requires an authenticated request with the recipient delivery address and desired range of future ship dates to generate a set of results for each applicable carrier and service class combination available for the delivery address and specified dates.
Note: The information provided by the Wineshipping Delivery Date Estimate API service is for estimating approximate delivery dates based on the corresponding FedEx and/or UPS carrier service information available at the time of inquiry, and is subject to change without notice. Due to these factors, Wineshipping cannot guarantee the accuracy of current or future information generated by the Delivery Date Estimate API service.
Credentials are required for all API operations.
Controls how many future ship dates to generate for delivery estimates. If DeliveryEstimateRange = 5, it will return up to 5 valid shipping dates. Each date includes both the ship date and its associated cutoff time. Weekends and holidays are skipped when determining valid ship dates.
curl -i -X POST \
https://developer.wineshipping.com/_mock/api/v3.1/openapi/api/Tracking/GetDeliveryEstimates \
-H 'Content-Type: application/json' \
-d '{
"Authentication": {
"CustomerNo": "10703",
"UserKey": "API_USER",
"Password": "API_PASSWORD"
},
"ClientReferenceCode": "ORDER_REF_123",
"DeliveryAddress": {
"StreetLines": [
"123 Main St"
],
"City": "Napa",
"State": "CA",
"ZipCode": "94558",
"Country": "US"
},
"DeliveryEstimateRange": 1
}'{ "TransactionReferenceNumber": "550e8400-e29b-41d4-a716-446655440000", "DeliveryAddress": { "StreetLines": [ … ], "City": "Napa", "State": "CA", "ZipCode": "94558", "Country": "US" }, "DeliveryEstimateOptions": [ { … } ] }