BigCommerce · Schema

Item Custom

Add a custom item to the shopperʼs cart. * Custom items are not added to the catalog. * The price should be set to match the store settings for taxes.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
id string ID of the custom item.
sku string SKU of the custom item.
name string Name of the item.
quantity string
list_price string Specifies the price of the item. This value can include or exclude tax, depending on the store setup.
View JSON Schema on GitHub

JSON Schema

bigcommerce-itemcustom-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ItemCustom",
  "title": "Item Custom",
  "type": "object",
  "description": "Add a custom item to the shopper\u02bcs cart.\n\n* Custom items are not added to the catalog.\n* The price should be set to match the store settings for taxes.",
  "x-internal": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the custom item."
    },
    "sku": {
      "type": "string",
      "description": "SKU of the custom item."
    },
    "name": {
      "type": "string",
      "description": "Name of the item."
    },
    "quantity": {
      "type": "string"
    },
    "list_price": {
      "type": "string",
      "description": "Specifies the price of the item. This value can include or exclude tax, depending on the store setup."
    }
  }
}