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
  • About the demo project
  • Getting started
  • Autogenerate C# classes
  • TLS
  1. Tutorials
  2. Example projects

Working with the API

Get an introduction into working with the Struct PIM Api from Visual Studio and C#

PreviousExample projectsNextProduct viewer

Last updated 2 months ago

About the demo project

Use this demo project to get familiar with the Web API. This project shows examples of getting product-, variant and category data as well as how to create and update these.

Furthermore, examples are shown on how to search products and work with global lists through the API.

For full documentation of the API, view the

Getting started

The project is a complete Visual Studio solution, using the Struct.PIM.Api.Client, available in Nuget, to fetch data from a Struct PIM instance.

All you need to do, is unzip the downloaded project and set up the Url for your Struct PIM instance as well as an API key for that instance and you are good to go.

Autogenerate C# classes

We provide a T4Template which, using the API, can autogenerate C# classes for you matching the models in Struct PIM, yielding strongly typed models for you to use with the API.

TLS

Depending on the environment you are connecting to you may need to specify TLS.

For the application using the Struct.PIM.Api.Client, specify below:

ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12

API reference
5MB
structpimapiv3demo.zip
archive
Download demo project here
2KB
structpimmodelgenerator_26062023.zip
archive
Download T4Template here