API Reference

Wineshipping API (3.1.2)

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.

Download OpenAPI description

openapi.json

openapi.yaml

Overview

URL

https://wineshipping.com

API Support

api@wineshipping.com

License

Proprietary

Servers

Mock server

https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/

Test

https://api-test.wineshipping.com/v3/

Production

https://api.wineshipping.com/v3/

Fulfillment

API Methods for order processing and fulfillment.

Operations

Inventory

API Methods for inventory management.

Operations

Product

API Methods for item management.

Operations

Tracking

API Methods for tracking and shipments.

Operations

Commerce

API Methods for carriers, expected delivery dates and addresses.

Operations

Validate delivery address

Request

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.

Bodyapplication/json

Authenticationobject(Authentication)required

Credentials are required for all API operations.

Authentication.UserKeystringrequired

Example: "C5EAAD3DF1094EDFB2B4685F8A7AB2E1"

Authentication.Passwordstringrequired

Example: "A781281230444BD7BC72F7753B944A71"

Authentication.CustomerNostringrequired

Example: "10703"

ClientReferenceCodestring(ClientReferenceCode)<= 36 charactersrequired

Example: "8232021-1"

ShippingCarrierstring(ShippingCarrier)<= 5 charactersrequired

Enum"FEX""UPS""Other"

Addressobject(Address)required

Address.StreetLinesArray of strings

Example: ["50 Technology Ct"]

Address.Citystring<= 255 characters

Example: "Napa"

Address.Statestring[ 2 .. 255 ] characters

Example: "CA"

Address.ZipCodestring[ 5 .. 10 ] characters

Example: "94558"

Address.Countrystring= 2 characters

Example: "US"

curl -i -X POST \
  https://wineshipping-api.redocly.app/_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"
    }
  }'

Responses

Bodyapplication/json

TransactionReferenceNumberstring

AddressValidationIndicatorstring

AddressClassificationIndicatorstring

AddressCandidatesArray of objects(AddressCandidate)

PALDetailsArray of objects(PALResponse)

Response

application/json

{
  "TransactionReferenceNumber": "1c7633da-c999-4522-a57a-cf765fc6bbec",
  "AddressValidationIndicator": "VALID",
  "AddressClassificationIndicator": "BUSINESS",
  "AddressCandidates": [
    { … }
  ],
  "PALDetails": []
}

Get carrier hold locations

Request

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.

Bodyapplication/json

Authenticationobject(Authentication)required

Credentials are required for all API operations.

Authentication.UserKeystringrequired

Example: "C5EAAD3DF1094EDFB2B4685F8A7AB2E1"

Authentication.Passwordstringrequired

Example: "A781281230444BD7BC72F7753B944A71"

Authentication.CustomerNostringrequired

Example: "10703"

ShippingCarrierstring

Enum"FEX""UPS"

Citystring

Statestring

ZipCodestring

SearchRadiusnumber[ 5 .. 50 ]

Search in miles

Latitudenumber

Longitudenumber

Topinteger

Skipinteger

curl -i -X POST \
  https://wineshipping-api.redocly.app/_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
  }'

Responses

Bodyapplication/json

TransactionReferenceNumberstring

TotalRecordCountinteger(int32)

Skipinteger(int32)

Default 0

Topinteger(int32)

MoreRecordsboolean

CarrierLocationsArray of objects(CarrierLocation)

Response

application/json

{
  "TransactionReferenceNumber": "70584f7f-e8e1-4127-a5f7-96e837493bdb",
  "TotalRecordCount": 2,
  "Skip": 0,
  "Top": 10,
  "MoreRecords": false,
  "CarrierLocations": [
    { … },
    { … }
  ]
}

Estimate delivery dates

Request

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.

Bodyapplication/json

Authenticationobject(Authentication)required

Credentials are required for all API operations.

Authentication.UserKeystringrequired

Example: "C5EAAD3DF1094EDFB2B4685F8A7AB2E1"

Authentication.Passwordstringrequired

Example: "A781281230444BD7BC72F7753B944A71"

Authentication.CustomerNostringrequired

Example: "10703"

ClientReferenceCodestring[ 1 .. 36 ] characters

Example: "abcd-1234"

DeliveryAddressobject(Address)required

DeliveryAddress.StreetLinesArray of strings

Example: ["50 Technology Ct"]

DeliveryAddress.Citystring<= 255 characters

Example: "Napa"

DeliveryAddress.Statestring[ 2 .. 255 ] characters

Example: "CA"

DeliveryAddress.ZipCodestring[ 5 .. 10 ] characters

Example: "94558"

DeliveryAddress.Countrystring= 2 characters

Example: "US"

DeliveryEstimateRangeinteger(int32)[ 1 .. 30 ]required

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.

Default 1

Example: 1

curl -i -X POST \
  https://wineshipping-api.redocly.app/_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
  }'

Responses

Bodyapplication/json

TransactionReferenceNumberstring

DeliveryAddressobject(Address)

DeliveryEstimateOptionsArray of objects(DeliveryEstimateOption)

Response

application/json

{
  "TransactionReferenceNumber": "550e8400-e29b-41d4-a716-446655440000",
  "DeliveryAddress": {
    "StreetLines": [ … ],
    "City": "Napa",
    "State": "CA",
    "ZipCode": "94558",
    "Country": "US"
  },
  "DeliveryEstimateOptions": [
    { … }
  ]
}

Wineshipping API (3.1.2)

Fulfillment

Inventory

Product

Tracking

Commerce

Validate delivery address

Request

Responses

Was this helpful?

Get carrier hold locations

Request

Responses

Was this helpful?

Estimate delivery dates

Request

Responses

Was this helpful?

Wineshipping API (3.1.2)

Fulfillment

Inventory

Product

Tracking

Commerce

Validate delivery address

RequestExpand all

Responses

Was this helpful?

Get carrier hold locations

RequestExpand all

Responses

Was this helpful?

Estimate delivery dates

RequestExpand all

Responses

Was this helpful?

Request

Request

Request