{
"isSuccess": true,
"message": "<string>",
"payload": [
{
"shipReturnId": 123,
"shipmentKey": 123,
"customerName": "<string>",
"wineDirectOrderNumber": "<string>",
"orderNumber": "<string>",
"orderTypeCode": "<string>",
"orderTypeName": "<string>",
"shipFromWarehouseCode": "<string>",
"consumerFirstName": "<string>",
"consumerLastName": "<string>",
"consumerAddress1": "<string>",
"consumerAddress2": "<string>",
"consumerCity": "<string>",
"consumerState": "<string>",
"consumerZipCode": "<string>",
"notificationEmailAddress": "<string>",
"notificationPhoneNumber": "<string>",
"wmsCarrierCode": "<string>",
"carrierCode": "<string>",
"trackingNumber": "<string>",
"trackingNumberUrl": "<string>",
"trackingStatusUrl": "<string>",
"shipDate": "2023-11-07T05:31:56Z",
"returnDate": "2023-11-07T05:31:56Z",
"returnReasonCode": "<string>",
"returnReasonName": "<string>",
"processingStatusCode": "<string>",
"processingStatusName": "<string>",
"resolutionCode": "<string>",
"resolutionName": "<string>",
"hasPersonalizations": true,
"vasOrderPersonalizations": [
{
"type": "<string>",
"lineNumber": 123,
"message": "<string>",
"options": [
{
"type": "<string>",
"option": "<string>",
"message": "<string>"
}
]
}
],
"lineItems": [
{
"shipReturnId": 123,
"shipmentKey": 123,
"lineNumber": 123,
"componentNumber": 123,
"sku": "<string>",
"skuDescription": "<string>",
"wineDirectSku": "<string>",
"quantityOrdered": 123,
"quantityShipped": 123,
"quantityReturned": 123,
"quantityDamaged": 123,
"quantityMissing": 123,
"vasOrderPersonalizations": [
{
"type": "<string>",
"lineNumber": 123,
"message": "<string>",
"options": [
{
"type": "<string>",
"option": "<string>",
"message": "<string>"
}
]
}
]
}
]
}
]
}{
"isSuccess": true,
"message": "<string>",
"payload": [
{
"shipReturnId": 123,
"shipmentKey": 123,
"customerName": "<string>",
"wineDirectOrderNumber": "<string>",
"orderNumber": "<string>",
"orderTypeCode": "<string>",
"orderTypeName": "<string>",
"shipFromWarehouseCode": "<string>",
"consumerFirstName": "<string>",
"consumerLastName": "<string>",
"consumerAddress1": "<string>",
"consumerAddress2": "<string>",
"consumerCity": "<string>",
"consumerState": "<string>",
"consumerZipCode": "<string>",
"notificationEmailAddress": "<string>",
"notificationPhoneNumber": "<string>",
"wmsCarrierCode": "<string>",
"carrierCode": "<string>",
"trackingNumber": "<string>",
"trackingNumberUrl": "<string>",
"trackingStatusUrl": "<string>",
"shipDate": "2023-11-07T05:31:56Z",
"returnDate": "2023-11-07T05:31:56Z",
"returnReasonCode": "<string>",
"returnReasonName": "<string>",
"processingStatusCode": "<string>",
"processingStatusName": "<string>",
"resolutionCode": "<string>",
"resolutionName": "<string>",
"hasPersonalizations": true,
"vasOrderPersonalizations": [
{
"type": "<string>",
"lineNumber": 123,
"message": "<string>",
"options": [
{
"type": "<string>",
"option": "<string>",
"message": "<string>"
}
]
}
],
"lineItems": [
{
"shipReturnId": 123,
"shipmentKey": 123,
"lineNumber": 123,
"componentNumber": 123,
"sku": "<string>",
"skuDescription": "<string>",
"wineDirectSku": "<string>",
"quantityOrdered": 123,
"quantityShipped": 123,
"quantityReturned": 123,
"quantityDamaged": 123,
"quantityMissing": 123,
"vasOrderPersonalizations": [
{
"type": "<string>",
"lineNumber": 123,
"message": "<string>",
"options": [
{
"type": "<string>",
"option": "<string>",
"message": "<string>"
}
]
}
]
}
]
}
]
}Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'
AccountNumber is the unique Customer ID in the WineDirect system.
2The warehouse (Code)
"GLW" - Glenwillow,
"WDI" - Green Island,
"PSO" - Paso Robles,
"SMA" - Santa Maria,
"SHW" - Willamette Valley
"DAL" - DallasThe beginning date of the search range (SubmittedDate)
YYYY-MM-DDThe ending date of the search range. (SubmittedDate)
YYYY-MM-DDThe reason for the return (Code)
See https://fulfillment.winedirect.com/administration/api-helpThe status of the return (Code)
IN_PROCESS
NEW
RESOLVEDThe order number of this item
Carrier tracking Number
A list of returns
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
The ID of this shipment return
The Key of this shipment return
Name of the customer
The order number in WineDirect's system
The customer's order 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 OrderOrder Type (Name)
Warehouse
Consumer
Consumer
Consumer
Consumer
Consumer
Consumer
Consumer
Phone
Carrier
Carrier Tracking Number
The URL, if exists, for the carrier's tracking number details
A link to the carrier's web site
When shipped
When returned
Reason Reason (NaCodeme)
Reason Reason (Name)
Status (Code)
Status (Name)
Resolution (Code)
Resolution (Name)
Are there personalizations on this order
Value added service personalizations
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 SKUs in this return
Show child attributes
The ID of this shipment return
The Key of this shipment return
Line Number
The Component Number
The Sku of the customer
Description
The WineDirect Sku
Ordered
Shipped
Returned
Damaged
Missing
Value added service personalizations
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
2000Was this page helpful?