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
Copy
Ask AI
{
"isSuccess": true,
"message": "<string>",
"payload": [
{
"packingSlipId": 123,
"packingSlipName": "<string>",
"orderingCode": "<string>",
"orderingName": "<string>",
"layoutCode": "<string>",
"layoutName": "<string>",
"useBrandLogo": true,
"imageData": "aSDinaTvuI8gbWludGxpZnk=",
"marketingMessage": "<string>",
"creationDate": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastUpdateDate": "2023-11-07T05:31:56Z",
"lastUpdatedBy": "<string>"
}
]
}Orders
Gets a list of packing slips based on a list of IDs
POST
/
api
/
v1
/
Orders
/
PackingSlips
/
Bulk
Copy
Ask AI
{
"isSuccess": true,
"message": "<string>",
"payload": [
{
"packingSlipId": 123,
"packingSlipName": "<string>",
"orderingCode": "<string>",
"orderingName": "<string>",
"layoutCode": "<string>",
"layoutName": "<string>",
"useBrandLogo": true,
"imageData": "aSDinaTvuI8gbWludGxpZnk=",
"marketingMessage": "<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'
Body
application/json
A request to get a list of packing slips
The list of IDs, numbers, of the packing slips
Response
200 - application/json
Returns the list of packing Slips
Generic container for all service responses
Was the request successful. If not, the message will have more information.
Any error message
The payload object of the response
Show child attributes
Show child attributes
The ID of the packing slip in the system
The name of the packing slip
The ordering code of the packing slip
The ordering name of the packing slip
Eg 'IMAGE_4X4_TOPLEFT'
The name of the layout
If a Branding Logo is provided
The BASE64 PNG or JPG image data for the branding logo
The marketing message to display
Creation Date
Creator
Updated Date
Updater
Was this page helpful?
Gets a list of order statuses in the WineDirect interface systemGets a list of packing slips for an AccountNumber
⌘I