Skip to main content
GET
Gets a list orders on hold which can be updated via the Bulk Update endpoint

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
orderTypeCode
string

The Type of Order (code)

serviceLevel
string

The service level

notificationTemplateId
integer<int32>

The ID code of the notification

packingSlipTemplateId
integer<int32>

The ID code of the packing slip

searchStartDate
string<date-time>

The beginning date of the search range

searchEndDate
string<date-time>

The ending date of the search range

warehouseCode
string

The warehouse (Code)

stateCode
string

The (US Address) state code

batchNumber
string

The batch number containing this order

holdName
string

The name of the hold

Response

200 - application/json

Returns the list of orders

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