Skip to content

ItemMarketplaceListing ​

Type: schema

Description ​

A product's or variant's listing on a marketplace the store sells through: how it is listed there.

TypeScript Definition ​

typescript
ItemMarketplaceListing: {{
            /** @description The marketplace it is listed on. */
            marketplace_id: string;
            /** @description The marketplace's slug. On a product's events (`product.*`) only. */
            marketplace_slug?: string;
            marketplace_type: string;
            /** @description The SKU it is listed under. */
            marketplace_item_sku: string | null;
            /** @description The marketplace's categories it is listed in. */
            marketplace_category: string[];
            /** @description Its prices on the marketplace, as set for the listing; `null` when none are set. */
            marketplace_pricing: Record<string, never>[] | null;
            /** @description Its attribute values on the marketplace; `null` when none are set. */
            marketplace_attribute: Record<string, never>[] | null;
            /** @description Its promotion on the marketplace; `null` when it has none. */
            marketplace_promotion: Record<string, never> | null;
            /** @description Its subscription plans on the marketplace; `null` when none are set. */
            marketplace_subscription: Record<string, never>[] | null;
            /** @description The marketplace's id of the product; `null` until it is synced. */
            marketplace_product_id: string | null;
            /** @description The marketplace's id of the variant; `null` until it is synced, and for a product. */
            marketplace_variant_id: string | null;
            /** @description The marketplace's id of the item; `null` until it is synced. */
            marketplace_item_id: string | null;
            /** @description A fingerprint of what the store would list now; when it differs from what the marketplace last received, the listing is due a sync. On `product.updated` and `product.variant.updated` only. */
            seller_item_hash?: string | null;
        };
        /**
         * ItemStockTotals
         * @description An item's stock as `inventory.updated` carries it for an item without stock settings, or a marketplace store's item: its quantities summed across warehouses and batches.
         */
}

OpenAPI Schema ​

json
{
  "title": "ItemMarketplaceListing",
  "description": "A product's or variant's listing on a marketplace the store sells through: how it is listed there.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/ItemMarketplaceListing",
    "description": "API reference for the ItemMarketplaceListing schema"
  },
  "required": [
    "marketplace_id",
    "marketplace_type",
    "marketplace_item_sku",
    "marketplace_category",
    "marketplace_pricing",
    "marketplace_attribute",
    "marketplace_promotion",
    "marketplace_subscription",
    "marketplace_product_id",
    "marketplace_variant_id",
    "marketplace_item_id"
  ],
  "properties": {
    "marketplace_id": {
      "description": "The marketplace it is listed on.",
      "type": "string"
    },
    "marketplace_slug": {
      "description": "The marketplace's slug. On a product's events (`product.*`) only.",
      "type": "string"
    },
    "marketplace_type": {
      "type": "string"
    },
    "marketplace_item_sku": {
      "description": "The SKU it is listed under.",
      "type": [
        "string",
        "null"
      ]
    },
    "marketplace_category": {
      "description": "The marketplace's categories it is listed in.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "marketplace_pricing": {
      "description": "Its prices on the marketplace, as set for the listing; `null` when none are set.",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object"
      }
    },
    "marketplace_attribute": {
      "description": "Its attribute values on the marketplace; `null` when none are set.",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object"
      }
    },
    "marketplace_promotion": {
      "description": "Its promotion on the marketplace; `null` when it has none.",
      "type": [
        "object",
        "null"
      ]
    },
    "marketplace_subscription": {
      "description": "Its subscription plans on the marketplace; `null` when none are set.",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object"
      }
    },
    "marketplace_product_id": {
      "description": "The marketplace's id of the product; `null` until it is synced.",
      "type": [
        "string",
        "null"
      ]
    },
    "marketplace_variant_id": {
      "description": "The marketplace's id of the variant; `null` until it is synced, and for a product.",
      "type": [
        "string",
        "null"
      ]
    },
    "marketplace_item_id": {
      "description": "The marketplace's id of the item; `null` until it is synced.",
      "type": [
        "string",
        "null"
      ]
    },
    "seller_item_hash": {
      "description": "A fingerprint of what the store would list now; when it differs from what the marketplace last received, the listing is due a sync. On `product.updated` and `product.variant.updated` only.",
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: