BigCommerce · Schema

Order Item Digital

E-CommerceRetailCatalogOrderCheckoutPaymentsSoftware-as-a-Service

Properties

Name	Type	Description
id	string	The line-item ID.
parentId	string	Bundled items will have their parentʼs item ID.
variantId	number	ID of the variant.
productId	number	ID of the product.
sku	string	SKU of the variant.
name	string	The itemʼs product name.
url	string	The product URL.
quantity	number	Quantity of this item.
brand	string	The item's brand.
isTaxable	boolean	Whether the item is taxable.
imageUrl	string	A publicly-accessible URL for an image of this item.
discounts	array	A list of discounts applied to this item, as an array of AppliedDiscount objects.
discountAmount	number	The total value of all discounts applied to this item (excluding coupon).
couponAmount	number	The total value of all coupons applied to this item.
listPrice	number	The itemʼs list price, as quoted by the manufacturer/distributor.
salePrice	number	The itemʼs price after all discounts are applied. (The final price before tax calculation.)
extendedListPrice	number	The itemʼs list price multiplied by the quantity.
extendedSalePrice	number	The itemʼs sale price multiplied by the quantity.
type	string	the product type - physical or digital
downloadFileUrls	array	URLs to download all product files.
downloadPageUrl	string	The URL for the combined downloads page.
downloadSize	string	Specifies the combined download size in human-readable style; for example, `30MB`.
categories	array	Categories the item belongs to.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OrderItemDigital",
  "title": "Order Item Digital",
  "required": [
    "quantity"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The line-item ID."
    },
    "parentId": {
      "type": "string",
      "description": "Bundled items will have their parent\u02bcs item ID."
    },
    "variantId": {
      "type": "number",
      "description": "ID of the variant.",
      "format": "double"
    },
    "productId": {
      "type": "number",
      "description": "ID of the product.",
      "format": "double"
    },
    "sku": {
      "type": "string",
      "description": "SKU of the variant."
    },
    "name": {
      "type": "string",
      "description": "The item\u02bcs product name."
    },
    "url": {
      "type": "string",
      "description": "The product URL."
    },
    "quantity": {
      "type": "number",
      "description": "Quantity of this item.",
      "format": "double"
    },
    "brand": {
      "type": "string",
      "description": "The item's brand."
    },
    "isTaxable": {
      "type": "boolean",
      "description": "Whether the item is taxable."
    },
    "imageUrl": {
      "type": "string",
      "description": "A publicly-accessible URL for an image of this item."
    },
    "discounts": {
      "type": "array",
      "description": "A list of discounts applied to this item, as an array of AppliedDiscount objects.",
      "items": {
        "$ref": "#/components/schemas/AppliedDiscount"
      }
    },
    "discountAmount": {
      "type": "number",
      "description": "The total value of all discounts applied to this item (excluding coupon).",
      "format": "double"
    },
    "couponAmount": {
      "type": "number",
      "description": "The total value of all coupons applied to this item.",
      "format": "double"
    },
    "listPrice": {
      "type": "number",
      "description": "The item\u02bcs list price, as quoted by the manufacturer/distributor.",
      "format": "double"
    },
    "salePrice": {
      "type": "number",
      "description": "The item\u02bcs price after all discounts are applied. (The final price before tax calculation.)",
      "format": "double"
    },
    "extendedListPrice": {
      "type": "number",
      "description": "The item\u02bcs list price multiplied by the quantity.",
      "format": "double"
    },
    "extendedSalePrice": {
      "type": "number",
      "description": "The item\u02bcs sale price multiplied by the quantity.",
      "format": "double"
    },
    "type": {
      "type": "string",
      "description": "the product type - physical or digital"
    },
    "downloadFileUrls": {
      "type": "array",
      "description": "URLs to download all product files.",
      "items": {
        "type": "string"
      }
    },
    "downloadPageUrl": {
      "type": "string",
      "description": "The URL for the combined downloads page."
    },
    "downloadSize": {
      "type": "string",
      "description": "Specifies the combined download size in human-readable style; for example, `30MB`."
    },
    "categories": {
      "type": "array",
      "description": "Categories the item belongs to.",
      "items": {
        "type": "object"
      }
    }
  },
  "x-internal": false
}