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": {
"supplierId": "<string>",
"rowId": 123,
"supplierName": "<string>",
"warehouseCode": "<string>",
"warehouseName": "<string>",
"referenceNumber": "<string>",
"orderNumber": "<string>",
"submittedDate": "2023-11-07T05:31:56Z",
"deliveryMethodCode": "<string>",
"deliveryMethodName": "<string>",
"pickupSiteId": "<string>",
"pickupSiteCode": "<string>",
"pickupSiteLine1": "<string>",
"pickupSiteLine2": "<string>",
"pickupSiteCity": "<string>",
"pickupSiteStateCode": "<string>",
"pickupSitePostalCode": "<string>",
"pickupSiteCountryCode": "<string>",
"pickupSitePhone": "<string>",
"pickupSiteFax": "<string>",
"expectedDate": "2023-11-07T05:31:56Z",
"statusCode": "<string>",
"statusName": "<string>",
"closedDate": "2023-11-07T05:31:56Z",
"notificationStatusCode": "<string>",
"notificationStatusName": "<string>",
"notificationStatusMessage": "<string>",
"isCancellable": true,
"isEditable": true,
"creationDate": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastUpdateDate": "2023-11-07T05:31:56Z",
"lastUpdatedBy": "<string>"
},
"lineItems": [
{
"supplierId": "<string>",
"headerRowId": "<string>",
"orderNumber": "<string>",
"lineNumber": 123,
"inventoryItemId": "<string>",
"wineDirectSku": "<string>",
"sku": "<string>",
"skuDescription": "<string>",
"qtyOrdered": 123,
"qtyReceived": 123,
"subInventoryCode": "<string>",
"subInventoryName": "<string>",
"creationDate": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastUpdateDate": "2023-11-07T05:31:56Z",
"lastUpdatedBy": "<string>"
}
],
"notes": [
{
"supplierId": "<string>",
"orderNumber": "<string>",
"typeCode": "<string>",
"noteTimestamp": "2023-11-07T05:31:56Z",
"noteText": "<string>",
"creationDate": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastUpdateDate": "2023-11-07T05:31:56Z",
"lastUpdatedBy": "<string>"
}
]
}
}Gets the details about a specific inventory-in orders within the WineDirect fulfillment system
{
"isSuccess": true,
"message": "<string>",
"payload": {
"header": {
"supplierId": "<string>",
"rowId": 123,
"supplierName": "<string>",
"warehouseCode": "<string>",
"warehouseName": "<string>",
"referenceNumber": "<string>",
"orderNumber": "<string>",
"submittedDate": "2023-11-07T05:31:56Z",
"deliveryMethodCode": "<string>",
"deliveryMethodName": "<string>",
"pickupSiteId": "<string>",
"pickupSiteCode": "<string>",
"pickupSiteLine1": "<string>",
"pickupSiteLine2": "<string>",
"pickupSiteCity": "<string>",
"pickupSiteStateCode": "<string>",
"pickupSitePostalCode": "<string>",
"pickupSiteCountryCode": "<string>",
"pickupSitePhone": "<string>",
"pickupSiteFax": "<string>",
"expectedDate": "2023-11-07T05:31:56Z",
"statusCode": "<string>",
"statusName": "<string>",
"closedDate": "2023-11-07T05:31:56Z",
"notificationStatusCode": "<string>",
"notificationStatusName": "<string>",
"notificationStatusMessage": "<string>",
"isCancellable": true,
"isEditable": true,
"creationDate": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastUpdateDate": "2023-11-07T05:31:56Z",
"lastUpdatedBy": "<string>"
},
"lineItems": [
{
"supplierId": "<string>",
"headerRowId": "<string>",
"orderNumber": "<string>",
"lineNumber": 123,
"inventoryItemId": "<string>",
"wineDirectSku": "<string>",
"sku": "<string>",
"skuDescription": "<string>",
"qtyOrdered": 123,
"qtyReceived": 123,
"subInventoryCode": "<string>",
"subInventoryName": "<string>",
"creationDate": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastUpdateDate": "2023-11-07T05:31:56Z",
"lastUpdatedBy": "<string>"
}
],
"notes": [
{
"supplierId": "<string>",
"orderNumber": "<string>",
"typeCode": "<string>",
"noteTimestamp": "2023-11-07T05:31:56Z",
"noteText": "<string>",
"creationDate": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastUpdateDate": "2023-11-07T05:31:56Z",
"lastUpdatedBy": "<string>"
}
]
}
}Authorizations
Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'
Path Parameters
SupplierId is the unique ID for the owner of items in the system
The order number of the IN. You can get this from the GET /INs call
Response
OK
Generic container for all service responses
Was the request successful. If not, the message will have more information.
Any error message
Show child attributes
Show child attributes
Show child attributes
Show child attributes
SupplierId is the unique ID for the owner of items in the system
2The ID of this Inventory Item
The name of the owner
The warehouse (Code)
"GLW" - Glenwillow,
"WDI" - Green Island,
"PSO" - Paso Robles,
"SMA" - Santa Maria,
"SHW" - Willamette Valley
"DAL" - DallasThe warehouse this transfer is going to
Glenwillow, Green Island, Paso Robles, Santa Maria, Willamette Valley
The reference number of this item
The order number of this item
The date the item was submitted
The delivery method of this item (Code)
The delivery method of this item (Name)
Pickup Site: ID
Pickup Site: Code
Pickup Site: Address Line 1
Pickup Site: Address Line 2
Pickup Site: Address City
Pickup Site: Address State
Pickup Site: Address Postal Code
Pickup Site: Address Country
Pickup Site: Address Phone
Pickup Site: Address Fax
The expected date of this item
The item's status (Code)
The item's status (Name)
The date the item was closed
The notification status (Code)
The notification status (Name)
The notification status (Message)
Is the item cancellable
Is the item editable
When was the item created
Who created the item
When last update
Who last updated
Line items defining details about an Inventory IN
Show child attributes
Show child attributes
SupplierId is the unique ID for the owner of items in the system
2The ID of the parent header
The Order Number
The line item number, the "order" of the line
The Inventory Item's RowId
WineDirect's SKU
The SKU of the customer
Description of the SKU
The Qty Ordered
The Qty Received
The Sub Inventory this inventory is in (Code)
The Sub Inventory this inventory is in (Name)
When was the item created
Who created the item
When last update
Who last updated
Notes about about an Inventory IN
Show child attributes
Show child attributes
SupplierId is the unique ID for the owner of items in the system
2The Order Number
The type of note
When
The text
When was the item created
Who created the item
When last update
Who last updated
Was this page helpful?