Get Import Options

GET /v1/product/import-options

Retrieves available import options for product synchronization. This endpoint provides details about the matching field used for identifying existing records, along with all supported product fields and their requirements.

Response Example

{
  "importOptions": {
    "matchingField": {
      "displayName": "Index Field to match existing records",
      "description": "Primary field used to identify existing records in the system",
      "values": [
        {
          "name": "sku",
          "displayName": "SKU",
          "default": true
        },
        {
          "name": "vendor_sku",
          "displayName": "Vendor SKU"
        },
        {
          "name": "ean",
          "displayName": "EAN"
        },
        {
          "name": "name",
          "displayName": "Name"
        }
      ]
    }
  },
  "fields": [
    {
      "name": "name",
      "displayName": "Name",
      "required": true
    },
    {
      "name": "price",
      "displayName": "Price",
      "required": true
    },
    {
      "name": "sku",
      "displayName": "SKU",
      "required": false
    },
    {
      "name": "ean",
      "displayName": "EAN",
      "required": false
    },
    {
      "name": "vendor_sku",
      "displayName": "Vendor SKU",
      "required": false
    },
    {
      "name": "vendor",
      "displayName": "Vendor",
      "required": false
    },
    {
      "name": "stock",
      "displayName": "Stock",
      "required": false
    },
    {
      "name": "stock_status",
      "displayName": "Stock Status",
      "required": false
    },
    {
      "name": "media",
      "displayName": "Media(image) Link",
      "required": false
    },
    {
      "name": "description",
      "displayName": "Description",
      "required": false
    },
    {
      "name": "ingress",
      "displayName": "Short Description",
      "required": false
    },
    {
      "name": "cost_price",
      "displayName": "Cost Price",
      "required": false
    },
    {
      "name": "categories",
      "displayName": "Categories",
      "required": false,
      "type": "array"
    },
    {
      "name": "distributor",
      "displayName": "Distributor",
      "required": false
    }
  ]
}