BigCommerce · Schema

Base Item

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
options	array	The list of selected options for this product.
brand	string	The products brand
couponAmount	number	The total value of all coupons applied to this item.
discountAmount	number	The total value of all discounts applied to this item (excluding coupon).
discounts	object
extendedListPrice	number	Item's list price multiplied by the quantity.
extendedSalePrice	number	Item's sale price multiplied by the quantity.
id	string	The line-item ID.
imageUrl	string	URL of an image of this item, accessible on the internet.
isTaxable	boolean	Whether the item is taxable.
listPrice	number	The net item price before discounts and coupons. BigCommerce derives an item’s list price from the product default price or, if applicable, the sale price configured in the admin panel.
originalPrice	number	An item’s original price is the same as the product default price in the admin panel.
name	string	The item's product name.
parentId	number	The product is part of a bundle such as a product pick list, then the parentId or the main product id will populate.
productId	number	ID of the product.
quantity	number	Quantity of this item.
salePrice	number	Item's price after all discounts are applied. (The final price before tax calculation.)
sku	string	SKU of the variant.
url	string	The product URL.
variantId	number	ID of the variant.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/responseCartBaseItem",
  "title": "Base Item",
  "type": "object",
  "properties": {
    "options": {
      "type": "array",
      "description": "The list of selected options for this product.",
      "items": {
        "$ref": "#/components/schemas/responseCartLineItemsItemsPhysicalItemsItemsAllOf0OptionsItems"
      }
    },
    "brand": {
      "type": "string",
      "description": "The products brand"
    },
    "couponAmount": {
      "type": "number",
      "description": "The total value of all coupons applied to this item."
    },
    "discountAmount": {
      "type": "number",
      "description": "The total value of all discounts applied to this item (excluding coupon).",
      "format": "float"
    },
    "discounts": {
      "$ref": "#/components/schemas/responseCartDiscounts"
    },
    "extendedListPrice": {
      "type": "number",
      "description": "Item's list price multiplied by the quantity."
    },
    "extendedSalePrice": {
      "type": "number",
      "description": "Item's sale price multiplied by the quantity."
    },
    "id": {
      "type": "string",
      "description": "The line-item ID.",
      "example": "4"
    },
    "imageUrl": {
      "type": "string",
      "description": "URL of an image of this item, accessible on the internet.",
      "format": "uri"
    },
    "isTaxable": {
      "type": "boolean",
      "description": "Whether the item is taxable."
    },
    "listPrice": {
      "type": "number",
      "description": "The net item price before discounts and coupons. BigCommerce derives an item\u2019s list price from the product default price or, if applicable, the sale price configured in the admin panel."
    },
    "originalPrice": {
      "type": "number",
      "description": "An item\u2019s original price is the same as the product default price in the admin panel."
    },
    "name": {
      "type": "string",
      "description": "The item's product name."
    },
    "parentId": {
      "type": "number",
      "description": "The product is part of a bundle such as a product pick list, then the parentId or the main product id will populate.",
      "example": 6
    },
    "productId": {
      "type": "number",
      "description": "ID of the product."
    },
    "quantity": {
      "type": "number",
      "description": "Quantity of this item."
    },
    "salePrice": {
      "type": "number",
      "description": "Item's price after all discounts are applied. (The final price before tax calculation.)"
    },
    "sku": {
      "type": "string",
      "description": "SKU of the variant."
    },
    "url": {
      "type": "string",
      "description": "The product URL.",
      "format": "uri"
    },
    "variantId": {
      "type": "number",
      "description": "ID of the variant.",
      "example": 7
    }
  },
  "required": [
    "quantity"
  ],
  "x-internal": false
}