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": {
"notifications": [
{
"message": "<string>",
"kind": "NotSet",
"sourceOfNotification": "<string>"
}
],
"isSuccess": true,
"isWarning": true
}
}Uploads many orders all at once in a batch into a queue which can take 15 minutes to process.
This functionality closely mirrors the WineDirect Portal’s Bulk Upload. Please visit:
https://fulfillment.winedirect.com/orders/upload for more details
{
"isSuccess": true,
"message": "<string>",
"payload": {
"notifications": [
{
"message": "<string>",
"kind": "NotSet",
"sourceOfNotification": "<string>"
}
],
"isSuccess": true,
"isWarning": true
}
}Authorizations
Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'
Body
Detail about a group of orders to import
Account number that is connected to the customer account the request is related to. The account number is assigned by WineDirect during onboarding.
1The importer's password
An identifier that is shared among a group of orders. Often used to identify a specific club batch. If not submitted the system will automatically assign a unique BatchId for each request. The assigned batch id is based on a time stamp
240Detail about the orders to import
Show child attributes
Show child attributes
The order identifier from the submitting system.
1 - 80Order type being submitted, this identifier can be used to determine a distinct notification email to trigger, subinventory to pull order from and packing slip to be used with the order
"CLUB" - Club Order
"STND" - Daily Order
"SPCL" - Special Order
"VC" - Visitor Center
"DAILY" - Daily Order
"SPECIAL" - Special Order
"CORP" - Corp Order
The Special order type trigger special handling by operations and will also incur additional fees, this is used for order customization or special programs.1Flag to indicate if the purchase was made in person at the winery location. On Site purchases allow different compliance and shipping rules in a few states
Shipping Priority, AKA ServiceLevel, for Order in caps - for example:
FEDGROUND
FEX
UPS2DAY
UPSOVERNIGHT
UP1
UPSOVRNGHT
V55
UPSGROUND1Amount charged to the Consumer for Handling OR Shipping and Handling as one total (may be 0 or a negative number for a reduced price).
NOT REQUIRED if just calling is "Shipping", then total can be listed in the field ConsumerShippingCharge only.Amount charged to the Consumer for Shipping (may be 0), which is non-taxable. If combined as one total with Handling, then the total amount is taxable.
Applicable Sales Tax Amount charged to the Consumer. Must be calculated prior to deducting the Rebate amount. This value will be verified and may be re-calculated by WineDirect Fulfillment
Total amount charged to the end Consumer. Must equal the sum of all SKU sub-totals and all other charges minus the Rebate. This value is verified and may be re-calculated by WineDirect Fulfillment.
A standard Address object
Show child attributes
Show child attributes
8080808080808080222222Future ship date. Enter the date you want the order to be processed. We will hold the orders until that date.
eg 2023-12-15The warehouse (Code) Warehouse Code will override the "Warehouse Selection Rules" configured for each customer. If Warehouse is left Null, The 'Warehouse Selection Rule' logic will define warehouse selection on a destination state basis
"GLW" - Glenwillow,
"WDI" - Green Island,
"PSO" - Paso Robles,
"SMA" - Santa Maria,
"SHW" - Willamette Valley
"DAL" - DallasSubinventory to assign the order to pull inventory from, typical values are
SHIP - Primary
CLUB - ClubHowever subinventories can be configured for specific programs and customers and are configured by WineDirect. The value is typically not sent on an order but is system assigned based on the order type, most accounts use only the SHIP subinventory
80Place holder for assigning a specific email notification template to an order, not yet implemented
80Code used to assign a specific packing slip template to be used for the order. Codes are assigned in the packing slip template design process via the portal
80Message to Specialist to take action on the order. If populated, it will stop the order from processing until actions are completed.
1000Message to be printed on the bottom of the packing slip that is printed for the order. The string does not support formatting characters or newline. The string is limited to 1000 characters but the actual limit that will not overprint other packing slip elements varies with the packing slip design
2000A reference field that can be submitted with an order and used in the GetOrderStatus to retrieve the order
239A reference field that can be submitted with an order and used in the GetOrderStatus to retrieve the order
239A reference field that can be submitted with an order and used in the GetOrderStatus to retrieve the order
239Insurance charged for this order
Value added service personalizations
Show child attributes
Show child attributes
1 - 80The line number of the SKU this personalization is assigned to. Not required for order header
Messaging about the set of value added services
2000A collection of specific value added services
Show child attributes
Show child attributes
The type of the value added service. Eg a ribbon
1 - 80An option applied to the type. eg the color of the type's ribbon.
80Messaging about the value added service
2000The line items to ship (1-18 max)
Show child attributes
Show child attributes
The line number of this item
1Customer's SKU - Item order for the line being submitted
1Quantity of items ordered for the line being submitted
Price charged to the end Consumer, per SKU. In price posting states for wine, the amount must equal that posted. It will be verified by WineDirect Fulfillment and corrected if necessary.
Value added service personalizations
Show child attributes
Show child attributes
1 - 80The line number of the SKU this personalization is assigned to. Not required for order header
Messaging about the set of value added services
2000A collection of specific value added services
Show child attributes
Show child attributes
The type of the value added service. Eg a ribbon
1 - 80An option applied to the type. eg the color of the type's ribbon.
80Messaging about the value added service
2000A standard Address object
Show child attributes
Show child attributes
80808080808080802102A standard Address object
Show child attributes
Show child attributes
80808080808080802102Indicates the type of delivery address being submitted, currently the only supported carrier is FEDEX or UPS
FEDEX_LOCATION : for HAL addresses.
UPS_ACCESSPOINT : for UPS Access Point addresses.Submitting system sold to record identifier.
80Ship-To Consumer ID
80If a FedEx Hold at Location (HAL) address is submitted the corresponding LocationID from the FindFedExLocations service should submitted in this element.
SEE: DeliveryAddress_Type80Submitting system deliver to record identifier.
80Phone (no extensions listed)
80Phone (no extensions listed)
80Phone (no extensions listed)
80240240240Response
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
What happened, good or bad
Show child attributes
Show child attributes
Was this page helpful?