Skip to main content
GET
/
api
/
v1
/
Shipments
/
Updates
Gets a list of Shipment Updates
curl --request GET \
  --url https://api.example.com/api/v1/Shipments/Updates \
  --header 'Authorization: <api-key>'
{
  "isSuccess": true,
  "message": "<string>",
  "payload": [
    {
      "header": {
        "containerId": "<string>",
        "orderNumber": "<string>",
        "shipDate": "2023-11-07T05:31:56Z",
        "carrierName": "<string>",
        "trackingNumber": "<string>",
        "trackingNumberUrl": "<string>",
        "statusCode": "<string>",
        "statusDescription": "<string>"
      },
      "lineItems": [
        {
          "containerId": "<string>",
          "lineNumber": 123,
          "sku": "<string>",
          "quantity": 123
        }
      ],
      "events": [
        {
          "containerId": "<string>",
          "eventTime": "2023-11-07T05:31:56Z",
          "city": "<string>",
          "stateOrProvince": "<string>",
          "description": "<string>"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'

Query Parameters

​
accountNumber
string
required

AccountNumber is the unique Customer ID in the WineDirect system.

Minimum string length: 2
​
searchStartDate
string<date-time>
required

The beginning date of the search range with time

YYYY-MM-DDTHH:mm  eg 2023-05-30T16:59   (PST)
or
YYYY-MM-DD  eg 2023-05-30   (PST)
​
searchEndDate
string<date-time>
required

The ending date of the search range

YYYY-MM-DDTHH:mm  eg 2023-05-30T16:59   (PST)
or
YYYY-MM-DD  eg 2023-05-30   (PST)
​
shipmentId
string

The shipment container ID

Response

200 - application/json

A list of shipment updates

Generic container for all service responses

​
isSuccess
boolean

Was the request successful. If not, the message will have more information.

​
message
string | null

Any error message

​
payload
object[] | null

The payload object of the response