Struct Docs
Struct.PIM 4
Struct.PIM 4
  • Struct PIM Documentation
  • API Reference
  • 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
    • Localization & segmentation
    • Revisions & changelog
    • Publications
    • Supplier onboarding portal
  • Tutorials
    • Welcome to Struct PIM 4
    • Helpful guides
      • How to search efficiently
      • 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 templates
    • Example projects
      • Working with the API
  • Integration
    • Web API
    • Webhooks
  • Media format
  • API Reference
    • Introduction
    • Endpoints
      • AssetFolders
      • Assets
      • AssetTypes
      • AttributeGroups
      • Attributes
      • AttributeScopes
      • Browse
      • BusinessUnits
      • Catalogues
      • Categories
      • Dimensions
      • Exports
      • EnrichmentInsightSetups
      • GlobalLists
      • Languages
      • Maintenance
      • Miscellaneous
      • Messaging
      • Permissions
      • Products
      • ProductStructures
      • Publications
      • Transactions
      • UserGroup
      • UserRoles
      • Users
      • VariantGroups
      • UserTasks
      • Variants
      • Webhooks
      • Workflows
      • Models
Powered by GitBook
On this page
  1. API Reference
  2. Endpoints

Languages

PreviousGlobalListsNextMaintenance

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

Delete a language in the system

delete
Authorizations
Query parameters
idinteger · int32Optional

Id of language

Responses
200
OK
400
Bad Request
delete
DELETE /v1/Languages HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Get a specific language in the system

get
Authorizations
Path parameters
idinteger · int32Required

Id of language

Responses
200
OK
404
Not Found
get
GET /v1/Languages/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Id": 1,
  "CultureCode": "text",
  "Name": "text",
  "SortOrder": 1
}
  • GETGet all languages added to the system
  • POSTAdd language to system
  • PUTUpdate a language in the system
  • DELETEDelete a language in the system
  • GETGet a specific language in the system

Get all languages added to the system

get
Authorizations
Responses
200
OK
get
GET /v1/Languages HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "Id": 1,
    "CultureCode": "text",
    "Name": "text",
    "SortOrder": 1
  }
]

Add language to system

post
Authorizations
Body

Model to add a language

CultureCodestring | nullableOptional

ISO 639-1 culture code

Namestring | nullableOptional

Presented name of language

SortOrderinteger · int32Optional

Sort order of language

Responses
200
OK
Responseinteger · int32
400
Bad Request
post
POST /v1/Languages HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 50

{
  "CultureCode": "text",
  "Name": "text",
  "SortOrder": 1
}
1

Update a language in the system

put
Authorizations
Body

Represents a language

Idinteger · int32Optional

Unique id of language

CultureCodestring | nullableOptional

Culture code of language

Namestring | nullableOptional

Presented name of language

SortOrderinteger · int32Optional

Sort order of language

Responses
200
OK
400
Bad Request
put
PUT /v1/Languages HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 57

{
  "Id": 1,
  "CultureCode": "text",
  "Name": "text",
  "SortOrder": 1
}
No content