{
"isSuccess": true,
"message": "<string>",
"payload": {
"header": {
"accountNumber": "<string>",
"customerName": "<string>",
"warehouseCode": "<string>",
"warehouseName": "<string>",
"wineDirectOrderNumber": "<string>",
"orderNumber": "<string>",
"receivedDate": "2023-11-07T05:31:56Z",
"creationDate": "2023-11-07T05:31:56Z",
"customerOrderDate": "2023-11-07T05:31:56Z",
"requestedShipDate": "2023-11-07T05:31:56Z",
"fulfillmentDate": "2023-11-07T05:31:56Z",
"shippedDate": "2023-11-07T05:31:56Z",
"batchNumber": "<string>",
"orderTypeCode": "<string>",
"orderTypeName": "<string>",
"requestedServiceLevel": "<string>",
"plannedServiceLevel": "<string>",
"orderStatusCode": "<string>",
"orderStatusName": "<string>",
"collapsedStatus": "<string>",
"notificationEmail": "<string>",
"notificationPhone": "<string>",
"giftMessage": "<string>",
"shippingInstructions": "<string>",
"complianceRoute": "<string>",
"fulfillmentRoute": "<string>",
"packingSlipCode": "<string>",
"packingSlipName": "<string>",
"isOnsitePurchase": true,
"isLineHaul": true,
"isEditable": true,
"isCancellable": true,
"isBackOrdered": true,
"hasInventoryHold": true,
"slaStatusCode": "<string>",
"slaStatusName": "<string>",
"slaDate": "2023-11-07T05:31:56Z",
"notificationTemplateCode": "<string>",
"notificationTemplateName": "<string>",
"packagingTypeCode": "<string>",
"packagingTypeName": "<string>",
"vasOrderPersonalizations": [
{
"type": "<string>",
"lineNumber": 123,
"message": "<string>",
"options": [
{
"type": "<string>",
"option": "<string>",
"message": "<string>"
}
]
}
]
},
"holds": [
{
"holdStatus": "<string>",
"holdName": "<string>",
"holdDescription": "<string>",
"expirationDate": "2023-11-07T05:31:56Z",
"creationDate": "2023-11-07T05:31:56Z",
"holdComment": "<string>",
"releaseDate": "2023-11-07T05:31:56Z",
"releaseReason": "<string>",
"releaseComment": "<string>",
"isDirectlyReleasable": true
}
],
"messages": [
{
"messageType": "<string>",
"messageTime": "2023-11-07T05:31:56Z",
"message": "<string>"
}
],
"soldToConsumers": [
{
"isResidentialAddress": true,
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"stateCode": "<string>",
"stateName": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"deliveryStatusCode": "<string>",
"deliveryStatusName": "<string>",
"deliveryAddressTypeCode": "<string>"
}
],
"shipToConsumers": [
{
"isResidentialAddress": true,
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"stateCode": "<string>",
"stateName": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"deliveryStatusCode": "<string>",
"deliveryStatusName": "<string>",
"deliveryAddressTypeCode": "<string>",
"deliveryAddressTypeName": "<string>"
}
],
"deliverToConsumers": [
{
"isResidentialAddress": true,
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"stateCode": "<string>",
"stateName": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"deliveryStatusCode": "<string>",
"deliveryStatusName": "<string>",
"deliveryAddressTypeCode": "<string>",
"deliveryAddressTypeName": "<string>"
}
],
"lineItems": [
{
"lineNumber": "<string>",
"componentNumber": "<string>",
"inventoryItemId": "<string>",
"sku": "<string>",
"description": "<string>",
"isShippable": true,
"quantityOrdered": 123,
"uom": "<string>",
"unitPrice": 123,
"subInventoryCode": "<string>",
"subInventoryName": "<string>",
"quantityReserved": 123,
"quantityShipped": 123,
"isBomComponent": true,
"itemShortage": 123,
"vasOrderPersonalizations": [
{
"type": "<string>",
"lineNumber": 123,
"message": "<string>",
"options": [
{
"type": "<string>",
"option": "<string>",
"message": "<string>"
}
]
}
]
}
],
"packages": [
{
"shipmentKey": "<string>",
"shipperOfRecord": "<string>",
"carrierName": "<string>",
"shipDate": "2023-11-07T05:31:56Z",
"trackingNumber": "<string>",
"carrierHttpLink": "<string>",
"packageWeight": 123,
"deliveryStatusName": "<string>",
"deliveryDate": "2023-11-07T05:31:56Z",
"exceptionCount": 123,
"returnDate": "2023-11-07T05:31:56Z",
"returnReason": "<string>",
"emailProcessMessage": "<string>"
}
],
"contents": [
{
"shipmentKey": "<string>",
"sku": "<string>",
"description": "<string>",
"quantityOrdered": 123,
"quantityShipped": 123,
"quantityReturned": 123,
"quantityDamaged": 123,
"quantityMissing": 123
}
],
"trackings": [
{
"shipmentKey": "<string>",
"eventDate": "2023-11-07T05:31:56Z",
"eventCity": "<string>",
"eventState": "<string>",
"eventPostalCode": "<string>",
"eventCode": "<string>",
"eventName": "<string>",
"isException": true,
"eventComments": "<string>"
}
],
"notes": [
{
"shipmentKey": "<string>",
"notes": "<string>"
}
],
"billings": [
{
"invoicingDate": "2023-11-07T05:31:56Z",
"printedInvoiceNumber": "<string>",
"lineNumber": "<string>",
"invoiceNumber": "<string>",
"description": "<string>",
"lineQuantity": 123,
"lineSubtotal": 123
}
],
"accountPayableHeaders": [
{
"invoiceKey": "<string>",
"invoiceNum": "<string>",
"payTo": "<string>",
"description": "<string>",
"invoiceAmount": 123
}
],
"accountPayableLines": [
{
"invoiceKey": "<string>",
"lineNumber": "<string>",
"sku": "<string>",
"paymentType": "<string>",
"paymentAmount": 123
}
]
}
}{
"isSuccess": true,
"message": "<string>",
"payload": {
"header": {
"accountNumber": "<string>",
"customerName": "<string>",
"warehouseCode": "<string>",
"warehouseName": "<string>",
"wineDirectOrderNumber": "<string>",
"orderNumber": "<string>",
"receivedDate": "2023-11-07T05:31:56Z",
"creationDate": "2023-11-07T05:31:56Z",
"customerOrderDate": "2023-11-07T05:31:56Z",
"requestedShipDate": "2023-11-07T05:31:56Z",
"fulfillmentDate": "2023-11-07T05:31:56Z",
"shippedDate": "2023-11-07T05:31:56Z",
"batchNumber": "<string>",
"orderTypeCode": "<string>",
"orderTypeName": "<string>",
"requestedServiceLevel": "<string>",
"plannedServiceLevel": "<string>",
"orderStatusCode": "<string>",
"orderStatusName": "<string>",
"collapsedStatus": "<string>",
"notificationEmail": "<string>",
"notificationPhone": "<string>",
"giftMessage": "<string>",
"shippingInstructions": "<string>",
"complianceRoute": "<string>",
"fulfillmentRoute": "<string>",
"packingSlipCode": "<string>",
"packingSlipName": "<string>",
"isOnsitePurchase": true,
"isLineHaul": true,
"isEditable": true,
"isCancellable": true,
"isBackOrdered": true,
"hasInventoryHold": true,
"slaStatusCode": "<string>",
"slaStatusName": "<string>",
"slaDate": "2023-11-07T05:31:56Z",
"notificationTemplateCode": "<string>",
"notificationTemplateName": "<string>",
"packagingTypeCode": "<string>",
"packagingTypeName": "<string>",
"vasOrderPersonalizations": [
{
"type": "<string>",
"lineNumber": 123,
"message": "<string>",
"options": [
{
"type": "<string>",
"option": "<string>",
"message": "<string>"
}
]
}
]
},
"holds": [
{
"holdStatus": "<string>",
"holdName": "<string>",
"holdDescription": "<string>",
"expirationDate": "2023-11-07T05:31:56Z",
"creationDate": "2023-11-07T05:31:56Z",
"holdComment": "<string>",
"releaseDate": "2023-11-07T05:31:56Z",
"releaseReason": "<string>",
"releaseComment": "<string>",
"isDirectlyReleasable": true
}
],
"messages": [
{
"messageType": "<string>",
"messageTime": "2023-11-07T05:31:56Z",
"message": "<string>"
}
],
"soldToConsumers": [
{
"isResidentialAddress": true,
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"stateCode": "<string>",
"stateName": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"deliveryStatusCode": "<string>",
"deliveryStatusName": "<string>",
"deliveryAddressTypeCode": "<string>"
}
],
"shipToConsumers": [
{
"isResidentialAddress": true,
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"stateCode": "<string>",
"stateName": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"deliveryStatusCode": "<string>",
"deliveryStatusName": "<string>",
"deliveryAddressTypeCode": "<string>",
"deliveryAddressTypeName": "<string>"
}
],
"deliverToConsumers": [
{
"isResidentialAddress": true,
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"stateCode": "<string>",
"stateName": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"deliveryStatusCode": "<string>",
"deliveryStatusName": "<string>",
"deliveryAddressTypeCode": "<string>",
"deliveryAddressTypeName": "<string>"
}
],
"lineItems": [
{
"lineNumber": "<string>",
"componentNumber": "<string>",
"inventoryItemId": "<string>",
"sku": "<string>",
"description": "<string>",
"isShippable": true,
"quantityOrdered": 123,
"uom": "<string>",
"unitPrice": 123,
"subInventoryCode": "<string>",
"subInventoryName": "<string>",
"quantityReserved": 123,
"quantityShipped": 123,
"isBomComponent": true,
"itemShortage": 123,
"vasOrderPersonalizations": [
{
"type": "<string>",
"lineNumber": 123,
"message": "<string>",
"options": [
{
"type": "<string>",
"option": "<string>",
"message": "<string>"
}
]
}
]
}
],
"packages": [
{
"shipmentKey": "<string>",
"shipperOfRecord": "<string>",
"carrierName": "<string>",
"shipDate": "2023-11-07T05:31:56Z",
"trackingNumber": "<string>",
"carrierHttpLink": "<string>",
"packageWeight": 123,
"deliveryStatusName": "<string>",
"deliveryDate": "2023-11-07T05:31:56Z",
"exceptionCount": 123,
"returnDate": "2023-11-07T05:31:56Z",
"returnReason": "<string>",
"emailProcessMessage": "<string>"
}
],
"contents": [
{
"shipmentKey": "<string>",
"sku": "<string>",
"description": "<string>",
"quantityOrdered": 123,
"quantityShipped": 123,
"quantityReturned": 123,
"quantityDamaged": 123,
"quantityMissing": 123
}
],
"trackings": [
{
"shipmentKey": "<string>",
"eventDate": "2023-11-07T05:31:56Z",
"eventCity": "<string>",
"eventState": "<string>",
"eventPostalCode": "<string>",
"eventCode": "<string>",
"eventName": "<string>",
"isException": true,
"eventComments": "<string>"
}
],
"notes": [
{
"shipmentKey": "<string>",
"notes": "<string>"
}
],
"billings": [
{
"invoicingDate": "2023-11-07T05:31:56Z",
"printedInvoiceNumber": "<string>",
"lineNumber": "<string>",
"invoiceNumber": "<string>",
"description": "<string>",
"lineQuantity": 123,
"lineSubtotal": 123
}
],
"accountPayableHeaders": [
{
"invoiceKey": "<string>",
"invoiceNum": "<string>",
"payTo": "<string>",
"description": "<string>",
"invoiceAmount": 123
}
],
"accountPayableLines": [
{
"invoiceKey": "<string>",
"lineNumber": "<string>",
"sku": "<string>",
"paymentType": "<string>",
"paymentAmount": 123
}
]
}
}Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'
OK
Generic container for all service responses
Was the request successful. If not, the message will have more information.
Any error message
A fully detailed order
Show child attributes
Show child attributes
AccountNumber is the unique Customer ID in the WineDirect system.
Customer Name
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 order number of WineDirect
The order number of the customer
Received Date
Creation Date
Customer Order Date
Future ship date. Enter the date you want the order to be processed. We will hold the orders until that date.
eg 2023-12-15Fulfillment Date
Shipped Date
Batch Number
The Type of Order (code)
"CLUB" - Club Order
"STND" - Daily Order
"SPCL" - Special Order
"VC" - Visitor Center
"DAILY" - Daily Order
"SPECIAL" - Special Order
"CORP" - Corp OrderThe Type of Order (Name)
The service level that was requested
The planned service level
The status of the order (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 Order (Name)
Collapsed Status
Notification Email
Notification Phone
Gift Message
Shipping Instructions
The Compliance Route
The Fulfillment Route
The Packing Slip (Code)
The Packing Slip (Name)
Is an OnSite purchase
Is a Line Haul
Is Editable
Is Cancellable
Is the order backordered
Has Inventory Hold
Service Level Agreement (Code)
Service Level Agreement (Name)
Service Level Agreement Date
Notification Template Code
Notification Template Name
The Packaging Type (Code)
eg COOLPACKThe Packaging Type (Name)
eg COOLPACKA list of value added services for this order
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
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
2000Holds
Show child attributes
Hold Status
Hold Name
Hold Description
Expiratio nDate
Creation Date
Hold Comment
Release Date
Release Reason
Release Comment
Is Directly Releasable
The customers(s) Sold To
Show child attributes
Is Residential Address
First Name
Middle Name
Last Name
Company Name, if applicable
Address 1
Address 2
Address 3
City
State Code
State Name
Postal (Zip) Code
Country
Country
Delivery Status Code
Delivery Status Name
Delivery Address Type Code
The customers(s) Shipped To
Show child attributes
Is Residential Address
First Name
Middle Name
Last Name
Company Name, if applicable
Address 1
Address 2
Address 3
City
State Code
State Name
Postal (Zip) Code
Country
Country
Delivery Status Code
Delivery Status Name
Delivery Address Type Code
Delivery Address Type Name
The deliver to consumers
Show child attributes
Is Residential Address
First Name
Middle Name
Last Name
Company Name, if applicable
Address 1
Address 2
Address 3
City
State Code
State Name
Postal (Zip) Code
Country
Country
Delivery Status Code
Delivery Status Name
Delivery Address Type Code
Delivery Address Type Name
The Line Items for this order
Show child attributes
Line Number
Component Number
Inventory Item RowId
The SKU of the customer
Description of the SKU
Is the package shippable
Quantity Ordered
Unit of Measure
Unit Price
The Sub Inventory this inventory is in (Code)
The Sub Inventory this inventory is in (Name)
Quantity Reserved
Quantity Shipped
Is this a Billing Of Materials component
Total item shortage to fill this order
A list of value added services for this order
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
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 packages that make up this order
Show child attributes
Shipment Key
Shipper Of Record
Carrier Name
Date Shipped
Carrier tracking Number
https link to tracking information at the carrier
Package Weight
Delivery Status Name
Delivery Date
Exception Count
Return Date
Return Reason
Email Process Message
The Contents of this order
Show child attributes
Shipment Key
The SKU of the customer
Description of the SKU
Quantity Ordered
Quantity Shipped
Quantity Returned
Quantity Damaged
Quantity Missing
Shipment Tracking history for the order
Show child attributes
Shipment Key
Event Date
Event City
Event State
Event (Zip) Postal Code
Event Code
Event Name
Is Exception
Event Comments
Billing history for the order
Show child attributes
Invoicing Date
Printed Invoice Number
Line Number
Invoice Number
Description
Line Quantity
Line Subtotal
AP Details
Show child attributes
Invoice Key
Invoice Number
Pay To
Description
Invoice Amount
AP Per Line
Show child attributes
Invoice Key
Line Number
The SKU of the customer
Payment Type
Payment Amount
Was this page helpful?