Documentation
fmcgProducts documentation
Technical documentation for integrators. This first section is the JSON API: authenticate, update master data, check status, send to GS1, and fetch views, product sheets and images.
The API runs on each customer instance:
https://{instance}.fmcgproducts.dk/apiThe same instance also serves a live OpenAPI description at /api/openapi. These pages explain the public API from the product source. They are in English.
JSON API
- JSON APIWhat the fmcgProducts JSON API does, where it runs, and how update, validation and fetch fit together.
- AuthenticationAPI keys, login sessions, CORS, language, caching and the shape of error responses.
- Identifiers and fieldsProduct id format, required JSON fields, grid rows, unit types, and the field and keyword catalogues.
Also in this section
- Fetch productsRead one unit as JSON by product id, export profile, item number, or all visible fields, including history.
- Update productsCreate or patch products with POST /api, including delta updates, dry-run validation, grids and batch requests.
- StatusRead GS1 and fmcgProducts status for one product, all products, or a selected list, including validation errors.
- Send to GS1Publish a hierarchy to GS1, update and send in one call, or withdraw a product from GS1.
- Views and ExcelList products from a named view as JSON, XML or Excel, with pagination, export profiles and change filters.
- PDF and web sheetsPublic URLs for branded product sheets as PDF or HTML, by product id or internal item number.
- ImagesCompany logo from the API and on-the-fly scaled product images from the media server host.
- WebhooksHow fmcgProducts POSTs JSON to your URL when a product is created or updated, including payload fields and filters.
- ReferenceCompact list of public JSON API endpoints, plus OpenAPI on the instance.