Skip to main content
GET
Gets a list of shipments

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>

The beginning date of the search range. Omit if you are specifying an order number

searchEndDate
string<date-time>

The ending date of the search range. Omit if you are specifying an order number

deliveryStatusCode
string

The status of the delivery (Code) Omit if you are specifying an order number

orderNumber
string

The order number of the customer. Do not include date ranges if you include the order number.

Response

200 - application/json

Returns the list of shipments

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