list-orders

Method: GET
Path: /orders

Tags: Orders

Summary

Retrieve all orders

Description

list customers all orders

Storefront SDK Usage

SDK Method: sdk.order.listOrders()

Example:

// Basic usage - only required parameter
const { data, error } = await sdk.order.listOrders({
  user_id: "user_01H9XYZ12345ABCDE"
});

// Advanced usage with optional parameters
const { data, error } = await sdk.order.listOrders({
  user_id: "user_01H9XYZ12345ABCDE",
  page: 1,
  limit: 20,
  sort_by: '{"created_at":"desc"}',
  status: ["confirmed", "shipped", "delivered"]
});

if (error) {
  console.error("Failed to list orders:", error.message);
} else {
  console.log("Orders found:", data.orders?.length || 0);
  console.log("Pagination:", data.pagination);

  data.orders?.forEach(order => {
    console.log(`Order ${order.order_number}: ${order.status}`);
  });
}

TypeScript Definition

"list-orders": {
        parameters: {
            query: {
                /** @description page number of pagination list */
                page?: components["parameters"]["pageParam"];
                /** @description no of rows per page */
                limit?: components["parameters"]["pageLimitParam"];
                /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
                sort_by?: components["parameters"]["sortingParam"];
                /** @description array of string */
                status?: string[];
                /** @description user id */
                user_id: string;
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            orders?: components["schemas"]["OrderList"][];
                            pagination?: components["schemas"]["Pagination"];
                        };
                    };
                };
            };
            /** @description Unauthorized */
            401: {
                headers: {
                    [name: string]: unknown;
                };
                content?: never;
            };
        };
    };

Component References

Reference	Resolves To
components["parameters"]["pageParam"]	pageParam
components["parameters"]["pageLimitParam"]	pageLimitParam
components["parameters"]["sortingParam"]	sortingParam
components["schemas"]["OrderList"]	OrderList
components["schemas"]["Pagination"]	Pagination

Parameters

• page (query): page number of pagination list
• limit (query): no of rows per page
• sort_by (query): JSON string format: {"field1":"asc", "field2":"desc"}
• status (query): array of string
• user_id (query): user id

Responses

200

OK

401

Unauthorized

OpenAPI Definition

{
  "tags": [
    "Orders"
  ],
  "operationId": "list-orders",
  "summary": "Retrieve all orders",
  "description": "list customers all orders",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/list-orders",
    "description": "API reference for the list-orders operation"
  },
  "parameters": [
    {
      "$ref": "#/components/parameters/pageParam"
    },
    {
      "$ref": "#/components/parameters/pageLimitParam"
    },
    {
      "$ref": "#/components/parameters/sortingParam"
    },
    {
      "name": "status",
      "in": "query",
      "description": "array of string",
      "schema": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    {
      "name": "user_id",
      "in": "query",
      "description": "user id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "orders": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/OrderList"
                    }
                  },
                  "pagination": {
                    "$ref": "#/components/schemas/Pagination"
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "orders",
  "x-speakeasy-ignore": false,
  "x-speakeasy-name-override": "listOrders"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions