CheckInventoryResponse

Type: schema

TypeScript Definition

CheckInventoryResponse: {{
            allowed_actions?: components["schemas"]["InventoryAction"][];
            shipment_items?: components["schemas"]["ShipmentItem"][];
            inventory_status?: components["schemas"]["InventoryStatus"];
            inventory_detail?: {
                product_id?: string;
                variant_id?: string;
                product_name?: string;
                variant_name?: string;
                sku?: string;
                track_inventory?: boolean;
                allow_backorder?: boolean;
                requested_quantity?: number;
                stock_quantity?: number;
                inventory_status?: components["schemas"]["InventoryStatus"];
                warehouses?: {
                    warehouse_id?: string;
                    warehouse_name?: string;
                    stock_quantity?: number;
                    inventory_status?: components["schemas"]["InventoryStatus"];
                }[];
            }[];
            recommended_warehouses?: {
                id?: string;
                name?: string;
                inventory_status?: components["schemas"]["InventoryStatus"];
            }[];
        };
        /** CollectInStoreFulfillment */
}

Component References

Reference	Resolves To
components["schemas"]["InventoryAction"]	InventoryAction
components["schemas"]["ShipmentItem"]	ShipmentItem
components["schemas"]["InventoryStatus"]	InventoryStatus

OpenAPI Schema

{
  "type": "object",
  "properties": {
    "allowed_actions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/InventoryAction"
      }
    },
    "shipment_items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ShipmentItem"
      }
    },
    "inventory_status": {
      "$ref": "#/components/schemas/InventoryStatus"
    },
    "inventory_detail": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "product_id": {
            "type": "string"
          },
          "variant_id": {
            "type": "string"
          },
          "product_name": {
            "type": "string"
          },
          "variant_name": {
            "type": "string"
          },
          "sku": {
            "type": "string"
          },
          "track_inventory": {
            "type": "boolean"
          },
          "allow_backorder": {
            "type": "boolean"
          },
          "requested_quantity": {
            "type": "integer"
          },
          "stock_quantity": {
            "type": "integer"
          },
          "inventory_status": {
            "$ref": "#/components/schemas/InventoryStatus"
          },
          "warehouses": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "warehouse_id": {
                  "type": "string"
                },
                "warehouse_name": {
                  "type": "string"
                },
                "stock_quantity": {
                  "type": "integer"
                },
                "inventory_status": {
                  "$ref": "#/components/schemas/InventoryStatus"
                }
              }
            }
          }
        }
      }
    },
    "recommended_warehouses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "inventory_status": {
            "$ref": "#/components/schemas/InventoryStatus"
          }
        }
      }
    }
  },
  "title": "CheckInventoryResponse"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions