API Documentation
AccessToken
Inventories
Orders
- GETGets multiple orders.
- GETGets a single order based on the order number.
- PATCHUpdates an existing order.
- GETGets the full detail about an order
- DELDeletes/Cancels an existing order.
- POSTUploads many orders all at once in a batch into a queue which can take 15 minutes to process.
- GETGets a list orders on hold which can be updated via the Bulk Update endpoint
- PATCHQueues a list of orders to be updated with new properties.
- GETGets a list of order statuses in the WineDirect interface system
- POSTGets a list of packing slips based on a list of IDs
- GETGets a list of packing slips for an AccountNumber
- GETGets a packing slip
Products
- GETGets full product detail.
- DELDeletes a Product
- GETSearch for products that you are able to sell from the fulfillment system.
- GETSearch for products that you supply to the fulfillment system.
- POSTCreates a Wine Product
- PATCHUpdates a Wine Product
- POSTCreates a Non Wine Product
- PATCHUpdates a Non Wine Product
- POSTCreates a Bom Product
- PATCHUpdates a Bom Product
Shipments
Transfers
- GETGets a single Inter-Center Transfer
- GETQuery the Inter-Center Transfer system for transfers
- PUTCreate an inter-warehouse Transfer.
- GETGets a list of inventory-in orders within the WineDirect fulfillment system
- POSTCreates a new Inventory-IN request ready to be Submitted in a subsequent step
- DELCancels an Inventory-IN request to be processed by WineDirect
- PATCHSubmits an Inventory-IN request to be processed by WineDirect
- GETGets the details about a specific inventory-in orders within the WineDirect fulfillment system
- POSTGets a list of inventory-out orders within the WineDirect fulfillment system
- GETGets a detailed of a specific inventory-out in the WineDirect fulfillment system
- DELCancels specific inventory-out in the WineDirect fulfillment system
- POSTCreate and submit an inventory OUT in the WineDirect fulfillment system
{
"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>"
}
}Gets a single order based on the order number.
Use the GET /Orders/Detail endpoint for a full detailed order
{
"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
Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'
Path Parameters
Either Order Number or WineDirect Order Number
Response
OK
Generic container for all service responses
Was the request successful. If not, the message will have more information.
Any error message
Header information about an order often used in grids and lists.
Show child attributes
Show child attributes
AccountNumber is the unique Customer ID in the WineDirect system.
1SupplierName is the unique name for the owner of items in the system
1The warehouse (Name)
The warehouse (Code)
"GLW" - Glenwillow, "WDI" - Green Island, "PSO" - Paso Robles, "SMA" - Santa Maria, "SHW" - Willamette Valley "DAL" - Dallas
The order number of WineDirect
The order number of the customer
The Type of Order (Name)
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 OrderThe batch number containing this order
The date ordered
The date requested
How many shipments to fulfill this order
How many were returned
How many holds
The date the first shipment went out
The date the last shipment went out
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."The status of the order (Name)
If there were holds, what was the first name
The name of the carrier
The notification email
Ship To: First Name
Ship To: Last Name
Ship To: City
Ship To: State (Code)
Ship To: Postal/Zip (Code)
Ship To: Company, if applicable
The Packaging Type (Code)
eg COOLPACKThe Packaging Type (Name)
eg COOLPACKWas this page helpful?