pos-check-order-inventory

Method: GET
Path: /pos/orders/{order_number}/check-inventory

Tags: POSAdmin

Summary

Check Inventory

Description

Check Inventory

TypeScript Definition

"pos-check-order-inventory": {
        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?: {
                            inventory?: components["schemas"]["CheckInventoryResponse"];
                        };
                    };
                };
            };
        };
    };

Component References

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

Parameters

• order_number (path): Order number

Responses

200

OK

OpenAPI Definition

{
  "operationId": "pos-check-order-inventory",
  "summary": "Check Inventory",
  "description": "Check Inventory",
  "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": {
                  "inventory": {
                    "$ref": "#/components/schemas/CheckInventoryResponse"
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    }
  },
  "tags": [
    "POSAdmin"
  ],
  "x-speakeasy-group": "pos",
  "x-speakeasy-ignore": true
}

---

Auto-generated from OpenAPI spec and TypeScript definitions