pos-list-shipments

Method: GET
Path: /pos/shipping/shipments

Tags: POSAdmin

Summary

List all shipments

Description

List all shipments

Pos SDK Usage

SDK Method: pos.listShipments()

Example:

// Basic shipment listing
const { data, error } = await pos.listShipments();

if (error) {
  console.error("Failed to list shipments:", error.message);
} else {
  console.log("Shipments found:", data.content?.shipments?.length || 0);
  console.log("Pagination:", data.content?.pagination);
  data.content?.shipments?.forEach(shipment => {
    console.log(`Shipment: ${shipment.shipment_number} - Status: ${shipment.status}`);
    console.log(`Order: ${shipment.order_number} - AWB: ${shipment.awb_no}`);
  });
}

// With filters and search
const { data: filteredData, error: filteredError } = await pos.listShipments({
  page: 1,
  limit: 25,
  search: "SHIP-2024",
  filters: JSON.stringify({ "status": "shipped" }),
  sort_by: JSON.stringify({ "shipped_date": "desc" })
});

TypeScript Definition

"pos-list-shipments": {
        parameters: {
            query?: {
                /** @description page number of pagination list */
                page?: components["parameters"]["pageNumber"];
                /** @description no of rows per page */
                limit?: components["parameters"]["pageLimit"];
                /** @description JSON object */
                filters?: components["parameters"]["columnBasedFilters"];
                /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
                sort_by?: components["parameters"]["sortByOptions"];
                /** @description search keyword */
                search?: components["parameters"]["searchKeyword"];
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            shipments?: components["schemas"]["ShipmentList"][];
                            pagination?: components["schemas"]["Pagination"];
                        };
                    };
                };
            };
        };
    };

Component References

Reference	Resolves To
components["parameters"]["pageNumber"]	pageNumber
components["parameters"]["pageLimit"]	pageLimit
components["parameters"]["columnBasedFilters"]	columnBasedFilters
components["parameters"]["sortByOptions"]	sortByOptions
components["parameters"]["searchKeyword"]	searchKeyword
components["schemas"]["ShipmentList"]	ShipmentList
components["schemas"]["Pagination"]	Pagination

Parameters

• search (query): search keyword

Responses

200

OK

OpenAPI Definition

{
  "operationId": "pos-list-shipments",
  "summary": "List all shipments",
  "description": "List all shipments",
  "parameters": [
    {
      "$ref": "#/components/parameters/pageNumber"
    },
    {
      "$ref": "#/components/parameters/pageLimit"
    },
    {
      "$ref": "#/components/parameters/columnBasedFilters"
    },
    {
      "$ref": "#/components/parameters/sortByOptions"
    },
    {
      "$ref": "#/components/parameters/searchKeyword"
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "shipments": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/ShipmentList"
                    }
                  },
                  "pagination": {
                    "$ref": "#/components/schemas/Pagination"
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    }
  },
  "tags": [
    "POSAdmin"
  ],
  "x-speakeasy-group": "pos",
  "x-speakeasy-ignore": true
}

---

Auto-generated from OpenAPI spec and TypeScript definitions