pos-list-order-shipments

Method: GET
Path: /pos/orders/{order_number}/shipments

Tags: POSAdmin

Summary

Retrieve order shipments

Description

Retrieve order shipments

Pos SDK Usage

SDK Method: pos.getOrderShipments()

Example:

const { data, error } = await pos.getOrderShipments({
  order_number: "ORD-2024-001234"
});

if (error) {
  console.error("Failed to get order shipments:", error.message);
} else {
  const shipment = data.content?.shipment;
  console.log(`Order: ${shipment?.order_number}`);
  console.log(`Order Status: ${shipment?.order_status}`);
  console.log(`Payment Status: ${shipment?.payment_status}`);
  console.log(`Customer: ${shipment?.customer_name}`);
  console.log(`Shipments:`, shipment?.shipments);
  console.log(`Allowed Actions:`, shipment?.allowed_actions);
}

TypeScript Definition

"pos-list-order-shipments": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description order number */
                order_number: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            shipment?: components["schemas"]["ShipmentDetail"];
                        };
                    };
                };
            };
        };
    };

Component References

Reference	Resolves To
components["schemas"]["ShipmentDetail"]	ShipmentDetail

Parameters

• order_number (path): order number

Responses

200

OK

OpenAPI Definition

{
  "operationId": "pos-list-order-shipments",
  "summary": "Retrieve order shipments",
  "description": "Retrieve order shipments",
  "parameters": [
    {
      "name": "order_number",
      "in": "path",
      "description": "order number",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "shipment": {
                    "$ref": "#/components/schemas/ShipmentDetail"
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    }
  },
  "tags": [
    "POSAdmin"
  ],
  "x-speakeasy-group": "pos",
  "x-speakeasy-ignore": true
}

---

Auto-generated from OpenAPI spec and TypeScript definitions