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": {
"header": {
"accountNumber": "<string>",
"supplierId": "<string>",
"supplierName": "<string>",
"warehouseCode": "<string>",
"warehouseName": "<string>",
"orderNumber": "<string>",
"referenceNumber": "<string>",
"orderedDate": "2023-11-07T05:31:56Z",
"requestedPriority": "<string>",
"requestDate": "2023-11-07T05:31:56Z",
"statusCode": "<string>",
"status": "<string>",
"deliveryMethodCode": "<string>",
"deliveryMethod": "<string>"
},
"lineItems": [
{
"lineNumber": "<string>",
"sku": "<string>",
"skuDescription": "<string>",
"subInventoryCode": "<string>",
"subInventoryName": "<string>",
"quantityOrdered": 123,
"quantityReserved": 123,
"quantityShipped": 123
}
],
"messages": [
{
"messageType": "<string>",
"messageTime": "2023-11-07T05:31:56Z",
"message": "<string>"
}
],
"isEditable": true
}
}Gets a detailed of a specific inventory-out in the WineDirect fulfillment system
{
"isSuccess": true,
"message": "<string>",
"payload": {
"header": {
"accountNumber": "<string>",
"supplierId": "<string>",
"supplierName": "<string>",
"warehouseCode": "<string>",
"warehouseName": "<string>",
"orderNumber": "<string>",
"referenceNumber": "<string>",
"orderedDate": "2023-11-07T05:31:56Z",
"requestedPriority": "<string>",
"requestDate": "2023-11-07T05:31:56Z",
"statusCode": "<string>",
"status": "<string>",
"deliveryMethodCode": "<string>",
"deliveryMethod": "<string>"
},
"lineItems": [
{
"lineNumber": "<string>",
"sku": "<string>",
"skuDescription": "<string>",
"subInventoryCode": "<string>",
"subInventoryName": "<string>",
"quantityOrdered": 123,
"quantityReserved": 123,
"quantityShipped": 123
}
],
"messages": [
{
"messageType": "<string>",
"messageTime": "2023-11-07T05:31:56Z",
"message": "<string>"
}
],
"isEditable": true
}
}Authorizations
Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'
Path Parameters
The reference number used to create the OUT
Response
OK
Generic container for all service responses
Was the request successful. If not, the message will have more information.
Any error message
Complete Detail about the OUT
Show child attributes
Show child attributes
The header detail about the OUT
Show child attributes
Show child attributes
AccountNumber is the unique Customer ID in the WineDirect system.
2SupplierId is the unique ID for the owner of items in the system
2The name of the saupplier
The warehouse (Code)
"GLW" - Glenwillow,
"WDI" - Green Island,
"PSO" - Paso Robles,
"SMA" - Santa Maria,
"SHW" - Willamette Valley
"DAL" - DallasThe name of the warehouse
The OUT's order number
The reference number assigned by the supplier when creating the OUT
Date ordered
The requested priority
The requested date
The status (code)
The Status (Name)
The way this items is delivered (Code)
WD_PICKUP
CLIENT_DROPOFFThe delivery method (Name)
The SKU line items for this OUT
Show child attributes
Show child attributes
The Line Number
The SKU of the customer
Description of the sku
The Sub Inventory this inventory is in (Code)
The Sub Inventory this inventory is in (Name)
Quantity Ordered
Quantity Reserved
Quantity Shipped
Is the OUT editable
Was this page helpful?