Skip to main content
GET
/
api
/
v1
/
Orders
/
{orderNumber}
Gets a single order based on the order number.
curl --request GET \
  --url https://api.example.com/api/v1/Orders/{orderNumber} \
  --header 'Authorization: <api-key>'
{
  "isSuccess": true,
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

orderNumber
string
required

Either Order Number or WineDirect Order Number

Response

200 - application/json

OK

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

Header information about an order often used in grids and lists.