Pre-launch API. The concepts described here are settled, but the API shape is not: request and response fields, parameters and defaults can still change. Build against it, and talk to your Luigi's Box contact before you put an integration into production.
Register a feed source
const url = 'https://api.eu1.luigisbox.ai/catalog/v1/example/sources/feeds';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"active":true,"catalog_type":"example","csv_delimiter":"example","csv_has_header":true,"delete_threshold":1,"format":"xml","group_id_field":"example","group_primary_attribute_name":"example","group_primary_field":"example","identity_field":"example","item_tag":"example","json_path":"example","mapping_id":1,"position":0,"transport_options":{},"url":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.eu1.luigisbox.ai/catalog/v1/example/sources/feeds \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "active": true, "catalog_type": "example", "csv_delimiter": "example", "csv_has_header": true, "delete_threshold": 1, "format": "xml", "group_id_field": "example", "group_primary_attribute_name": "example", "group_primary_field": "example", "identity_field": "example", "item_tag": "example", "json_path": "example", "mapping_id": 1, "position": 0, "transport_options": {}, "url": "example" }'Register a feed source in the catalog and return it with its feed_id and version.
A mapping_id must name a mapping of the same catalog. A catalog holds one feed per url
and catalog_type, a deactivated one included, so registering it again is a 409.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Request Body required
Section titled “Request Body required ”object
Whether the feed runs; a feed set to false stays registered, and every later sync skips it. A sync already running still finishes it.
Object type of the feed’s records, e.g. product, category, brand or article.
Run order among the catalog’s feeds, lowest first, then by feed_id; product feeds run after all the others.
Where to fetch the feed: an http or https URL.
Responses
Section titled “ Responses ”Successful Response
object
Whether the feed runs; a feed set to false stays registered, and every later sync skips it. A sync already running still finishes it.
Catalog the feed belongs to.
Object type of the feed’s records, e.g. product, category, brand or article.
When the feed was registered.
The feed’s identifier.
Run order among the catalog’s feeds, lowest first, then by feed_id; product feeds run after all the others.
When the feed was last changed.
Where to fetch the feed: an http or https URL.
Raised by every change; send it as expected_version to change the feed.
Example generated
{ "active": true, "catalog_id": "example", "catalog_type": "example", "created_at": "2026-04-15T12:00:00Z", "csv_delimiter": "example", "csv_has_header": true, "delete_threshold": 1, "feed_id": 1, "format": "example", "group_id_field": "example", "group_primary_attribute_name": "example", "group_primary_field": "example", "identity_field": "example", "item_tag": "example", "json_path": "example", "mapping_id": 1, "position": 1, "transport_options": {}, "updated_at": "2026-04-15T12:00:00Z", "url": "example", "version": 1}Missing or invalid credentials
Canonical error body — every non-2xx response uses this shape.
object
Machine-readable error context; empty object when there is nothing to add.
object
Stable machine code naming why a well-formed request was refused: snake_case, prefixed by its domain — e.g. filter_unknown_field or cursor_mismatch. Safe to branch on; reason is not. Absent when the status code says all there is to say.
Every field-level problem found in the request, when validation is what failed. Absent when the rejection is not about a specific value.
One field-level reason a request was rejected.
object
Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].
What is wrong with the value at loc.
Stable machine code for the problem, e.g. missing or string_too_short.
Human-readable, actionable error message.
Example generated
{ "exception_details": { "error_code": "example", "validation_errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ] }, "reason": "example", "request_id": "example"}Authenticated but not permitted
Canonical error body — every non-2xx response uses this shape.
object
Machine-readable error context; empty object when there is nothing to add.
object
Stable machine code naming why a well-formed request was refused: snake_case, prefixed by its domain — e.g. filter_unknown_field or cursor_mismatch. Safe to branch on; reason is not. Absent when the status code says all there is to say.
Every field-level problem found in the request, when validation is what failed. Absent when the rejection is not about a specific value.
One field-level reason a request was rejected.
object
Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].
What is wrong with the value at loc.
Stable machine code for the problem, e.g. missing or string_too_short.
Human-readable, actionable error message.
Example generated
{ "exception_details": { "error_code": "example", "validation_errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ] }, "reason": "example", "request_id": "example"}State conflict
Canonical error body — every non-2xx response uses this shape.
object
Machine-readable error context; empty object when there is nothing to add.
object
Stable machine code naming why a well-formed request was refused: snake_case, prefixed by its domain — e.g. filter_unknown_field or cursor_mismatch. Safe to branch on; reason is not. Absent when the status code says all there is to say.
Every field-level problem found in the request, when validation is what failed. Absent when the rejection is not about a specific value.
One field-level reason a request was rejected.
object
Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].
What is wrong with the value at loc.
Stable machine code for the problem, e.g. missing or string_too_short.
Human-readable, actionable error message.
Example generated
{ "exception_details": { "error_code": "example", "validation_errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ] }, "reason": "example", "request_id": "example"}Request validation failed
Canonical error body — every non-2xx response uses this shape.
object
Machine-readable error context; empty object when there is nothing to add.
object
Stable machine code naming why a well-formed request was refused: snake_case, prefixed by its domain — e.g. filter_unknown_field or cursor_mismatch. Safe to branch on; reason is not. Absent when the status code says all there is to say.
Every field-level problem found in the request, when validation is what failed. Absent when the rejection is not about a specific value.
One field-level reason a request was rejected.
object
Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].
What is wrong with the value at loc.
Stable machine code for the problem, e.g. missing or string_too_short.
Human-readable, actionable error message.
Example generated
{ "exception_details": { "error_code": "example", "validation_errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ] }, "reason": "example", "request_id": "example"}Service temporarily unavailable
Canonical error body — every non-2xx response uses this shape.
object
Machine-readable error context; empty object when there is nothing to add.
object
Stable machine code naming why a well-formed request was refused: snake_case, prefixed by its domain — e.g. filter_unknown_field or cursor_mismatch. Safe to branch on; reason is not. Absent when the status code says all there is to say.
Every field-level problem found in the request, when validation is what failed. Absent when the rejection is not about a specific value.
One field-level reason a request was rejected.
object
Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].
What is wrong with the value at loc.
Stable machine code for the problem, e.g. missing or string_too_short.
Human-readable, actionable error message.
Example generated
{ "exception_details": { "error_code": "example", "validation_errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ] }, "reason": "example", "request_id": "example"}Was this page helpful?
Thanks.