Skip to content

ShipmentItemStandard ​

Type: schema

Description ​

Line item on a shipment for B2B/B2C stores (no marketplace seller metadata).

TypeScript Definition ​

typescript
ShipmentItemStandard: {{
            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;
            seller_detail?: Record<string, never> | null;
            /** Format: double */
            selling_price?: number;
        };
        /** ShipmentList */
}

OpenAPI Schema ​

json
{
  "description": "Line item on a shipment for B2B/B2C stores (no marketplace seller metadata).",
  "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"
    },
    "seller_detail": {
      "type": [
        "object",
        "null"
      ]
    },
    "selling_price": {
      "type": "number",
      "format": "double"
    }
  },
  "required": [
    "product_id",
    "variant_id",
    "quantity"
  ],
  "title": "ShipmentItemStandard",
  "x-tags": [
    "Shipping"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: