API reference

The API of Struct PIM is the go to for all integrations, whether the integration updates data in the system or simply gets data from the system. The API reference gives you a complete overview of the endpoints available as well as explanations of the data structures used

Learn how to set up API keys and authenticate requests towards the API.

#Available from v.3.2.0 Assets are files that can be stored in the system and referenced on products, variants, categories and global list values. Assets uploaded to the system are assigned a URL based on the assets file name. Each image asset can be auto-scaled, cropped and formatted by adding parameters to the URL of the asset. Thus, you should only upload an image once in the highest quality you will need it and the system will take care of any scaling automatically. Assets are organized in folders, which can be nested within each other.

Attribute groups are used to organize attributes in the system for easy presentation in groups on different channels. Eg. if you want to display a long list of technical specifications, but grouped under different headlines, attribute groups are here for that purpose.

Attributes are the central element in the system. They describe the data fields available on entities such as products, variants, categories and global list values. A range of attribute types exist to allow for flexible modelling of your data structure.

Attribute scopes are used to organize your attributes in different scopes, so you can easily work with collections of attributes based on their attribute scopes. If for example you want to render a table with all technical specifications for a product on your website, what are the tehcnical specification attributes? By adding the technical specifications attributes to a specific attribute scope, your can easily find the collection of attributes to render in this table.

#Available from v.3.6.0 The browse endpoints allows external partners access to a specified dataset within the PIM system

Catalogues are root elements in category structures used for organizing products logically. A master catalogue allows setting up attributes on categories that are then available on products in those categories. Different catalogues can be used for diffrent assortments, category structures etc.

Categories are used to create hierarchical structures within a catalogue. Categories serves as a means for structuring products in meaningful classifications

#Available from v.3.2.0 Collections are dynamic groupings of either products or variants. Collections contain a range of products or variants that match a certain query specified on the collection.

#Available from v.3.5.0 Enrichment insight setups are used to define insights that are continuously calculated for products, variants or categories in the system. The Enrichment insight setup defines which data is required for an entity to be considered 100% fulfilled for the insight setup in question.

#Available from v.3.10.0 Build and manage exports from the PIM system

Global lists define reusable object structures that can be referenced on products, variants, categories or within global lists themselves. A global list uses an attribute to define the data model for values in the global list. Using Complex attributes as the data model allows for complex value models for each global list value object.

Languages are the localizations of which data can exist in the PIM installation. If users shall be able to enter data in a specific culture, that language must be added to the system. All languages in the system are based on ISO Culture codes. Each ISO culture code can only be added once, meaning no two languages can use the same culture code

Maintenance is used to start maintenance tasks

The Miscellaneous endpoints allows you to get general information about the status of the API and the PIM installation as well as the ability to manage objects which are shared between entities in Struct PIM.

Products are the central element of the system. Product entities contain attribute data, classifications in categories and variants. The data model for products are described by product structures.

#Available from v.3.2.0 Product structures define models for products and variants in the system. Specifically, product structures define which properties are available on products and variants as well as how they are presented in the backoffice UI within tabs and sections.

Use security endpoint to manage permissions and security settings in the system programmatically. Permissions can be created and added to resource actions to define granular permission control of what users can do in the system

#Available from v.3.7.0 Every change in is recorded in a transaction. Use the transaction endpoints to get information on transactions and changes to entities within each of these.

#Available from v.3.11.0 User tasks are used to create tasks for users in the system.

#Available from v.3.11.0 Variant groups are used to contain data for a group of variants on a product. Variant group entities contain attribute data, classifications in categories and variants. The data model for variant groups are described by product structures.

Variants are sub elements of products that define different variations a product exist in, ex. different colors, sizes etc. Variants cannot exist on its own as they need to be attached to a product. Variants have defining attributes which defines the attributes variants of a product vary on, ex. color and size, with and length etc.

#Available from v.3.11.0 Webhooks are used to notify external systems of changes within Struct PIM through a web request