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. Integration

Web API

Struct PIM ships with a standard REST Api, that allows for any interaction with Struct PIM resources. Use this to integrate your applications with Struct PIM

PreviousIntegrate with Struct PIMNextWebhooks

Last updated 5 months ago

About the API

The REST Api ships with every installation of Struct PIM. Access to the API is restricted by API keys issued within the Struct PIM application.

Newer versions of the API may include new features, but a major version (eg. v.3.) is always backwards compatible.

C# API client

We provide a C# API client, available in the official Nuget feed (Struct.PIM.Api.Client). We recommend using this, if you are working in C#, as it gets you going a lot faster compared to wrapping the API yourself.

API documentation

If you are implementing your integration using .NET and C#, we recommend having a look at our Demo project, which shows examples on how to get data through the Api and how to insert data using the Api. When you start implementing your integration to Struct PIM, you might want to go over the detailed .

Performance

The API is build for updating and reading large amounts of data in short time. All areas has extended support for batching data together to make the updating as smooth as possible.

We do not recommend using the API as a direct source for presentation if performance is the main focus. You should always transfer the data needed for presentation, from the API, to a fast read and search friendly cache layer.

This ensures optimal performance at all times.

API documentation