MarketplaceStoreItem
Type: schema
Description
The marketplace store's copy of a seller's product: its details, categories, variants, and items with their sales channels.
TypeScript Definition
typescript
MarketplaceStoreItem: {{
/** @description The marketplace store's product id, not the seller's. */
product_id: string;
/** @description The marketplace store. */
store_id: string;
/** @description The seller's store id. */
seller_id: null | string;
/** @description The seller's product this copies. */
seller_product_id: null | string;
name: string;
slug: string;
/** @enum {string} */
product_type: "physical" | "digital" | "bundle";
/**
* @description The seller product's status, copied.
* @enum {string|null}
*/
status: "draft" | "active" | "inactive" | null;
hsn_code: null | string;
is_featured: boolean;
has_variant: boolean;
short_description: null | string;
description: null | string;
metadata: Record<string, never> | null;
seo: Record<string, never> | null;
tags: unknown[] | null;
variant_options: unknown[] | null;
/** @description Listed on the marketplace: follows the seller's listing (`listed`), and the marketplace publishing or unpublishing it. */
is_published: boolean;
/** @description The seller deleted the product or its listing; the copy is kept. */
is_deleted: boolean;
/** @description The marketplace category ids, sorted. */
categories: string[];
/** @description The marketplace store's variants; `seller_variant_id` is the seller's. */
variants: {
variant_id: string;
seller_variant_id: null | string;
name: string;
slug: string;
status: null | string;
is_default: boolean;
short_description: string | null;
description: string | null;
metadata: Record<string, never> | null;
seo: Record<string, never> | null;
is_published: boolean;
is_deleted: boolean;
}[];
/** @description One per variant, or one for a product without variants. */
items: {
item_id: string;
/** @description The listing's marketplace SKU. */
sku: null | string;
/** @description In stock in the marketplace store's inventory and not `manual_stock_out`. */
stock_available: boolean;
/** @description Marked out of stock by the marketplace. */
manual_stock_out: boolean;
/** @description The seller listing's marketplace pricing; `attributes`, `promotions` and `subscriptions` likewise come from the listing. */
pricing: null | Record<string, never>;
images: unknown[] | Record<string, never> | null;
videos: unknown[] | Record<string, never> | null;
packaging: unknown[] | Record<string, never> | null;
shipping: unknown[] | Record<string, never> | null;
promotions: unknown[] | Record<string, never> | null;
subscriptions: unknown[] | Record<string, never> | null;
attributes: unknown[] | Record<string, never> | null;
associated_options: unknown[] | Record<string, never> | null;
/** @description The marketplace variant the item belongs to; `null` for a product without variants. */
variant_id: null | string;
/** @description The marketplace store's sales channels the item is sold on. */
channels: {
sales_channel_id: string;
sales_channel_type: string;
sales_channel_slug: null | string;
}[];
}[];
};
/**
* MarketplaceSyncItem
* @description A listing in a marketplace sync: a product's own listing, or one of its variants'.
*/
}OpenAPI Schema
json
{
"title": "MarketplaceStoreItem",
"description": "The marketplace store's copy of a seller's product: its details, categories, variants, and items with their sales channels.",
"type": "object",
"externalDocs": {
"url": "https://llm-docs.commercengine.io/storefront/schemas/MarketplaceStoreItem",
"description": "API reference for the MarketplaceStoreItem schema"
},
"required": [
"categories",
"description",
"has_variant",
"hsn_code",
"is_deleted",
"is_featured",
"is_published",
"items",
"metadata",
"name",
"product_id",
"product_type",
"seller_id",
"seller_product_id",
"seo",
"short_description",
"slug",
"status",
"store_id",
"tags",
"variant_options",
"variants"
],
"properties": {
"product_id": {
"description": "The marketplace store's product id, not the seller's.",
"type": "string"
},
"store_id": {
"description": "The marketplace store.",
"type": "string"
},
"seller_id": {
"description": "The seller's store id.",
"type": [
"null",
"string"
]
},
"seller_product_id": {
"description": "The seller's product this copies.",
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"product_type": {
"type": "string",
"enum": [
"physical",
"digital",
"bundle"
]
},
"status": {
"description": "The seller product's status, copied.",
"type": [
"string",
"null"
],
"enum": [
"draft",
"active",
"inactive",
null
]
},
"hsn_code": {
"type": [
"null",
"string"
]
},
"is_featured": {
"type": "boolean"
},
"has_variant": {
"type": "boolean"
},
"short_description": {
"type": [
"null",
"string"
]
},
"description": {
"type": [
"null",
"string"
]
},
"metadata": {
"type": [
"object",
"null"
]
},
"seo": {
"type": [
"object",
"null"
]
},
"tags": {
"type": [
"array",
"null"
]
},
"variant_options": {
"type": [
"array",
"null"
]
},
"is_published": {
"description": "Listed on the marketplace: follows the seller's listing (`listed`), and the marketplace publishing or unpublishing it.",
"type": "boolean"
},
"is_deleted": {
"description": "The seller deleted the product or its listing; the copy is kept.",
"type": "boolean"
},
"categories": {
"description": "The marketplace category ids, sorted.",
"type": "array",
"items": {
"type": "string"
}
},
"variants": {
"description": "The marketplace store's variants; `seller_variant_id` is the seller's.",
"type": "array",
"items": {
"type": "object",
"properties": {
"variant_id": {
"type": "string"
},
"seller_variant_id": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"status": {
"type": [
"null",
"string"
]
},
"is_default": {
"type": "boolean"
},
"short_description": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": [
"object",
"null"
]
},
"seo": {
"type": [
"object",
"null"
]
},
"is_published": {
"type": "boolean"
},
"is_deleted": {
"type": "boolean"
}
},
"required": [
"description",
"is_default",
"is_deleted",
"is_published",
"metadata",
"name",
"seller_variant_id",
"seo",
"short_description",
"slug",
"status",
"variant_id"
]
}
},
"items": {
"description": "One per variant, or one for a product without variants.",
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "string"
},
"sku": {
"description": "The listing's marketplace SKU.",
"type": [
"null",
"string"
]
},
"stock_available": {
"description": "In stock in the marketplace store's inventory and not `manual_stock_out`.",
"type": "boolean"
},
"manual_stock_out": {
"description": "Marked out of stock by the marketplace.",
"type": "boolean"
},
"pricing": {
"description": "The seller listing's marketplace pricing; `attributes`, `promotions` and `subscriptions` likewise come from the listing.",
"type": [
"null",
"object"
]
},
"images": {
"type": [
"array",
"object",
"null"
]
},
"videos": {
"type": [
"array",
"object",
"null"
]
},
"packaging": {
"type": [
"array",
"object",
"null"
]
},
"shipping": {
"type": [
"array",
"object",
"null"
]
},
"promotions": {
"type": [
"array",
"object",
"null"
]
},
"subscriptions": {
"type": [
"array",
"object",
"null"
]
},
"attributes": {
"type": [
"array",
"object",
"null"
]
},
"associated_options": {
"type": [
"array",
"object",
"null"
]
},
"variant_id": {
"description": "The marketplace variant the item belongs to; `null` for a product without variants.",
"type": [
"null",
"string"
]
},
"channels": {
"description": "The marketplace store's sales channels the item is sold on.",
"type": "array",
"items": {
"type": "object",
"properties": {
"sales_channel_id": {
"type": "string"
},
"sales_channel_type": {
"type": "string"
},
"sales_channel_slug": {
"type": [
"null",
"string"
]
}
},
"required": [
"sales_channel_id",
"sales_channel_slug",
"sales_channel_type"
]
}
}
},
"required": [
"associated_options",
"attributes",
"channels",
"images",
"item_id",
"manual_stock_out",
"packaging",
"pricing",
"promotions",
"shipping",
"sku",
"stock_available",
"subscriptions",
"variant_id",
"videos"
]
}
}
}
}Auto-generated from OpenAPI spec and TypeScript definitions