TODO
UPDATE FOR PIMICS 13.0: API documentation needs to be updated to reflect new fields added in version 13.0:
Documents API changes:
/documentsendpoint now includes features and keywords fields- Update API reference to document these new fields (data types, descriptions, examples)
- Provide before/after JSON response examples
Cross-References API changes:
- Cross-reference responses now include Cross Reference Type Code and Description fields (with translations)
- Document the new fields in the API reference
- Provide examples showing how cross-reference types are returned
- Add guidance for e-commerce integrations (Sana, etc.)
Export Source Types:
- Document new
PublicationandTranslationsource types available for Excel/CSV exports - Add examples of how to use these source types for multi-language exports
Action required:
- Update Swagger/OpenAPI spec files
- Update compact and integrated API reference pages
- Create API migration guide from v12.x to v13.0
- Add code samples showing how to handle new optional fields
- Verify backward compatibility notes are clear
API: Overview
Pimics API is build as extension of Business Central API.
Available API end-points
| Name | Publications |
| Scope | Provide data to channels like e-commerce, POS, InDesign, etc. |
| URL Path | {BaseUriWithEnvironment}/api/pimics/publication/v2.0/{EndpointAndParameters} |
| Links | Swagger: Pimics 12.0/publications |
Reference Browsing Options
You can browse the same version of the API reference in these ways:
- A brief API overview is available as an Integrated API reference. It provides keyword search and navigation, among other things.
- A condensed description of the API is available as a Compact API reference. The list of methods is followed by models for each method. Alternatively, you can view a single web page in full screen mode.
- The third option is to view the API reference using an external tool. Using the API Swagger Viewer, the complete reference will be displayed in a new browser tab/window.