Skip to main content
GET
Gets a list of order returns with details and optional personalizations

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)

searchStartDate
string<date-time>
required

The beginning date of the search range (SubmittedDate)

searchEndDate
string<date-time>
required

The ending date of the search range. (SubmittedDate)

returnReasonCode
string

The reason for the return (Code)

processingStatusCode
string

The status of the return (Code)

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