📦Product Field

Defining the Product Field

The product field is used in our search and matching endpoints.

The product field is a JSON object, with key value pairs such as {'title':'value'}. You must define the product title under the 'title' key. Beyond that, you can specify familiar or unfamiliar keys. Familiar keys such as 'code', 'brand', 'description', and 'price' will be added under their own key value pairs. Do not place any product codes into the 'id' key. All other key-value pairs will be added to the 'description' key, preserving both their key and value.

• required

  • title: string. required. The product title is the name used to describe the product, and can be as many characters. If you only have a long-form description, you can put it in the title.

• optional

  • description: string or json.

  • brand: string.

  • code: string.

  • <unknown keys>: string. all unknown keys are appended to the description.

Tips:

• Matching models will perform better when you pass product codes, if available

• All key value pairs will be added to the product description when searching and matching

• Exclude columns that don't help with matching, such as stock quantities, lead times, promotion details, etc.

See Guidelines for Input Data for more tips.