channel.catalog.pull

Import the marketplace catalog (preview or import): products, variants, images, listings, stock and prices — a durable job.

Machine-readable body schema: /schemas/routes/channel.catalog.pull.json.

Body

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "mode": {
      "type": "string",
      "enum": [
        "preview",
        "import"
      ]
    },
    "filter": {
      "default": "approved",
      "type": "string",
      "enum": [
        "approved",
        "unapproved",
        "all"
      ]
    },
    "createMissing": {
      "default": true,
      "type": "boolean"
    },
    "updateExisting": {
      "default": false,
      "type": "boolean"
    },
    "importImages": {
      "default": true,
      "type": "boolean"
    },
    "matchBy": {
      "default": "barcode",
      "type": "string",
      "enum": [
        "barcode",
        "sku"
      ]
    }
  },
  "required": [
    "mode"
  ],
  "additionalProperties": false
}
Generated from the live platform registries at build time — reference pages cannot go stale. Markdown variant: /reference/routes/channel.catalog.pull.md