Skip to main content
GET
/
orders
/
{orderId}
Order Status
curl --request GET \
  --url https://api.sandbox.henrylabs.ai/v0/orders/{orderId} \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "status": "<string>",
  "message": "<string>",
  "data": {
    "id": "<string>",
    "userId": "<string>",
    "status": "<string>",
    "statusMessage": "<string>",
    "subtotal": "<string>",
    "tax": "<string>",
    "shipping": "<string>",
    "grandTotal": "<string>",
    "currency": "<string>",
    "products": [
      {
        "productName": "<string>",
        "quantity": 123,
        "productMetadata": {}
      }
    ],
    "shippingDetails": {
      "email": "<string>",
      "fullName": "<string>",
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "stateOrProvince": "<string>",
      "postalCode": "<string>",
      "countryCode": "<string>",
      "phoneNumber": "<string>"
    }
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

orderId
string<uuid>
required

Order ID

Response

Order status retrieved successfully

success
boolean
required
status
string
required
message
string
required
data
object