API Reference
/
Tracking
/
Get package shipping details

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

Languages
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

Get order tracking details

Request

Order tracking details and status from shipping carriers when available. Use customer and order identifiers to locate associated records, including tracking numbers, order fulfillment and carrier status, and shipping information. highly scalable alternative: event driven tracking webhook

Bodyapplication/json
AuthenticationDetailsobject(Authentication)required

Credentials are required for all API operations.

AuthenticationDetails.​UserKeystringrequired
Example: "C5EAAD3DF1094EDFB2B4685F8A7AB2E1"
AuthenticationDetails.​Passwordstringrequired
Example: "A781281230444BD7BC72F7753B944A71"
AuthenticationDetails.​CustomerNostringrequired
Example: "10703"
OrderNostringrequired

Customer Order reference number

curl -i -X POST \
  https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/Tracking/GetDetails \
  -H 'Content-Type: application/json' \
  -d '{
    "AuthenticationDetails": {
      "UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
      "Password": "A781281230444BD7BC72F7753B944A71",
      "CustomerNo": "10703"
    },
    "OrderNo": "string"
  }'

Responses

OK

Bodyapplication/jsonArray [
OrderNumberstring
Example: "08312025-FO-9808"
Carrierstring

Carrier Code used to ship the order

Example: "FEX"
Servicestring

Code of the carrier service level used to ship the order

Example: "GRND"
TrackingNostring

Tracking number for the package

Example: "934076697393"
TrackingURLstring

hyperlink for carrier package tracking (when available from the carrier)

Example: "https://www.fedex.com/apps/fedextrack/?tracknumbers=934076697393"
RequestedShipDatestring

The requested shipping date specified upon order creation in Wineshipping system and updated dynamically based on the order processing status.

Example: "8/18/2024"
ShipDatestring

Requested ship date submitted with the sales order until which time the package(s) is processed for shipment and receives a shipment confirmation date (actual ship date)

Example: "8/18/2024"
Typestring

Order type - Club, Daily, or other as applicable

Example: "CLUB"
IcePackinteger

does the packages contain ice pack(s)

Default 0
Statusstring

Sales Order fulfillment status values:

  • RECEIVED – Order received for fulfillment processing
  • SHIPPED – Package has left our facility
  • IN TRANSIT – Package has left carrier origin facility
  • READY FOR PICKUP – Package ready for Will Call pickup
  • DELIVERED – Package has been delivered
  • EXCEPTION – Order has experienced a fulfillment or carrier exception
  • CANCELED – Order had been canceled
  • RETURNED – Package is returning to shipper
  • DELIVERED TO SHIPPER – Package has been returned to sender
Enum"RECEIVED""SHIPPED""READY FOR PICKUP""IN TRANSIT""DELIVERED""EXCEPTION""CANCELED""DELIVERED TO SHIPPER""RETURNED"
Example: "SHIPPED"
StatusDescriptionstring

Additional status information, when available

Example: "Package delivered to the receiver"
Sitestring
Warehousestring(InventoryWarehouse)

Inventory Location Warehouse Code, see Codes & Descriptions for warehouse locations.

Enum"APC01""APC02""COB01""COB02""ETC01""MMC01""PRB04""SJU01""TWL01""VCX01"
Example: "APC01"
CarrierStatusstring

Current carrier status code

Example: "D"
CarrierStatusMessagestring

Status message directly from the carrier

CarrierStatusTimestampstring
PackageLocationstring
Example: "Delivered"
EstimatedDeliveryDatestring

Upon Sales Order processing, this is the Estimated Delivery Date for the Sales Order based on the Requested Shipping Date submitted, and it will update within 4 hours of any changes made to the Sales Order’s Requested Shipping Date. Upon origin scan for each package, this date will be representative of the carrier’s published estimate. Support is presently for FEX and UPS carriers.

GrossWeightstring

Gross weight in lbs

Example: "22.6"
ShipToNamestring

Ship to name or company name

Example: "Jane Doe"
ShipToContactstring

Ship to contact person name

ShipToAddressstring

Primary address where the package is shipped

Example: "3010 Main Street"
ShipToAddress2string

Second address line where the package is shipped

ShipToCitystring
Example: "Folsom"
ShipToStatestring
Example: "CA"
ShipToZipCodestring
Example: "95630"
ShipToCountrystring
Example: "USA"
PackageItemsArray of objects(PackageItem)
]
Response
application/json
[
  {
    "OrderNumber": "08312025-FO-9808",
    "Carrier": "FEX",
    "Service": "GRND",
    "TrackingNo": "934076697393",
    "TrackingURL": "https://www.fedex.com/apps/fedextrack/?tracknumbers=934076697393",
    "RequestedShipDate": "8/18/2024",
    "ShipDate": "8/18/2024",
    "Type": "CLUB",
    "IcePack": 0,
    "Status": "SHIPPED",
    "StatusDescription": "Package delivered to the receiver",
    "Site": "string",
    "Warehouse": "APC01",
    "CarrierStatus": "D",
    "CarrierStatusMessage": "string",
    "CarrierStatusTimestamp": "2019-08-24T14:15:22Z",
    "PackageLocation": "Delivered",
    "EstimatedDeliveryDate": "2019-08-24",
    "GrossWeight": "22.6",
    "ShipToName": "Jane Doe",
    "ShipToContact": "string",
    "ShipToAddress": "3010 Main Street",
    "ShipToAddress2": "",
    "ShipToCity": "Folsom",
    "ShipToState": "CA",
    "ShipToZipCode": "95630",
    "ShipToCountry": "USA",
    "PackageItems": [ … ]
  }
]

