Bricqer operates entirely through its RESTful API, which means that all the data you interact with on the frontend can be retrieved and managed through API calls. If you want to integrate other software with Bricqer, you'll definitely want to take a look at our API.
Creating an API key
If you want to retrieve data from Bricqer or perform actions using the API, you can create an API key. To generate an API key, go to Settings, navigate to API keys, and click Create a new API key.
For example, you can create a new API key called "Scale" and grant it full access to all data within Bricqer. Optionally, you can set an expiration date for the API key to enhance security.
Authorization
For each call to the API, you must specify the API key using the Authorization header. You must specify Api-Key as the type of authorization, followed by your API key. For example, if your API key is test123, then you would set the following header: Authorization: Api-Key test123.
Using the API
Once the API key is created, you can utilize it to perform various actions. For example, you can request a list of orders, create new inventory items, export and import data and more. The API provides comprehensive visibility and accessibility to all features offered by Bricqer. With an API key, you have the ability to manage and interact with Bricqer programmatically.
Revoking API access
If you wish to revoke access to your data, whether due to a lost key or a decision to discontinue its usage, you can click the Revoke access button associated with the API key. This action will invalidate the API key, preventing any further access to your data.
Available API endpoints
The API operates under your Bricqer tenant's domain, under the path /api/v1/. You can use the OPTIONS HTTP method to get a list of accepted input parameters and the output format for each API.
Listed below is a list of all major API endpoints. Each major API endpoint offers its own endpoints for individual object types.
| /api/v1/billing/ | View and manage Bricqer invoices. |
| /api/v1/lego-visual/ | View and search the LEGO® catalog. |
| /api/v1/api-keys/ | List and manage API keys and webhooks. Note: New API keys cannot be created when authenticated through an API key. |
| /api/v1/gbclient/ | Interaction with hardware information. Push order weight or manage labeling settings. |
| /api/v1/administration/ | View and manage VAT settings, contacts and document archives. |
| /api/v1/inventory/ | View and manage inventory locations, inventory items, item colors, batches, purchases and pricing settings. |
| /api/v1/orders/ | View and manage orders, invoices, order packing, order shipments, notification templates, feedback templates and receipt settings. |
| /api/v1/picker/ | View pick routes and manage picked items. |
| /api/v1/shipping/ | View and manage shippers and shipping methods. |
| /api/v1/notifications/ | View previous notifications or listen for new notifications via SSE. |
| /api/v1/franking/ | View and manage shipping labels. |
| /api/v1/messaging/ | View and manage order messages and order message templates. |
| /api/v1/search/ | Instance-wide search. |
| /api/v1/postnl/ | View and manage PostNL shipments. |
| /api/v1/dhl_global_mail/ | View and manage DHL Global Mail shipments. |
| /api/v1/definitions/lego/ | View and manage LEGO® item definitions. |
| /api/v1/lego-brickognize/ | Access to the Brickognize API. |
| /api/v1/lego-partout/ | View and manage partouts or upload inventory files. |
| /api/v1/shops/ebay/ | View and manage eBay products. |
| /api/v1/shops/bol/ | View and manage Bol.com products. |
| /api/v1/shops/noshop/ | View and manage Storefront orders. |
| /api/v1/coupons/ | View and manage automatic coupon campaigns. |
