List orders

Retrieve a list of orders with pagination and filtering options. Results are filtered to orders the authenticated user has access to.

Query Parameters

limitinteger

Maximum number of items to return per page

Default: 10Minimum: 1Maximum: 100

pageinteger

Page number for pagination

Default: 1Minimum: 1

searchstring

Search term to filter orders by name, alias, or customer details

cursorstring

Cursor for pagination (alternative to page-based pagination)

sortBystring

Field to sort by (e.g., orderDate, price, name)

sortOrderstring

Order to sort by

Default: "desc"Value in: "asc" | "desc"

includeArchivedboolean

Whether to include archived orders

Default: false

financialStatusstring

Filter orders by financial status

fulfillmentStatusstring

Filter orders by fulfillment status

dateRange[from]string

Start date for filtering orders by orderDate

Format: "date"

dateRange[to]string

End date for filtering orders by orderDate

Format: "date"

curl -X GET "https://www.shipsidekick.com/api/v1/orders?limit=10&page=1&search=string&cursor=string&sortBy=string&sortOrder=asc&financialStatus=authorized&fulfillmentStatus=scheduled&dateRange%5Bfrom%5D=2019-08-24&dateRange%5Bto%5D=2019-08-24"

Successful operation

{
  "object": "list",
  "data": [
    {
      "id": "abcd1234-e89b-12d3-a456-426614174000",
      "organizationId": "org-5678-1234-abcd-efgh-987654321000",
      "name": "ORD-12345",
      "alias": "CONT-789",
      "price": 42.98,
      "compareAtPrice": 52.98,
      "currency": "usd",
      "financialStatus": "paid",
      "fulfillmentStatus": "open",
      "orderDate": "2025-03-06T14:30:00Z",
      "createdAt": "2025-03-06T14:32:15Z",
      "customer": {
        "id": "cust-9876-5432-abcd",
        "name": "John Wick",
        "email": "johnwick@example.com",
        "phone": "2504806765",
        "company": "The Continental"
      },
      "lineItems": [
        {
          "id": "li-1234-5678-9abc-def0",
          "price": 19.99,
          "quantity": 1,
          "productVariant": {
            "id": "pv-abcd-1234-efgh-5678",
            "title": "Red / Small",
            "sku": "RCT-RED-S",
            "product": {
              "name": "Retro Crew Tee"
            }
          }
        }
      ],
      "tags": [],
      "notes": [],
      "shipments": [],
      "tasks": [],
      "returnOrders": []
    },
    {
      "id": "efgh5678-e89b-34d5-b678-426614174111",
      "organizationId": "org-5678-1234-abcd-efgh-987654321000",
      "name": "ORD-12346",
      "alias": null,
      "price": 59.98,
      "compareAtPrice": null,
      "currency": "usd",
      "financialStatus": "paid",
      "fulfillmentStatus": "partially-fulfilled",
      "orderDate": "2025-03-05T11:20:00Z",
      "createdAt": "2025-03-05T11:22:43Z",
      "customer": {
        "id": "cust-1111-2222-cccc",
        "name": "Jane Smith",
        "email": "janesmith@example.com",
        "phone": null,
        "company": null
      },
      "lineItems": [
        {
          "id": "li-2222-3333-4444-5555",
          "price": 29.99,
          "quantity": 2,
          "productVariant": {
            "id": "pv-3333-4444-5555-6666",
            "title": "Black / Small",
            "sku": "CTS-BLK-S",
            "product": {
              "name": "Classic T-Shirt"
            }
          }
        }
      ],
      "tags": [],
      "notes": [],
      "shipments": [],
      "tasks": [],
      "returnOrders": []
    }
  ],
  "hasMore": true,
  "totalCount": 42,
  "limit": 10,
  "nextCursor": "cursor_efgh5678"
}

List orders

Query Parameters

Example response with multiple orders

TypeScript