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": {
"shipmentId": "<string>",
"carrierCode": "<string>",
"carrierName": "<string>",
"carrierGroup": "<string>",
"trackingNumber": "<string>",
"trackingNumberUrl": "<string>",
"packageWeight": 123,
"deliveryStatusCode": "<string>",
"signedForBy": "<string>",
"deliveryDate": "2023-11-07T05:31:56Z",
"shipDate": "2023-11-07T05:31:56Z",
"returnDate": "2023-11-07T05:31:56Z",
"returnReason": "<string>",
"shipTo": {
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"stateCode": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"deliveryStatusCode": "<string>",
"deliveryStatusName": "<string>",
"isResidentialAddress": true,
"deliveryAddressTypeCode": "<string>",
"deliveryAddressTypeName": "<string>"
},
"deliverTo": {
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"stateCode": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"deliveryStatusCode": "<string>",
"deliveryStatusName": "<string>",
"isResidentialAddress": true,
"deliveryAddressTypeCode": "<string>",
"deliveryAddressTypeName": "<string>"
},
"vasOrderPersonalizations": [
{
"type": "<string>",
"lineNumber": 123,
"message": "<string>",
"options": [
{
"type": "<string>",
"option": "<string>",
"message": "<string>"
}
]
}
],
"lineItems": [
{
"shipmentId": "<string>",
"lineNumber": "<string>",
"componentNumber": 123,
"sku": "<string>",
"wineDirectSku": "<string>",
"description": "<string>",
"depletionDate": "2023-11-07T05:31:56Z",
"qtyShipped": 123,
"qtyOrdered": 123,
"qtyReturned": 123,
"qtyDamaged": 123,
"qtyMissing": 123,
"vasOrderPersonalizations": [
{
"type": "<string>",
"lineNumber": 123,
"message": "<string>",
"options": [
{
"type": "<string>",
"option": "<string>",
"message": "<string>"
}
]
}
]
}
]
}
}Gets a single shipment with detail
{
"isSuccess": true,
"message": "<string>",
"payload": {
"shipmentId": "<string>",
"carrierCode": "<string>",
"carrierName": "<string>",
"carrierGroup": "<string>",
"trackingNumber": "<string>",
"trackingNumberUrl": "<string>",
"packageWeight": 123,
"deliveryStatusCode": "<string>",
"signedForBy": "<string>",
"deliveryDate": "2023-11-07T05:31:56Z",
"shipDate": "2023-11-07T05:31:56Z",
"returnDate": "2023-11-07T05:31:56Z",
"returnReason": "<string>",
"shipTo": {
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"stateCode": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"deliveryStatusCode": "<string>",
"deliveryStatusName": "<string>",
"isResidentialAddress": true,
"deliveryAddressTypeCode": "<string>",
"deliveryAddressTypeName": "<string>"
},
"deliverTo": {
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"stateCode": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"deliveryStatusCode": "<string>",
"deliveryStatusName": "<string>",
"isResidentialAddress": true,
"deliveryAddressTypeCode": "<string>",
"deliveryAddressTypeName": "<string>"
},
"vasOrderPersonalizations": [
{
"type": "<string>",
"lineNumber": 123,
"message": "<string>",
"options": [
{
"type": "<string>",
"option": "<string>",
"message": "<string>"
}
]
}
],
"lineItems": [
{
"shipmentId": "<string>",
"lineNumber": "<string>",
"componentNumber": 123,
"sku": "<string>",
"wineDirectSku": "<string>",
"description": "<string>",
"depletionDate": "2023-11-07T05:31:56Z",
"qtyShipped": 123,
"qtyOrdered": 123,
"qtyReturned": 123,
"qtyDamaged": 123,
"qtyMissing": 123,
"vasOrderPersonalizations": [
{
"type": "<string>",
"lineNumber": 123,
"message": "<string>",
"options": [
{
"type": "<string>",
"option": "<string>",
"message": "<string>"
}
]
}
]
}
]
}
}Authorizations
Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'
Path Parameters
Response
Returns a shipment
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
The primary key of this shipment
The Carrier (Code)
The Carrier (Name)
Carrier's Group
The Carrier's Tracking Number
The URL, if exists, for the carrier's tracking number details
Weight in lbs
The status of the delivery (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."Who signed for the delivery
When the package was delivered
When the package was shipped
When/if the package was returned
The reason for the return
An address record for
Show child attributes
Show child attributes
First Name
Middle Name
Last Name
Company Name if Relevant
Address1
Address2
Address3
City
The State
Postal Code
Country
The status of the delivery (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 delivery (Name)
Is the address residential
The address type (Code)
The address type (Name)
An address record for
Show child attributes
Show child attributes
First Name
Middle Name
Last Name
Company Name if Relevant
Address1
Address2
Address3
City
The State
Postal Code
Country
The status of the delivery (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 delivery (Name)
Is the address residential
The address type (Code)
The address type (Name)
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 line items for shipment
Show child attributes
Show child attributes
The ID of the overall Shipment
The shipment line item's number (order)
The Component Number
The SKU of the customer
WineDirect's SKU
Description of the SKU
Date inventory was depleted from system.
The Qty Shipped
The Qty Ordered
The Qty Returned
The Qty Damaged
The Qty Missing
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
2000Was this page helpful?