BigCommerce · Schema

ChannelProductVariantPartial

Details about a variant of the product for this channel listing.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
product_id object
variant_id object
external_id object
state object
name object
description object
View JSON Schema on GitHub

JSON Schema

bigcommerce-channelproductvariantpartial-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ChannelProductVariantPartial",
  "title": "ChannelProductVariantPartial",
  "type": "object",
  "description": "Details about a variant of the product for this channel listing.",
  "properties": {
    "product_id": {
      "$ref": "#/components/schemas/ProductId"
    },
    "variant_id": {
      "$ref": "#/components/schemas/VariantId"
    },
    "external_id": {
      "$ref": "#/components/schemas/ExternalId"
    },
    "state": {
      "$ref": "#/components/schemas/VariantState"
    },
    "name": {
      "$ref": "#/components/schemas/ChannelProductVariantName"
    },
    "description": {
      "$ref": "#/components/schemas/ChannelProductVariantDescription"
    }
  },
  "required": [
    "product_id",
    "variant_id",
    "state"
  ],
  "x-internal": false
}