API Interface¶

Within the Navertica Product Platform Management module, an API interface is included, which can be used to export product data outside the module and present it. This interface is primarily intended for reading data; therefore, writing data is allowed only in selected cases.

A collection with examples of API usage, including sample data, is available at the following link:

Click here to download the collection

endpoint pimProductPlatforms¶

For the purpose of obtaining data related to the current product platform setup, the pimProductPaltforms endpoint (in the navertica\productPlatforms group) is prepared, which will be used to transfer information about product platforms and their main parameters. This endpoint will be based mainly on the Product Platforms table and supports exclusively the GET method (i.e., it does not give external systems the ability to create, modify, or delete existing records).

endpoint pimItems¶

For the purpose of transferring data about base product cards, the pimItems endpoint (in the navertica\productPlatforms group) was created, which serves to transfer information about the list of existing products. This endpoint will be based mainly on the Item table (T27 Item) and supports exclusively the GET method (it is therefore not expected that an external system would create, modify, or delete records).

endpoint pimItemVariants¶

For the purpose of providing data about current item variants, the pimItemVariants endpoint (in the navertica\productPlatforms group) was created, which serves to transfer information about product variants. This endpoint will be based mainly on the Item Variants table and supports exclusively the GET method (it therefore does not allow creation, changes, or deletion of records). This endpoint can be called separately or as an expand under pimItems.

endpoint pimItemTranslations¶

For the purpose of transferring basic translations of product descriptions, the pimItemTranslations endpoint (in the navertica\productPlatforms group) was created, which serves to transfer information about standard basic translations of product names and their variants. This endpoint will be based mainly on the Item Translation table and supports exclusively the GET method (it therefore does not allow creation, changes, or deletion of records).

The endpoint can be called separately, or it can be called as an expand under pimItems, or pimItemVariants.

endpoint pimItemReferences¶

For the purpose of transferring alternative identifiers of products or their variants, the pimItemReferences endpoint (in the navertica\productPlatforms group) was created, which serves to transfer information about standard item cross-references (i.e., alternative item identifiers from the perspective of a customer/vendor or for internal use). This endpoint will be based mainly on the Item References table and supports exclusively the GET method (it is therefore not possible to create, change, or delete records).

The endpoint can be called separately, or it can be called as an expand under pimItems, or pimItemVariants.

endpoint pimItemUoMs¶

For the purpose of transferring information about item units of measure, the pimItemUoMs endpoint (in the navertica\productPlatforms group) was created, which serves to transfer information about standard item units of measure (i.e., units of measure and their conversions). This endpoint will be based mainly on the Item Units of Measure table and can be called exclusively with the GET method (it is therefore not expected that an external system would be able to create, modify, or delete records).

The endpoint can be called separately, or it can be called as an expand under pimItems.

endpoint pimCategories¶

For the purpose of transferring information about item categories, the pimCategories endpoint (in the navertica\productPlatforms group) was created, which serves to transfer information about item category trees defined in BC. This endpoint will be based mainly on the Item Categories table and will be callable exclusively with the GET method (it is therefore not expected that an external system would be able to create, modify, or delete records).

The endpoint can be called separately.

endpoint pimRelations¶

For the purpose of transferring information about currently valid entity relations within the PIM module, the pimRelations endpoint (in the navertica\productPlatforms group) was created, which serves to transfer information about relations between individual entities used within PIM. This endpoint will be based mainly on the PIM Entity Relations table and will support the GET, POST, PATCH, and DELETE methods, because it may be desirable to transfer into BC relations generated by an external system (e.g., an e-shop is connected to artificial intelligence that generates bundles or other up-selling/cross-selling variants, and these need to be further used in BC).

The endpoint can be called separately.

endpoint pimLabelAssignments¶

For the purpose of transferring information about assigned labels, the pimLabelAssignments endpoint (in the navertica\productPlatforms group) was created, which will be used to transfer information about recorded PIM label assignments. This endpoint will be based mainly on the PIM Label Assignments table and will support exclusively the GET method (it is therefore not expected that an external system would be able to create, modify, or delete records).

The endpoint can be called separately, or it can be called as an expand under pimItems, or pimItemVariants.

endpoint pimLabels¶

For the purpose of transferring the current list of labels, the pimLabels endpoint (in the navertica\productPlatforms group) will be used to transfer information about PIM labels set up in BC. This endpoint is based mainly on the PIM Labels table and supports exclusively the GET method (it is therefore not expected that an external system would be able to create, modify, or delete records).

The endpoint can be called separately.

endpoint pimLabelTranslations¶

