Skip to main content
PATCH
/
api
/
v1
/
Orders
/
BulkOrderUpdate
Queues a list of orders to be updated with new properties.
curl --request PATCH \
  --url https://api.example.com/api/v1/Orders/BulkOrderUpdate \
  --header 'Authorization: <api-key>'
{
  "isSuccess": true,
  "message": "<string>",
  "payload": [
    {
      "isSuccessful": true,
      "message": "<string>",
      "notAllowed": true,
      "notFound": true,
      "errorCode": "<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
​
notificationEmail
string

The notification email

​
bulkOrderUpdateIds
string[]
required

The Ids of the Bulk Order Update Item to update

​
warehouseCode
string

The warehouse (Code)

"GLW" - Glenwillow,
"WDI" - Green Island,
"PSO" - Paso Robles,
"SMA" - Santa Maria,
"SHW" - Willamette Valley
"DAL" - Dallas
​
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
​
requestedDate
string<date-time>

The date requested by the consumer when they would like it shipped

​
serviceLevel
string

The service level

​
notificationTemplateId
integer<int32>

The ID code of the notification

​
packingSlipTemplateId
integer<int32>

The ID code of the packing slip

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