Skip to content

MarketplaceSyncJob ​

Type: schema

Description ​

A sync of the store's listings to a marketplace: the job that runs it, the listings it covers and the marketplace.

TypeScript Definition ​

typescript
MarketplaceSyncJob: {{
            /** @description The id of the sync job. */
            job_id: string;
            /** @description The listings to sync: for chosen products, their listed listings whose content changed since their last sync; for all products, every listing on the marketplace. */
            products: components["schemas"]["MarketplaceSyncItem"][];
            /** @description The marketplace the listings sync to. */
            marketplace_listing: {
                marketplace_id: string;
            }[];
        };
        /**
         * MarketplaceType
         * @enum {string}
         */
}

Component References ​

ReferenceResolves To
components["schemas"]["MarketplaceSyncItem"]MarketplaceSyncItem

OpenAPI Schema ​

json
{
  "title": "MarketplaceSyncJob",
  "description": "A sync of the store's listings to a marketplace: the job that runs it, the listings it covers and the marketplace.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/MarketplaceSyncJob",
    "description": "API reference for the MarketplaceSyncJob schema"
  },
  "required": [
    "job_id",
    "products",
    "marketplace_listing"
  ],
  "properties": {
    "job_id": {
      "description": "The id of the sync job.",
      "type": "string"
    },
    "products": {
      "description": "The listings to sync: for chosen products, their listed listings whose content changed since their last sync; for all products, every listing on the marketplace.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MarketplaceSyncItem"
      }
    },
    "marketplace_listing": {
      "description": "The marketplace the listings sync to.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "marketplace_id": {
            "type": "string"
          }
        },
        "required": [
          "marketplace_id"
        ]
      }
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: