Skip to main content
GET
/
api
/
v1
/
Shipments
/
Returns
Gets a list of order returns with details and optional personalizations
curl --request GET \
  --url https://api.example.com/api/v1/Shipments/Returns \
  --header 'Authorization: <api-key>'
{
  "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>"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'

Query Parameters

​
accountNumber
string
required

AccountNumber is the unique Customer ID in the WineDirect system.

Minimum string length: 2
​
warehouseCode
string

The warehouse (Code)

"GLW" - Glenwillow,
"WDI" - Green Island,
"PSO" - Paso Robles,
"SMA" - Santa Maria,
"SHW" - Willamette Valley
"DAL" - Dallas
​
searchStartDate
string<date-time>
required

The beginning date of the search range (SubmittedDate)

YYYY-MM-DD
​
searchEndDate
string<date-time>
required

The ending date of the search range. (SubmittedDate)

YYYY-MM-DD
​
returnReasonCode
string

The reason for the return (Code)

See https://fulfillment.winedirect.com/administration/api-help
​
processingStatusCode
string

The status of the return (Code)

IN_PROCESS
NEW
RESOLVED
​
orderNumber
string

The order number of this item

​
trackingNumber
string

Carrier tracking Number

Response

200 - application/json

A list of returns

Generic container for all service responses

​
isSuccess
boolean

Was the request successful. If not, the message will have more information.

​
message
string | null

Any error message

​
payload
object[] | null

The payload object of the response