Skip to main content
GET
/
orders
JavaScript
import HenrySDK from '@henrylabs/sdk';

const client = new HenrySDK({
  apiKey: process.env['HENRY_SDK_API_KEY'], // This is the default and can be omitted
});

const orders = await client.orders.list({ 'x-user-id': 'x-user-id' });

console.log(orders.message);
{
  "success": true,
  "status": "<string>",
  "message": "<string>",
  "data": {
    "orders": [
      {
        "id": "<string>",
        "status": "processing",
        "itemCount": 123,
        "subtotal": "<string>",
        "tax": "<string>",
        "shipping": "<string>",
        "grandTotal": "<string>",
        "currency": "<string>",
        "createdAt": "<string>"
      }
    ],
    "pagination": {
      "currentPage": 123,
      "totalPages": 123,
      "totalCount": 123,
      "hasNextPage": true,
      "hasPreviousPage": true,
      "limit": 123
    }
  }
}

Authorizations

x-api-key
string
header
required

Headers

x-user-id
string
required

Query Parameters

page
integer
default:1

Page number (starts from 1)

Required range: x >= 1
limit
integer
default:15

Number of items per page (1-100)

Required range: 1 <= x <= 100

Response

Order list retrieved successfully

success
boolean
required
status
string
required
message
string
required
data
object