🧑💻️ Welcome to Constructor's API reference
Constructor provides multiple REST APIs to allow integrating parties to…
Return results from our diverse product offerings:
Add, update, or remove Items, Variations or Item groups in a product catalog
Configure product Facets returned in results
Create Collections of products based on dynamic rules
Define search Synonyms, Sort options, and Searchabilities
Customize results through searchandising rules (boosting, burying, and slotting products)
Client libraries and language specific code samples
Constructor aims to maintain strong feature parity / support between our Client libraries / SDKs and our API endpoints. We offer client libraries in numerous languages:
| Language | Package manager | GitHub | Documentation |
|---|---|---|---|
| JavaScript (Client side) | npm | GitHub | Documentation |
| Node (Server side) | npm | GitHub | Documentation |
| Java | JitPack | GitHub | Documentation |
| Python | PyPi | GitHub | Documentation |
| .NET | NuGet | GitHub | Documentation |
| iOS (Swift) | Cocoapods | GitHub | Documentation |
| Android (Kotlin) | JitPack | GitHub | Documentation |
It is recommended to interface with Constructor's APIs through a client library, when possible - see Client library usage justification for more information. Within the API Reference, specific code samples are widely available to illustrate how to make best use of our client libraries in interacting with Constructor APIs, as well as instructions for installing the client libraries.
Data sanitation
To allow flexibility in how customers can use their data, please note that Constructor does not perform any escaping or sanitization of stored data.
Consumers of the Constructor APIs should be sure to implement their own sanitization processes to ensure that dangerous markup (HTML or JavaScript) is not rendered on the page.
It is highly recommended to sanitize all input and output data to prevent potential vulnerabilities, such as injection attacks or other forms of malicious content.
For more information about Constructor's security and compliance policies, please refer to: https://constructor.com/security-and-compliance
HTTP error status codes
The Constructor API uses the following error codes across all requests:
| Error code | Meaning |
|---|---|
| 400 | Bad request: the request is invalid. |
| 401 | Unauthorized: the API token is missing or incorrect. |
| 403 | Forbidden: authorization to access the requested resource not granted. |
| 404 | Not found: the requested resource could not be found. |
| 405 | Method not allowed: the requested resource is not available with the request method. |
| 429 | Too many requests: rate limiting applied - try again with exponential backoff. |
| 500 | Internal server error: an issue happened when processing the request - try again later. |
| 503 | Service unavailable: the requested resource is temporarily offline for maintenance - try again later. |