Raw schema
{
"type": "object",
"properties": {
"product_ids": {
"description": "Only these products (one or more ids).",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"name": {
"description": "Product name (case-insensitive match).",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"sku": {
"description": "Exact SKU.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"barcode": {
"description": "Barcode.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"ean": {
"description": "EAN.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"upc": {
"description": "UPC.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"isbn": {
"description": "ISBN.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"mpn": {
"description": "MPN.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"stock_tracked": {
"description": "Only stock-tracked (true) or non-stock (false) products.",
"type": "boolean"
},
"brand_id": {
"description": "Only these brands (one or more ids).",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"product_type_id": {
"description": "Only these product types (one or more ids).",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"category_id": {
"description": "Only these Brightpearl categories (one or more ids).",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"product_group_id": {
"description": "Only products of this product group (variations); 0 = products that are not in a group.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"product_status": {
"description": "Lifecycle status code, for example LIVE.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"primary_supplier_id": {
"description": "Only products with these primary suppliers (one or more ids).",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"created_from": {
"description": "Created: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone.",
"type": "string"
},
"created_to": {
"description": "Created: on or before this day (yyyy-mm-dd, whole day included) or ISO 8601 date-time with timezone.",
"type": "string"
},
"updated_from": {
"description": "Last updated: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone.",
"type": "string"
},
"updated_to": {
"description": "Last updated: on or before this day (yyyy-mm-dd, whole day included) or ISO 8601 date-time with timezone.",
"type": "string"
},
"page_size": {
"description": "Rows per page, 1-500 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 500
},
"first_result": {
"description": "Position of the first row to return, from 1 (default 1). Pass the previous reply's next_first_result for the next page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 10000000
},
"newest_first": {
"description": "Newest (highest id) first. Default: oldest first.",
"type": "boolean"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}