Kibo Commerce · Schema

OrderItem

A single line item of an order.

CompanyCommerceE-CommerceHeadless CommerceOrder ManagementB2BConsumerInventoryFulfillment

Properties

Name Type Description
adjustedLineItemSubtotal numbernull Order Level taxable sub total
attributes arraynull Extensible attributes for this order line.
auditInfo object
autoAddDiscountId integernull Track the discoutid from which the item was auto added
callOffOrderItemId stringnull Identifier of the originating Call-Off Order line item, if this item was released from a Call-Off Order line. Null for standard order items.
childItemIds arraynull List of Child Item Ids for this order item
data objectnull Custom data for a given vendor set within the commerce process.
deliveryWindow object
destinationId stringnull The destination associated with this item when used with a multi-ship checkout.
discountTotal numbernull How much the shopper saves with the applied discount or sale price. This is a negative number.
discountedTotal numbernull Subtotal minus any discounts.
dutyAmount numbernull Duty or Tariff for this item
expectedDeliveryDate stringnull Expected Delivery Date of shipment
extendedTotal numbernull Line item extended total (quantity multiplied by unit extended price) before discounts.
feeTotal numbernull Not implemented. Total cost of fees that apply to this item.
fulfillmentLocationCode stringnull Location code from which to obtain this item
fulfillmentMethod stringnull Fulfillment method used to fulfill this item
giftInfo object
handlingAmount numbernull Product-level handling fee for this item (e.g. special packaging, hazmat fees). This does NOT include order-level handling fees — those are in Mozu.CommerceRuntime.Contracts.Commerce.CommerceItem.Weig
id stringnull Unique identifier of the order line item. System-supplied and read-only.
inventoryTags arraynull
isAssemblyRequired boolean Assembly Required for this order item
isRecurring booleannull If true, the cart item lists a product that can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription.
isReservationEnabled boolean Flag to indicate reserve inventory in cart
isTaxable booleannull Not implemented. If true, the cart item is eligible for tax.
itemTaxTotal numbernull Total price of taxes that apply to products in this item.
lineId integernull The line id assigned to the order item. Visible only in the Admin, this is set from the Admin or in CommerceRuntime when a cart is converted to an order.
lineItemAdjustment numbernull
localeCode stringnull Locale code for language that appears in text and descriptions on the site, for example, en_US. This is not the currency code. Currently only en_US is supported.
originalCartItemId stringnull Unique identifier of the cart item that is associated with this line item. (This is the original Cart Item ID expressed as a GUID.)
parentItemId stringnull Indicates Parent Item Id for this order item
priceMode stringnull Determines if the item is using external or internal(catalog) pricing
product object
productDiscount object
productDiscounts arraynull A list of discounts applied to the product
purchaseLocation stringnull The location where the product is being purchased.. default is null. Products can have different prices by purchaseLocation via custom priceListResolution...
quantity integer Number of products ordered.
requestedShipDate stringnull Requested ship date carried from the Call-Off Order line (spec COM-10941 follow-up).
returnRuleInfo object
shippingAmountBeforeDiscountsAndAdjustments numbernull Shipping amount before Discounts and adjustments
shippingDiscounts arraynull A discount applied to the shipping
shippingMethodCode stringnull Code that uniquely identifies the shipping method.
shippingMethodName stringnull Readable name of the shipping method.
shippingTaxTotal numbernull Total price of taxes that apply to the shipping of this item.
shippingTotal numbernull Total price of shipping that apply to this item.
subscription object
substituteInfo object
subtotal numbernull Line item subtotal (quantity multiplied by price) before discounts.
suggestions arraynull Routing suggestions
taxData objectnull Storage for any additional/custom tax data.
taxableTotal numbernull Line item subtotal (quantity multiplied by price) before discounts.
timeFenceDays integernull Time-fence tolerance (days) carried from the Call-Off Order line's bound ReservationRule.
total numbernull Total price of this cart item taking into account any discounts.
totalWithWeightedShippingAndHandling numbernull Line item total with line item, Tax, Weighted Tax with Weighted shipping and handling costs
totalWithoutWeightedShippingAndHandling numbernull Taxable Subtotal including Weighted Order amounts
unitPrice object
weightedOrderAdjustment numbernull Order Level Manual Adjustment applied to this Item
weightedOrderDiscount numbernull Order Level Discount applied to this Item
weightedOrderDuty numbernull Order Level Duty applied to this Item
weightedOrderHandlingAdjustment numbernull Order-level handling manual adjustment allocated to this item.
weightedOrderHandlingFee numbernull Order-level handling fee allocated to this item (e.g. flat handling fee spread across all items). This is separate from product-level handling in Mozu.CommerceRuntime.Contracts.Commerce.CommerceItem.H
weightedOrderHandlingFeeDiscount numbernull Order-level handling fee discount allocated to this item.
weightedOrderHandlingFeeTax numbernull Total handling tax for this item (covers both product-level and order-level handling tax combined). On the shipment item, this is split into: HandlingTax (total) and WeightedOrderHandlingFeeTax (order
weightedOrderShipping numbernull Order Level Shipping applied to this Item
weightedOrderShippingDiscount numbernull Order Level Shipping discount applied to this Item
weightedOrderShippingManualAdjustment numbernull Order Level Shipping Manual Adjustment applied to this Item
weightedOrderShippingTax numbernull Order Level Shipping Tax applied to this Item
weightedOrderTax numbernull Order Level tax applied to this Item
View JSON Schema on GitHub

JSON Schema

kibo-commerce-order-item-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/kibo-commerce/main/json-schema/kibo-commerce-order-item-schema.json",
  "title": "OrderItem",
  "description": "A single line item of an order.",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/kibo-commerce-commerce-openapi.yml#/components/schemas/OrderItem",
  "properties": {
    "adjustedLineItemSubtotal": {
      "description": "Order Level taxable sub total",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "attributes": {
      "description": "Extensible attributes for this order line.",
      "items": {
        "$ref": "#/$defs/OrderLineAttribute"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "auditInfo": {
      "$ref": "#/$defs/CoreApiContractsAuditInfo"
    },
    "autoAddDiscountId": {
      "description": "Track the discoutid from which the item was auto added",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "callOffOrderItemId": {
      "description": "Identifier of the originating Call-Off Order line item, if this item was released\nfrom a Call-Off Order line. Null for standard order items.",
      "type": [
        "string",
        "null"
      ]
    },
    "childItemIds": {
      "description": "List of Child Item Ids for this order item",
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "data": {
      "description": "Custom data for a given vendor set within the commerce process.",
      "type": [
        "object",
        "null"
      ]
    },
    "deliveryWindow": {
      "$ref": "#/$defs/DeliveryWindow"
    },
    "destinationId": {
      "description": "The destination associated with this item when used with a multi-ship checkout.",
      "type": [
        "string",
        "null"
      ]
    },
    "discountTotal": {
      "description": "How much the shopper saves with the applied discount or sale price. This is a negative number.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "discountedTotal": {
      "description": "Subtotal minus any discounts.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "dutyAmount": {
      "description": "Duty or Tariff for this item",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "expectedDeliveryDate": {
      "description": "Expected Delivery Date of shipment",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "extendedTotal": {
      "description": "Line item extended total (quantity multiplied by unit extended price) before discounts.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "feeTotal": {
      "description": "Not implemented. Total cost of fees that apply to this item.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "fulfillmentLocationCode": {
      "description": "Location code from which to obtain this item",
      "type": [
        "string",
        "null"
      ]
    },
    "fulfillmentMethod": {
      "description": "Fulfillment method used to fulfill this item",
      "type": [
        "string",
        "null"
      ]
    },
    "giftInfo": {
      "$ref": "#/$defs/GiftInfo"
    },
    "handlingAmount": {
      "description": "Product-level handling fee for this item (e.g. special packaging, hazmat fees).\nThis does NOT include order-level handling fees — those are in Mozu.CommerceRuntime.Contracts.Commerce.CommerceItem.WeightedOrderHandlingFee.\nTotal handling on the shipment = HandlingAmount + WeightedOrderHandlingFee.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "id": {
      "description": "Unique identifier of the order line item. System-supplied and read-only.",
      "type": [
        "string",
        "null"
      ]
    },
    "inventoryTags": {
      "items": {
        "$ref": "#/$defs/InventoryTags"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "isAssemblyRequired": {
      "description": "Assembly Required for this order item",
      "type": "boolean"
    },
    "isRecurring": {
      "description": "If true, the cart item lists a product that can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "isReservationEnabled": {
      "description": "Flag to indicate reserve inventory in cart",
      "type": "boolean"
    },
    "isTaxable": {
      "description": "Not implemented. If true, the cart item is eligible for tax.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "itemTaxTotal": {
      "description": "Total price of taxes that apply to products in this item.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "lineId": {
      "description": "The line id assigned to the order item. Visible only in the Admin, this is set from the Admin or\nin CommerceRuntime when a cart is converted to an order.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "lineItemAdjustment": {
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "localeCode": {
      "description": "Locale code for language that appears in text and descriptions on the site, for example, en_US. \nThis is not the currency code. Currently only en_US is supported.",
      "type": [
        "string",
        "null"
      ]
    },
    "originalCartItemId": {
      "description": "Unique identifier of the cart item that is associated with this line item. \n(This is the original Cart Item ID expressed as a GUID.)",
      "type": [
        "string",
        "null"
      ]
    },
    "parentItemId": {
      "description": "Indicates Parent Item Id for this order item",
      "type": [
        "string",
        "null"
      ]
    },
    "priceMode": {
      "description": "Determines if the item is using external or internal(catalog) pricing",
      "type": [
        "string",
        "null"
      ]
    },
    "product": {
      "$ref": "#/$defs/Product"
    },
    "productDiscount": {
      "$ref": "#/$defs/AppliedLineItemProductDiscount"
    },
    "productDiscounts": {
      "description": "A list of discounts applied to the product",
      "items": {
        "$ref": "#/$defs/AppliedLineItemProductDiscount"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "purchaseLocation": {
      "description": "The location where the product is being purchased.. default is null. Products can have different prices\nby purchaseLocation via custom priceListResolution...",
      "type": [
        "string",
        "null"
      ]
    },
    "quantity": {
      "description": "Number of products ordered.",
      "format": "int32",
      "type": "integer"
    },
    "requestedShipDate": {
      "description": "Requested ship date carried from the Call-Off Order line (spec COM-10941 follow-up).",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "returnRuleInfo": {
      "$ref": "#/$defs/ReturnRuleInfo"
    },
    "shippingAmountBeforeDiscountsAndAdjustments": {
      "description": "Shipping amount before Discounts and adjustments",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "shippingDiscounts": {
      "description": "A discount applied to the shipping",
      "items": {
        "$ref": "#/$defs/AppliedLineItemShippingDiscount"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "shippingMethodCode": {
      "description": "Code that uniquely identifies the shipping method.",
      "type": [
        "string",
        "null"
      ]
    },
    "shippingMethodName": {
      "description": "Readable name of the shipping method.",
      "type": [
        "string",
        "null"
      ]
    },
    "shippingTaxTotal": {
      "description": "Total price of taxes that apply to the shipping of this item.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "shippingTotal": {
      "description": "Total price of shipping that apply to this item.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "subscription": {
      "$ref": "#/$defs/SubscriptionInfo"
    },
    "substituteInfo": {
      "$ref": "#/$defs/SubstituteInfo"
    },
    "subtotal": {
      "description": "Line item subtotal (quantity multiplied by price) before discounts.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "suggestions": {
      "description": "Routing suggestions",
      "items": {
        "$ref": "#/$defs/Suggestion"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "taxData": {
      "description": "Storage for any additional/custom tax data.",
      "type": [
        "object",
        "null"
      ]
    },
    "taxableTotal": {
      "description": "Line item subtotal (quantity multiplied by price) before discounts.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "timeFenceDays": {
      "description": "Time-fence tolerance (days) carried from the Call-Off Order line's bound ReservationRule.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "total": {
      "description": "Total price of this cart item taking into account any discounts.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "totalWithWeightedShippingAndHandling": {
      "description": "Line item total with line item, Tax, Weighted Tax with Weighted shipping and handling costs",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "totalWithoutWeightedShippingAndHandling": {
      "description": "Taxable Subtotal including Weighted Order amounts",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "unitPrice": {
      "$ref": "#/$defs/CommerceUnitPrice"
    },
    "weightedOrderAdjustment": {
      "description": "Order Level Manual Adjustment applied to this Item",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "weightedOrderDiscount": {
      "description": "Order Level Discount applied to this Item",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "weightedOrderDuty": {
      "description": "Order Level Duty applied to this Item",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "weightedOrderHandlingAdjustment": {
      "description": "Order-level handling manual adjustment allocated to this item.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "weightedOrderHandlingFee": {
      "description": "Order-level handling fee allocated to this item (e.g. flat handling fee spread across all items).\nThis is separate from product-level handling in Mozu.CommerceRuntime.Contracts.Commerce.CommerceItem.HandlingAmount.\nTotal handling on the shipment = HandlingAmount + WeightedOrderHandlingFee.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "weightedOrderHandlingFeeDiscount": {
      "description": "Order-level handling fee discount allocated to this item.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "weightedOrderHandlingFeeTax": {
      "description": "Total handling tax for this item (covers both product-level and order-level handling tax combined).\nOn the shipment item, this is split into: HandlingTax (total) and WeightedOrderHandlingFeeTax (order-level portion only).",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "weightedOrderShipping": {
      "description": "Order Level Shipping applied to this Item",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "weightedOrderShippingDiscount": {
      "description": "Order Level Shipping discount applied to this Item",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "weightedOrderShippingManualAdjustment": {
      "description": "Order Level Shipping Manual Adjustment applied to this Item",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "weightedOrderShippingTax": {
      "description": "Order Level Shipping Tax applied to this Item",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "weightedOrderTax": {
      "description": "Order Level tax applied to this Item",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    }
  },
  "type": "object",
  "$defs": {
    "AppliedDiscount": {
      "description": "Discount applied to the order, which is a negative number to be subtracted from the original price to get the final price. \nIf multiple discounts for the order exist, this is the value most advantageous to the shopper.",
      "properties": {
        "couponCode": {
          "description": "Code of the coupon associated with the discount if a coupon code is required to get the discount.",
          "type": [
            "string",
            "null"
          ]
        },
        "data": {
          "description": "Stores any custom data sent from external discounts.",
          "type": [
            "object",
            "null"
          ]
        },
        "discount": {
          "$ref": "#/$defs/Discount"
        },
        "excluded": {
          "description": "Determines whether or not this discount is set up to be ignored by the pricing runtime.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "groupId": {
          "description": "Group identifier for the discount.",
          "type": [
            "string",
            "null"
          ]
        },
        "impact": {
          "description": "Value of the discount applied. This is a negative number to be subtracted from the original price to get the final price.",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "AppliedLineItemProductDiscount": {
      "properties": {
        "appliesToSalePrice": {
          "description": "Determines if the discount applies to the sale price of the order",
          "type": [
            "boolean",
            "null"
          ]
        },
        "discountQuantity": {
          "description": "The number of the line item that can be used for this particular discount.",
          "format": "int32",
          "type": "integer"
        }
      },
      "type": "object"
    },
    "AppliedLineItemShippingDiscount": {
      "properties": {
        "discount": {
          "$ref": "#/$defs/AppliedDiscount"
        },
        "discountQuantity": {
          "description": "The number of the line item that can be used for this particular discount.",
          "format": "int32",
          "type": "integer"
        },
        "impactPerUnit": {
          "description": "The impact of this discount pur discount quantity.",
          "format": "double",
          "type": "number"
        },
        "methodCode": {
          "description": "Unique identifier of the shipping method discount.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "BundledProduct": {
      "description": "Describes products that are bundled inside of a main bundle product.",
      "properties": {
        "allocationExpiration": {
          "description": "Allocation ID associated with this product on this order.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "allocationId": {
          "description": "Allocation ID associated with this product on this order.",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "creditValue": {
          "description": "Credit value.  Only populated if the bundled product is a gift card or digital credit",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "deltaPrice": {
          "description": "Only populated for extras",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "description": {
          "description": "Short description of the product in the language specified by LocaleCode.",
          "type": [
            "string",
            "null"
          ]
        },
        "fulfillmentStatus": {
          "description": "Fulfillment status of the product.",
          "type": [
            "string",
            "null"
          ]
        },
        "goodsType": {
          "description": "Goods Type",
          "type": [
            "string",
            "null"
          ]
        },
        "imageUrl": {
          "description": "ImageUrl of product",
          "type": [
            "string",
            "null"
          ]
        },
        "isPackagedStandAlone": {
          "description": "Indicates that this product ships by itself.",
          "type": "boolean"
        },
        "measurements": {
          "$ref": "#/$defs/PackageMeasurements"
        },
        "name": {
          "description": "Name of the product, this is the current value of the product's name in the language specified by LocaleCode.",
          "type": [
            "string",
            "null"
          ]
        },
        "optionAttributeFQN": {
          "description": "Fully Qualified Name of the selected option's attribute",
          "type": [
            "string",
            "null"
          ]
        },
        "optionValue": {
          "description": "Value of the selected option",
          "nullable": true
        },
        "productCode": {
          "description": "Merchant-created code that uniquely identifies the product.",
          "type": [
            "string",
            "null"
          ]
        },
        "productReservationId": {
          "description": "Reservation ID associated with this product in the bundle.",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "quantity": {
          "description": "Quantity of the product included in the bundle.",
          "format": "int32",
          "type": "integer"
        },
        "stock": {
          "$ref": "#/$defs/ProductStock"
        }
      },
      "type": "object"
    },
    "Category": {
      "description": "Categories to which the product belongs. Discounts can apply to categories where any product in the category is discounted.",
      "properties": {
        "id": {
          "description": "Unique identifier of the category. System-supplied and read-only.",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "parent": {
          "$ref": "#/$defs/Category"
        }
      },
      "type": "object"
    },
    "CommerceUnitPrice": {
      "description": "Pricing details for the product listed on a cart item, including the original price, discount amount, and final price.",
      "properties": {
        "extendedAmount": {
          "description": "Extended amount, this is in order of precedence: OverrideAmount, SaleAmount, ListAmount",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "listAmount": {
          "description": "Product list amount.",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "overrideAmount": {
          "description": "Amount as manually overridden by the Merchant",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "saleAmount": {
          "description": "Sale amount indicated on the product.",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "CoreApiContractsAuditInfo": {
      "properties": {
        "createBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "createDate": {
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "updateBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "updateDate": {
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "DeliveryWindow": {
      "properties": {
        "endTime": {
          "description": "End time for delivery window.",
          "format": "date-time",
          "type": "string"
        },
        "startTime": {
          "description": "Start time for delivery window.",
          "format": "date-time",
          "type": "string"
        }
      },
      "type": "object"
    },
    "Discount": {
      "description": "Discounts that apply to the order, if any. For example, when the \nsubtotal of the order exceeds a certain amount, or for free shipping.",
      "properties": {
        "expirationDate": {
          "description": "Date when the discount expires. Default is null (no expiration date).",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "hasMultipleTargetProducts": {
          "description": "Indicates that the discount targets more than a product.  Used\nprimarily for BoGa discounts with multiple targets.",
          "type": "boolean"
        },
        "id": {
          "description": "Unique identifier of the discount.",
          "format": "int32",
          "type": "integer"
        },
        "itemIds": {
          "description": "List of discounts for each order item.",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "name": {
          "description": "Name of the discount in the language specified by LocaleCode.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "Frequency": {
      "properties": {
        "unit": {
          "type": [
            "string",
            "null"
          ]
        },
        "value": {
          "format": "int32",
          "nullable": false,
          "type": "integer"
        }
      },
      "type": "object"
    },
    "FulfillmentField": {
      "properties": {
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "required": {
          "type": "boolean"
        },
        "userEnteredValue": {
          "nullable": true
        }
      },
      "type": "object"
    },
    "FutureInventory": {
      "properties": {
        "allocated": {
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "available": {
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "createDate": {
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "deliveryDate": {
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "futureInventoryID": {
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "onhand": {
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "pending": {
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "GiftInfo": {
      "properties": {
        "giftMessage": {
          "description": "Item level gift message",
          "maxLength": 500,
          "type": [
            "string",
            "null"
          ]
        },
        "isGiftItem": {
          "description": "Flag to indicate whether the item is a gift item",
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "InventoryTags": {
      "properties": {
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "value": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "Measurement": {
      "properties": {
        "unit": {
          "type": [
            "string",
            "null"
          ]
        },
        "value": {
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "OrderLineAttribute": {
      "description": "Attribute instance on an Order line item.",
      "properties": {
        "attributeDefinitionId": {
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "auditInfo": {
          "$ref": "#/$defs/CoreApiContractsAuditInfo"
        },
        "fullyQualifiedName": {
          "type": [
            "string",
            "null"
          ]
        },
        "values": {
          "items": {},
          "type": [
            "array",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "PackageMeasurements": {
      "description": "Physical dimensions of the package required to ship the product and its weight.",
      "properties": {
        "height": {
          "$ref": "#/$defs/Measurement"
        },
        "length": {
          "$ref": "#/$defs/Measurement"
        },
        "weight": {
          "$ref": "#/$defs/Measurement"
        },
        "width": {
          "$ref": "#/$defs/Measurement"
        }
      },
      "type": "object"
    },
    "Product": {
      "description": "The product as it appears on the order item.",
      "properties": {
        "allocationExpiration": {
          "description": "Allocation ID associated with this product on this order.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "allocationId": {
          "description": "Allocation ID associated with this product on this order.",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "bundledProducts": {
          "description": "Products bundled with this product (if the current product is a bundle)",
          "items": {
            "$ref": "#/$defs/BundledProduct"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "categories": {
          "description": "Categories to which this product belongs.",
          "items": {
            "$ref": "#/$defs/Category"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "condition": {
          "description": "Condition",
          "type": [
            "string",
            "null"
          ]
        },
        "description": {
          "description": "Short description of the product in the language specified by LocaleCode.",
          "type": [
            "string",
            "null"
          ]
        },
        "discountsRestricted": {
          "description": "Is the product discount restricted",
          "type": [
            "boolean",
            "null"
          ]
        },
        "discountsRestrictedEndDate": {
          "description": "Product discount restriction end date",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "discountsRestrictedStartDate": {
          "description": "Product discount restriction start date",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "fulfillmentFields": {
          "description": "List of unique product identifiers for an item on shipment",
          "items": {
            "$ref": "#/$defs/FulfillmentField"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "fulfillmentStatus": {
          "description": "Fulfillment status of the product.",
          "type": [
            "string",
            "null"
          ]
        },
        "fulfillmentTypesSupported": {
          "description": "Types of fulfillment that are supported for this product.",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "goodsType": {
          "description": "Goods Type",
          "type": [
            "string",
            "null"
          ]
        },
        "imageAlternateText": {
          "description": "Descriptive text of the image associated with the product in the language specified by LocaleCode.",
          "type": [
            "string",
            "null"
          ]
        },
        "imageUrl": {
          "description": "URL of the image that appears next to the product on the order item. Optional.",
          "type": [
            "string",
            "null"
          ]
        },
        "isPackagedStandAlone": {
          "description": "Indicates that this product ships by itself.",
          "type": "boolean"
        },
        "isRecurring": {
          "description": "If true, the product is purchased or fulfilled at regular intervals, for example, a monthly billing or a subscription.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "isTaxable": {
          "description": "If true, the product is eligible for tax.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "measurements": {
          "$ref": "#/$defs/PackageMeasurements"
        },
        "mfgPartNumber": {
          "description": "Manufacturing Part Number of the product.",
          "type": [
            "string",
            "null"
          ]
        },
        "name": {
          "description": "Name of the product, this is the current value of the product's name in the language specified by LocaleCode.",
          "type": [
            "string",
            "null"
          ]
        },
        "options": {
          "description": "If the product contains configurable or stand-alone options, the list of product options that the shopper selected for this product.",
          "items": {
            "$ref": "#/$defs/ProductOption"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "price": {
          "$ref": "#/$defs/ProductPrice"
        },
        "productCode": {
          "description": "Merchant-created code that uniquely identifies the product.",
          "type": [
            "string",
            "null"
          ]
        },
        "productReservationId": {
          "description": "Reservation ID associated with this product in the bundle.",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "productType": {
          "description": "Type of product, which can be a product with configurable options, a product with stand-alone options, or a simple product with no options.",
          "type": [
            "string",
            "null"
          ]
        },
        "productUsage": {
          "description": "Usage of the prod

# --- truncated at 32 KB (43 KB total) ---
# Full source: https://artifacts.apis.io/kibo-commerce/json-schema/kibo-commerce-order-item-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/kibo-commerce-order-item"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.