For the purpose of transferring translations of individual labels defined in BC, the pimLabelTranslations endpoint (in the navertica\productPlatforms group) will be used to transfer information about PIM label translations. This endpoint will be based mainly on the PIM Label Translations table (T4028251 NVR PP Label Translation) and supports exclusively the GET method (it is therefore not expected that an external system would be able to create, modify, or delete records).

The endpoint can be called separately, or it can be called as an expand under pimLabels.

endpoint pimPlatformAssignments¶

For the purpose of transferring information about assigning products and categories to individual product platforms, the pimPlatformAssignments endpoint (in the navertica\productPlatforms group) is used to transfer information about placing a product into category trees and optionally into product platforms. This endpoint will be based mainly on the Product Platform Assignments table and supports exclusively the GET method (it is therefore not expected that an external system would be able to create, modify, or delete records).

The endpoint can be called separately, or it can be called as an expand under pimItems and pimItemVariants.

endpoint pimListedItems¶

For the purpose of transferring information about listed partner items, a new pimListedItems endpoint (in the navertica\productPlatforms group) was created, which will be used to transfer information about the list of listed items of individual partners. This endpoint is based mainly on the PIM Listed Items table and supports exclusively the GET method (it is therefore not expected that an external system would be able to create, modify, or delete records).

endpoint pimAttributeAssignmnets¶

For the purpose of transferring information about the current assignment of item attributes, a new pimAttributeAssignment endpoint (in the navertica\productPlatforms group) was created, which serves to transfer information about assigning attribute values to individual entities. This endpoint will be based mainly on the Extended Item Attribute Value Mapping table and will support exclusively the GET method (it therefore will not allow creating, changing, or deleting records).

The endpoint can be called separately, or it can be called as an expand under pimAttributes.

endpoint pimAttributes¶

For the purpose of transferring information about existing item attributes, the pimAttributes endpoint (in the navertica\productPlatforms group) was created, which serves to transfer information about item attributes. This endpoint will be based mainly on the Item Attributes table and supports exclusively the GET method (it therefore will not allow inserting, changing, or deleting records).

The endpoint can be called separately.

endpoint pimAttributeTranslations¶

For the purpose of transferring translations defined for attributes, a new pimAttributeTranslations endpoint (in the navertica\productPlatforms group) was created, which serves to transfer information about attribute translations. This endpoint is based mainly on the Item Attribute Translations table and supports exclusively the GET method (it is therefore not expected that an external system would be able to create, modify, or delete records).

The endpoint can be called separately, or it can be called as an expand under pimAttributes.

endpoint pimAttributeValues¶

For the purpose of transferring the list of attribute values, the pimAttributeValues endpoint (in the navertica\productPlatforms group) is intended, which serves to transfer information about attribute values. This endpoint is based mainly on the Item Attribute Values table and supports exclusively the GET method (it is therefore not expected that an external system would be able to create, modify, or delete records).

The endpoint can be called separately, or it can be called as an expand under pimAttributes.

endpoint pimAttributeValueTranslations¶

For the purpose of transferring translations of attribute values, the pimAttributeValueTranslations endpoint (in the navertica\productPlatforms group) was prepared, which serves to transfer information about attribute value translations. This endpoint is based mainly on the Item Attribute Value Translations table and supports exclusively the GET method (it is therefore not expected that an external system would be able to create, modify, or delete records).

The endpoint can be called separately, or it can be called as an expand under pimAttributeValues.

endpoint pimTexts¶

For the purpose of transferring extended texts, the pimTexts endpoint (in the navertica\productPlatforms group) was created, which serves to transfer PIM text data to external systems. This endpoint is based mainly on the PIM Text table and supports exclusively the GET method (it is therefore not expected that an external system would be able to create, modify, or delete records).

The endpoint can be called separately, or it can be called as an expand under pimItems, pimItemVariants, and pimCategories.

endpoint pimPrices¶

For the purpose of transferring information about current prices, the pimPrices endpoint (in the navertica\productPlatforms group) was created, which serves to transfer information about purchase and sales prices of products. This endpoint is based mainly on the Price List Lines table and supports exclusively the GET method (it is therefore not expected that an external system would be able to create, modify, or delete records).

The endpoint can be called separately.

endpoint pimMedia¶

For the purpose of transferring related media, a new pimMedia endpoint will be created (in the navertica\productPlatforms group), which serves to transfer information about assigned documents, media, links, or images. This endpoint is based mainly on the PIM Media table and supports exclusively the GET method (it is therefore not expected that an external system could create, modify, or delete records).

The endpoint can be called separately, or it can be called as an expand under pimItems, pimItemVariants, and pimCategories.