Get package shipping details

Request

This operation provides package information in batches once warehouse activity started in order fulfillment. Provides filters options to search for packages by ship date range, last activity date range, shipping carrier, order numbers and options to paginate through the result set.

Please also see our event-based API: event driven tracking webhook

Bodyapplication/json
Authenticationobject(Authentication)required

Credentials are required for all API operations.

Authentication.​UserKeystringrequired
Example: "C5EAAD3DF1094EDFB2B4685F8A7AB2E1"
Authentication.​Passwordstringrequired
Example: "A781281230444BD7BC72F7753B944A71"
Authentication.​CustomerNostringrequired
Example: "10703"
ShipDateRangestring
LastActivityDateRangestringnon-empty

When populating this string, it is important to specify both date and time as shown in the example below. If you are searching for a single date, you will still need to provide the range with a time value to capture all activity within a 24-hour period. Example: "12/19/2022 00:00:00 - 12/19/2022 23:59:59"

Example: "\"01/01/2025 00:00:00 - 12/31/2022 23:59:59\""
ShippingCarrierstring
OrderNumbersArray of strings

Array of up to 100 order numbers is allowed

Skipnumber
Topnumber
curl -i -X POST \
  https://wineshipping-api.redocly.app/_mock/api/v3.1/openapi/api/Tracking/GetPackages \
  -H 'Content-Type: application/json' \
  -d '{
    "Authentication": {
      "UserKey": "1B4534D2667948A081BB24C26C46E07A",
      "Password": "63333FB8403B4AF28B366DFC0B4D320F",
      "CustomerNo": "10000"
    },
    "ShipDateRange": "",
    "LastActivityDateRange": "12/01/2022 00:00:00 - 12/31/2022 23:59:59",
    "ShippingCarrier": "",
    "OrderNumbers": [],
    "Skip": 0,
    "Top": 100
  }'

Responses

OK

Bodyapplication/json
TransactionReferenceNumberstring
Example: "8a806bdb-49ee-4465-86a1-fa10e47d22a1"
LatestActivityTimestampstring

LastActivityTimestamp field represents the latest timestamp from the filtered timeframe. If no data is returned, it returns the latest timestamp in our dataset preceding the timeframe.

Example: "10/20/2024 21:09:53"
TotalRecordCountinteger(int32)
Example: 1
Skipinteger(int32)
Default 0
Example: 0
Topinteger(int32)
Example: 500
MoreRecordsboolean
Default false
PackagesArray of objects(Package)
Response
application/json
{
  "TransactionReferenceNumber": "8a806bdb-49ee-4465-86a1-fa10e47d22a1",
  "TotalRecordCount": 1,
  "Skip": 0,
  "Top": 500,
  "MoreRecords": false,
  "Packages": [
    { … }
  ]
}

Commerce

API Methods for carriers, expected delivery dates and addresses.

Operations