Struct Docs
Struct.PIM v3
Struct.PIM v3
  • Struct PIM Documentation
  • API Reference
  • Changelog
  • Latest updates from Struct HQ
  • Latest updates in Documentation
  • Fundamental concepts
    • Get familiar with Struct PIM
    • Catalogues & categories
    • Products & variants
    • Attributes
    • Product structures
    • Identifiers
    • Global lists
    • Collections
    • Security management
    • Localization & segmentation
    • Revisions & changelog
    • Dashboard
    • Publications
    • Supplier onboarding portal
  • Tutorials
    • Helpful guides
      • How to use product models
      • How to use product catalogues
      • How to use enrichment insights
      • How to use Import
        • How to import products
        • How to import data into a list property on entities
        • How to import categories
        • How to import with media
        • How to use File mappings
        • How to use Validation rules during import
        • How to use Transformation during import
      • How to use Business rules
        • How to set up and edit a business rule
        • How to use conditions in a business rule
        • How to set up business rules to trigger other business rules
        • How to automatically set release status
        • How to automatically calculate the size of a variant
        • How to automate price conversion
        • How to assign documents to a product when it is created
        • How to manage product identifiers
    • Example projects
      • Working with the API
      • Product viewer
      • Publications 3.15
  • Integration
    • Integrate with Struct PIM
    • Web API
    • Webhooks
    • Media format
  • Reference
    • How to use Struct PIM
    • Search
      • Manage columns
      • Bulk actions
      • Search help
    • Tasks
      • Task details
    • Global lists
      • Global list details
    • Product catalogues
      • Product catalogue details
        • General settings
        • Data model
          • Tab types
            • Tab details
          • Section types
            • Section details
          • Property types
            • Property details
        • Workflow
        • Display settings
        • Identifiers
          • Identifier details
    • Collections
    • Background tasks
    • Publications
      • Prints
        • Print details
      • Templates
        • Edit template
          • Template settings details
          • Template design
            • Header/Footer elements
            • Template preview settings
    • Product model setup
      • Product structures
        • Product structure details
          • General settings
          • Data model
            • Tab types
              • Tab details
            • Section types
              • Section details
            • Property types
              • Property details
          • Variation definitions
            • Variation definition details
          • Product wizards
          • Variant group create wizard
          • Variant create wizard
          • Display settings
          • Identifiers
            • Identifier details
      • Attributes
        • Attribute details
          • Data type details
      • Attribute groups
        • Attribute group details
      • Attribute scopes
      • Dimensions
        • Dimension details
      • Enrichment Insights
        • Enrichment insight details
        • Insights setup
          • Insight details
      • Business rules
        • Business rule details
          • Triggers
            • Trigger details
              • Trigger configuration details
          • Conditions
            • Condition details
              • Condition configuration details
          • Actions
            • Action details
              • Action configuration details
      • Changelog
      • Workflows
        • Workflow details
        • Workflow states
          • Workflow state details
          • Workflow transitions
            • Workflow transition details
    • Settings
      • API configuration
        • API configuration details
          • API configuration basic settings
          • API configuration advanced settings
      • Webhooks
        • Webhook details
          • Webhook advanced details
      • Messaging
        • Messaging details
      • Security
        • User settings
        • User group permissions
      • Setup
        • General
        • Supplier portal email
        • Supplier portal
        • Archive reasons
        • Scheduled tasks
        • Attribute indexing
        • User settings
      • Permission Management
        • Permissions
        • Permission Groups
      • Languages
      • Maintenance
      • License
      • Extensions
        • Extensions details
        • URL details
      • File mappings
        • File Mapping details
      • AI assistant
        • Translation
        • Text generation
    • Dashboard
      • Saved searches
        • Saved searches details
      • Dashboard tabs
      • Widget details
        • Widget types
Powered by GitBook
On this page
  1. Fundamental concepts

Identifiers

Identifiers in Struct PIM link external keys to internal IDs, enabling efficient updates and retrievals using known external identifiers.

What are identifiers

Identifiers are used to create indexes of values of attributes that can be used from the API to find products, variants or categories based on a unique identifier in an external system.

As any update request to Struct PIM requires the internal id of the resource being updated, a mechanism must exist to resolve this internal id based on a known key. For this, implementors will create identifiers in Struct PIM defning the maps between externally known keys and the internal id of the resource in Struct PIM.

Example: In an ERP system, a product has a SKU, which is used to uniquely identify the product. An integration job created the product in Struct PIM and the SKU is written to a "SKU" attribute on the product. Later, when the integration job runs again, it needs to update the product. In order to update an existing product, the internal id assigned to the product in Struct PIM must be known, but the integration job only knows the SKU from the ERP system. Because an identifier has been setup on the SKU attribute in Struct PIM, the integration job can request the internal id of the product based on the SKU it knows from the ERP system. From the internal id it is able to update the product in Struct PIM

PreviousProduct structuresNextGlobal lists

Last updated 5 months ago