Skip to content

MarketplaceSyncItem ​

Type: schema

Description ​

A listing in a marketplace sync: a product's own listing, or one of its variants'.

TypeScript Definition ​

typescript
MarketplaceSyncItem: {{
            product_id: string;
            /** @description `null` for the product's own listing. */
            variant_id?: string | null;
            product_name?: string;
            variant_name?: string | null;
            /** @description A fingerprint of the listing's content when the sync was requested, to tell whether the marketplace's copy is current. */
            seller_item_hash?: string | null;
        };
        /**
         * MarketplaceSyncJob
         * @description A sync of the store's listings to a marketplace: the job that runs it, the listings it covers and the marketplace.
         */
}

OpenAPI Schema ​

json
{
  "title": "MarketplaceSyncItem",
  "description": "A listing in a marketplace sync: a product's own listing, or one of its variants'.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/MarketplaceSyncItem",
    "description": "API reference for the MarketplaceSyncItem schema"
  },
  "required": [
    "product_id"
  ],
  "properties": {
    "product_id": {
      "type": "string"
    },
    "variant_id": {
      "description": "`null` for the product's own listing.",
      "type": [
        "string",
        "null"
      ]
    },
    "product_name": {
      "type": "string"
    },
    "variant_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "seller_item_hash": {
      "description": "A fingerprint of the listing's content when the sync was requested, to tell whether the marketplace's copy is current.",
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: