Skip to main content
GET
/
api
/
v1
/
Orders
/
OrderInterfaceStatuses
Gets a list of order statuses in the WineDirect interface system
curl --request GET \
  --url https://api.example.com/api/v1/Orders/OrderInterfaceStatuses \
  --header 'Authorization: <api-key>'
{
  "isSuccess": true,
  "message": "<string>",
  "payload": [
    {
      "accountNumber": "<string>",
      "customerName": "<string>",
      "batchId": "<string>",
      "orderNumber": "<string>",
      "orderTypeCode": "<string>",
      "creationDate": "2023-11-07T05:31:56Z",
      "processStatusCode": "<string>",
      "processStatusName": "<string>",
      "processMessage": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
searchStartDate
string<date-time>
required

The beginning date of the search range

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

The ending date of the search range.

YYYY-MM-DD
​
accountNumber
string
required

AccountNumber is the unique Customer ID in the WineDirect system.

Minimum string length: 2
​
batchId
string

The Order import batch ID . This is defined by the customer and can be any text string

Minimum string length: 2

Response

200 - application/json

Returns the list of order statuses

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