Skip to content

ItemWiseInventory ​

Type: schema

TypeScript Definition ​

typescript
ItemWiseInventory: {{
            product_id?: string;
            product_name?: string;
            variant_id?: string | null;
            variant_name?: string | null;
            sku?: string | null;
            track_quantity?: boolean;
            allow_backorder?: boolean;
            track_lot_batch?: boolean;
            /** Format: decimal */
            low_stock_threshold?: number;
            /** Format: decimal */
            received_quantity?: number;
            /** Format: decimal */
            reserved_quantity?: number;
            /** Format: decimal */
            sold_quantity?: number;
            /** Format: decimal */
            adjusted_quantity?: number;
            /** Format: decimal */
            stock_quantity?: number;
            /** @description Whether sellable stock is available after reservations and backorder rules. */
            stock_available?: $Read<boolean>;
            images?: components["schemas"]["AdminProductImage"][];
            /** @description Warehouse the row belongs to. Present only when the list is requested with `view=warehouse`; `null` when unresolved. */
            warehouse_id?: $Read<string | null>;
            /** @description Warehouse name. Present only when the list is requested with `view=warehouse`. */
            warehouse_name?: $Read<string | null>;
        };
        /** JuspayCardPaymentMethod */
}

Component References ​

ReferenceResolves To
components["schemas"]["AdminProductImage"]AdminProductImage

OpenAPI Schema ​

json
{
  "type": "object",
  "properties": {
    "product_id": {
      "type": "string"
    },
    "product_name": {
      "type": "string"
    },
    "variant_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "variant_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "sku": {
      "type": [
        "string",
        "null"
      ]
    },
    "track_quantity": {
      "type": "boolean"
    },
    "allow_backorder": {
      "type": "boolean"
    },
    "track_lot_batch": {
      "type": "boolean"
    },
    "low_stock_threshold": {
      "type": "number",
      "format": "decimal"
    },
    "received_quantity": {
      "type": "number",
      "format": "decimal"
    },
    "reserved_quantity": {
      "type": "number",
      "format": "decimal"
    },
    "sold_quantity": {
      "type": "number",
      "format": "decimal"
    },
    "adjusted_quantity": {
      "type": "number",
      "format": "decimal"
    },
    "stock_quantity": {
      "type": "number",
      "format": "decimal"
    },
    "stock_available": {
      "description": "Whether sellable stock is available after reservations and backorder rules.",
      "type": "boolean",
      "readOnly": true
    },
    "images": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AdminProductImage"
      }
    },
    "warehouse_id": {
      "description": "Warehouse the row belongs to. Present only when the list is requested with `view=warehouse`; `null` when unresolved.",
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "warehouse_name": {
      "description": "Warehouse name. Present only when the list is requested with `view=warehouse`.",
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    }
  },
  "title": "ItemWiseInventory"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: