Skip to main content
GET
/
api
/
v1
/
Orders
{
  "isSuccess": true,
  "message": "<string>",
  "payload": [
    {
      "accountNumber": "<string>",
      "supplierName": "<string>",
      "warehouseName": "<string>",
      "warehouseCode": "<string>",
      "wineDirectOrderNumber": "<string>",
      "orderNumber": "<string>",
      "orderTypeName": "<string>",
      "orderTypeCode": "<string>",
      "batchNumber": "<string>",
      "orderedDate": "2023-11-07T05:31:56Z",
      "requestedDate": "2023-11-07T05:31:56Z",
      "shipmentCount": 123,
      "returnCount": 123,
      "holdCount": 123,
      "firstShippedDate": "2023-11-07T05:31:56Z",
      "lastShippedDate": "2023-11-07T05:31:56Z",
      "statusCode": "<string>",
      "statusName": "<string>",
      "firstHoldName": "<string>",
      "carrierName": "<string>",
      "notificationEmail": "<string>",
      "shipToFirstName": "<string>",
      "shipToLastName": "<string>",
      "shipToCity": "<string>",
      "shipToStateCode": "<string>",
      "shipToPostalCode": "<string>",
      "shipToCompanyName": "<string>",
      "packagingTypeCode": "<string>",
      "packagingTypeName": "<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>

Start date range. Defaults to 30 days

​
searchEndDate
string<date-time>

End date range. Defaults to today

​
sku
string

Ordered Item Sku

​
batchNumber
string

Batch Number

Maximum string length: 120
​
orderTypeCode
string

The Type of Order (code)

"CLUB" - Club Order
"STND" - Daily Order
"SPCL" - Special Order
"VC"   - Visitor Center
"DAILY" - Daily Order
"SPECIAL" - Special Order
"CORP" - Corp Order
​
warehouseCode
string

The code for the warehouse

"GLW" - Glenwillow,
"WDI" - Green Island,
"PSO" - Paso Robles,
"SMA" - Santa Maria,
"SHW" - Willamette Valley
"DAL" - Dallas
​
deliveryStatusCode
string

The status of the order (Code)

'DELIVERED' - "The package has been delivered to the intended recipient."
'EXCEPTION' - "The last recorded activity for the package is a delivery exception.
'IN_TRANSIT'- "The package is in transit within the carrier network."
'RETURNED'  - "The package has been returned to the fulfillment center."
'SHIPPED'   - "The package has been shipped from the fulfillment center, but is not yet tracking in the carrier network."
​
holdName
string

The name of the hold. You can get this name from the Order Search page in the Fulfillment Portal. https://fulfillment.winedirect.com/orders/search

Maximum string length: 120
​
returnsOnlySearch
boolean
default:false
required

Search should include those orders with returns

​
includeClosed
boolean
default:false
required

Search should include those orders which are closed

​
lastName
string

Last Name

Maximum string length: 80
​
city
string

City

Maximum string length: 80
​
stateCode
string

The (US Address) state code

Maximum string length: 10
​
postalCode
string

Post Code

Maximum string length: 15

Response

200 - application/json

OK

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