Skip to content

AdminShipmentItem ​

Type: schema

Description ​

Shipment item model

TypeScript Definition ​

typescript
AdminShipmentItem: {{
            product_id: string;
            product_name?: $Read<string>;
            /** @description `null` for products without variants. */
            variant_id: string | null;
            variant_name?: $Read<string | null>;
            product_image_url?: $Read<string | null>;
            sku?: $Read<string>;
            quantity: number;
            is_free_item?: boolean;
            free_quantity?: number;
            /** Format: double */
            selling_price?: number;
            /** @description Seller detail information. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores. */
            seller_detail?: components["schemas"]["SellerBasicDetail"] | null;
        };
        /**
         * UpiPayment
         * @description UPI Payment
         */
}

Component References ​

ReferenceResolves To
components["schemas"]["SellerBasicDetail"]SellerBasicDetail

OpenAPI Schema ​

json
{
  "description": "Shipment item model",
  "type": "object",
  "properties": {
    "product_id": {
      "type": "string"
    },
    "product_name": {
      "type": "string",
      "readOnly": true
    },
    "variant_id": {
      "description": "`null` for products without variants.",
      "type": [
        "string",
        "null"
      ]
    },
    "variant_name": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "product_image_url": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "sku": {
      "type": "string",
      "readOnly": true
    },
    "quantity": {
      "type": "integer"
    },
    "is_free_item": {
      "type": "boolean"
    },
    "free_quantity": {
      "type": "integer"
    },
    "selling_price": {
      "type": "number",
      "format": "double"
    },
    "seller_detail": {
      "description": "Seller detail information. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/SellerBasicDetail"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "product_id",
    "variant_id",
    "quantity"
  ],
  "title": "ShipmentItem"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: