API Translations Publication Type - Field Mappings
Overview
The API Translations publication type maintains data in a single, non-default language. This page documents the specific fields that are populated in the Publication Line entity and its sublines for each source data type.
Entities Used
- PIMX Publication Line - Main line data
- PIMX Publication Subline ML - Translated content in the target language
Entity: Publication Line (Main Language Data)
The Publication Line table holds the base entity data.
Item Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Item No. | Item.No. | Item number (validated) |
Vorlagencode |
Template Code | Item."PIMX Template Code" or Allocation."Template Code" | Template code for the item |
Bezeichnung |
Description | Item.Description → Override with Translation | Base description, then updated by translation lookup |
Bezeichnung 2 |
Description 2 | Item."Description 2" → Override with Translation | Secondary description, then updated by translation lookup |
Description Priority and Translation Override Order:
- Get base Bezeichnung from Item.Description
- Look up PIMX Catalog Translation (Type=Item, target language)
- If translation found: update Bezeichnung with translation
- If translation found: update Bezeichnung 2 with translation
- If translation missing and "Replace Missing Translations" = False: clear description fields
Item Group Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Code | Item Group Code | Item group identifier |
Vorlagencode |
Template Code | Allocation Line."Template Code" > Item Group."Template Code" | Template code - see priority order below |
Bezeichnung |
Description | Item Group.Description → Translation Override | Base description, then overridden by translation |
Bezeichnung 2 |
Description 2 | Item Group."Description 2" → Translation Override | Secondary description overridden by translation |
Template Code Priority Order:
- If Allocation Line has "Template Code" → Use
Allocation Line."Template Code" - Else if Item Group has "Template Code" → Use
Item Group."Template Code"
Description Priority and Translation Override Order:
- Get base description from Item Group.Description (and Beschreibung 2 from Item Group."Description 2")
- Look up PIMX Catalog Translation (Type=Item Group, target language)
- If translation found: Override Bezeichnung and Bezeichnung 2
- If translation missing and "Replace Missing Translations" = False: Clear fields
Product Group Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Code | Product Group Code | Product group identifier |
Vorlagencode |
Template Code | Allocation Line."Template Code" > Product Group."Template Code" | Template code - see priority order below |
Bezeichnung |
Description | Product Group.Description → Translation Override | Base description, then overridden by translation |
Bezeichnung 2 |
Description 2 | Product Group."Description 2" → Translation Override | Secondary description overridden by translation |
Template Code Priority Order:
- If Allocation Line has "Template Code" → Use
Allocation Line."Template Code" - Else if Product Group has "Template Code" → Use
Product Group."Template Code"
Description Priority and Translation Override Order:
- Get base description from Product Group.Description (and Beschreibung 2 from Product Group."Description 2")
- Look up PIMX Catalog Translation (Type=Product Group, target language)
- If translation found: Override Bezeichnung and Bezeichnung 2
- If translation missing and "Replace Missing Translations" = False: Clear fields
Chapter Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
No. | Chapter Code | Chapter identifier |
Vorlagencode |
Template Code | Allocation Line."Template Code" > Chapter."Template Code" | Template code - see priority order below |
Bezeichnung |
Description | Chapter.Description → Translation Override | Base description, then overridden by translation |
Bezeichnung 2 |
Description 2 | Chapter."Description 2" → Translation Override | Secondary description overridden by translation |
Template Code Priority Order:
- If Allocation Line has "Template Code" → Use
Allocation Line."Template Code" - Else if Chapter has "Template Code" → Use
Chapter."Template Code"
Description Priority and Translation Override Order:
- Get base description from Chapter.Description (and Beschreibung 2 from Chapter."Description 2")
- Look up PIMX Catalog Translation (Type=Chapter, target language)
- If translation found: Override Bezeichnung and Bezeichnung 2
- If translation missing and "Replace Missing Translations" = False: Clear fields
Catalog Group Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Code | Catalog Group Code | Catalog group identifier |
Vorlagencode |
Template Code | Allocation Line."Template Code" > Catalog Group."Template Code" | Template code - see priority order below |
Bezeichnung |
Description | Catalog Group.Description → Translation Override | Base description, then overridden by translation |
Bezeichnung 2 |
Description 2 | Catalog Group."Description 2" → Translation Override | Secondary description overridden by translation |
Template Code Priority Order:
- If Allocation Line has "Template Code" → Use
Allocation Line."Template Code" - Else if Catalog Group has "Template Code" → Use
Catalog Group."Template Code"
Description Priority and Translation Override Order:
- Get base description from Catalog Group.Description (and Beschreibung 2 from Catalog Group."Description 2")
- Look up PIMX Catalog Translation (Type=Catalog Group, target language)
- If translation found: Override Bezeichnung and Bezeichnung 2
- If translation missing and "Replace Missing Translations" = False: Clear fields
Catalog Item Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Code | Catalog Item Code | Catalog item identifier |
Vorlagencode |
Template Code | Allocation Line."Template Code" | Template code from Allocation Line |
Bezeichnung |
Description | Catalog Item.Description → Translation Override | Base description, then overridden by translation |
Bezeichnung 2 |
Description 2 | Catalog Item."Description 2" → Translation Override | Secondary description overridden by translation |
Description Priority and Translation Override Order:
- Get base description from Catalog Item.Description (and Beschreibung 2 from Catalog Item."Description 2")
- Look up PIMX Catalog Translation (Type=Catalog Item, target language)
- If translation found: Override Bezeichnung and Bezeichnung 2
- If translation missing and "Replace Missing Translations" = False: Clear fields
Document Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
No. | Document Code | Document identifier |
Vorlagencode |
Template Code | Allocation Line."Template Code" > Document."Template Code" | Template code - see priority order below |
Bezeichnung |
Description | Document.Description → Translation Override | Base description, then overridden by translation |
Bezeichnung 2 |
Description 2 | Document."Description 2" → Translation Override | Secondary description overridden by translation |
Link |
Link | Document."Public Link" | Public URL for the document |
MIME Type |
MIME Type | Document."Mime Type" | MIME type of the document |
Source File Name |
Source File Name | Document."Source File Name" | Original file name |
Document Usage |
Document Usage | Document."Document Usage" | Document usage classification |
Repository Type |
Repository Type | Document."Repository Type" | Type of file repository |
External Container Id |
External Container Id | Document."External Container Id" | External container reference |
External Id |
External Id | Document."External Id" | External document identifier |
Template Code Priority Order:
- If Allocation Line has "Template Code" → Use
Allocation Line."Template Code" - Else if Document has "Template Code" → Use
Document."Template Code"
Description Priority and Translation Override Order:
- Get base description from Document.Description (and Beschreibung 2 from Document."Description 2")
- Look up PIMX Catalog Translation (Type=Document, target language)
- If translation found: Override Bezeichnung and Bezeichnung 2
- If translation missing and "Replace Missing Translations" = False: Clear fields
Document Line Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
No. | Document Code | Document identifier |
Bezeichnung |
Description | Document.Description → Translation Override | Base description, then overridden by translation |
Link |
Link | Document."Public Link" | Public URL |
MIME Type |
MIME Type | Document."Mime Type" | MIME type |
Source File Name |
Source File Name | Document."Source File Name" | Original file name |
Document Usage |
Document Usage | Document."Document Usage" | Usage classification |
Repository Type |
Repository Type | Document."Repository Type" | Repository type |
External Container Id |
External Container Id | Document."External Container Id" | External container ID |
External Id |
External Id | Document."External Id" | External document ID |
Description Priority and Translation Override Order:
- Resolve base description via Allocation Line or Document (per Manual Descriptions flag)
- Look up PIMX Catalog Translation (Type=Document, target language)
- If translation found: Override Bezeichnung
- If translation missing and "Replace Missing Translations" = False: Clear field
Keyword Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
ID | Keyword."Keyword ID" or Classification | Keyword identifier based on ID source |
Priority |
Sequence No. | Keyword.Order | Keyword priority/order |
Bezeichnung |
Text | Keyword.Description → Translation Override | Keyword text, overridden by translation lookup |
Description Priority and Translation Override Order:
- Get base Keyword.Description
- Look up PIMX Catalog Translation (Type=Keyword, target language)
- If translation found: Override Bezeichnung with translation
- If translation missing and "Replace Missing Translations" = False: Clear field
Feature Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
No. | Feature Number or Reference/Classification | Feature identifier based on ID source |
Bezeichnung |
Name | Product Feature.Description → Translation Override | Feature name, overridden by translation lookup |
Type Enum |
Type | Product Feature."Field Type" | Feature data type |
Feature Value Type |
Value Type | Derived from Product Feature."Field Type" | Value type (Text, Number, Range, Boolean, etc.) |
Display Text Value |
Value (Text) | Product Feature.Value | Text representation |
Display Number Value |
Value (Number) | Product Feature."Value Numeric" | Numeric value |
Display Number To Value |
Value To (Number) | Product Feature."Value Numeric To" | Range end value |
Value Logical |
Value (Boolean) | Product Feature."Value Logical" | Boolean value |
Value Date |
Value (Date) | Product Feature."Value Date" | Date value |
Importance |
Importance | Product Feature.Importance | Feature importance level |
Relevance |
Relevance | Product Feature.Relevance | Feature relevance level |
Usage Type Code |
Usage Type | Product Feature."Usage Type Code" | Usage type |
Description Priority and Translation Override Order:
- Get base Product Feature.Description
- Look up PIMX Catalog Translation (Type=Feature, target language)
- If translation found: Override Bezeichnung with translation
- If translation missing and "Replace Missing Translations" = False: Clear field
Variant Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Code | Item Variant Code | Variant identifier |
Bezeichnung |
Name | Item Variant.Description → Translation Override | Variant text, overridden by translation lookup |
Description Priority and Translation Override Order:
- Get base Item Variant.Description
- Look up PIMX Catalog Translation (Type=Variants, target language)
- If translation found: Override Bezeichnung with translation
- If translation missing and "Replace Missing Translations" = False: Clear field
Description Text Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
No. | Description Text.Number | Text identifier |
Langtext |
Long Text | (Not used in Publication Line) | Not populated in main line |
Description Title |
Title | PIMX Description Text Translation."Description Title" | Translated title from translation table |
Description Title 2 |
Subtitle | PIMX Description Text Translation."Description Title 2" | Translated subtitle from translation table |
Product Content Data
| Field | Source | Description |
|---|---|---|
Level |
Product Content.Level | Content hierarchy level |
Priority |
Product Content."Line No." | Content priority/order |
Vorlagencode |
Product Content."Template Code" | Template code |
Data (Blob) |
Product Content."Data Blob" | HTML or rich content data |
Content Header Data
| Field | Source | Description |
|---|---|---|
Level |
0 (Fixed) | Fixed at 0 for headers |
Priority |
0 (Fixed) | Fixed at 0 for headers |
Vorlagencode |
Content Header."Template Code" | Template code |
Data (Blob) |
Content Header."Data Blob" | HTML or rich content |
Entity: Publication Subline ML (Translated Data)
IMPORTANT: API Translations does NOT create sublines in PIMX Publication Subline ML
Unlike Multilanguage API and Multilanguage Print, the API Translation type:
- Updates the Publication Line fields with translated data in the target language
- Does NOT create subline records for translation data
- All data (both main entity fields and translations) stays in the
PIMX Publication Linetable
The translation lookup is performed, but only to update the Publication Line fields directly:
- Queries
PIMX Catalog Translationfor the target language - Updates
BezeichnungandBezeichnung 2fields with translated values - Updates
Cross-Reference Type Desc.with translated text - No persistent subline storage - translations are applied directly to the line
Cross-Reference Data
| Field | Source | Description |
|---|---|---|
Vorlagencode |
Allocation."Template Code" | Template code |
Priority |
Allocation.Order | Sort order |
| Cross Reference Description | Translation record | Cross-reference description in target language (updated on Publication Line) |
Important Processing Rules
Single Language Per Channel
- Only one language is generated (the target language)
- Main language data is excluded from the exported/API output
- Translation data is applied directly to Publication Line fields, not stored in sublines
Translation Lookup and Field Update
Translation lookup process:
PIMX Catalog Translation where:
Type = <Entity Type>
Code = <Entity Code>
Language Code = <Target Language from Publication Header>
If translation found:
- Update
Publication Line.Bezeichnungwith translated Description - Update
Publication Line."Bezeichnung 2"with translated Description 2 - Update
Cross-Reference Type Desc.with translated cross-reference text
Missing Translation Handling
Based on Publication Group "Replace Missing Translations" setting:
- DefaultValue: Use source entity description if translation missing
- False: Clear description fields if translation is missing
- Translation data updates are applied directly on the Publication Line, not in sublines
NO Subline Creation
- Sublines are NOT created for API Translation
- All translated data is stored in the
PIMX Publication Linetable - This differs from Multilanguage API which creates multiple sublines per language
Field Mapping Summary
Core Fields (All Entities)
| Field | Source | Location |
|---|---|---|
Nummer |
Entity ID | Publication Line |
Vorlagencode |
Allocation/Entity | Publication Line |
Priority |
Allocation/Entity | Publication Line |
Language |
Publication Channel (target lang) | Publication Line |
Translated Fields
| Field | Source | Location |
|---|---|---|
Beschreibung |
PIMX Catalog Translation | Publication Line (direct update) |
Beschreibung 2 |
PIMX Catalog Translation | Publication Line (direct update) |
Data Flow
- Load Base Data: Load source entity
- Create Publication Line: Populate with entity data
- Apply Channel Allocation: Use InitFromChannel() to apply description overrides
- Look Up Translation: Query PIMX Catalog Translation for target language
- Update Line Fields: Apply translation data directly to Publication Line fields:
Bezeichnung← Translated DescriptionBezeichnung 2← Translated Description 2Cross-Reference Type Desc.← Translated cross-reference text
- No Subline Storage: Unlike other types, NO sublines are created
- Export: Single language output in target language only, stored in Publication Line
Channel Allocation Impact on Descriptions
Like API (Simple), API Translations also uses InitFromChannel():
Description Resolution:
- If Channel Allocation has "Manual Descriptions" = true:
- Use the manually configured
Channel Allocation.Description
- Use the manually configured
- If Channel Allocation has "Manual Descriptions" = false:
- Use source entity description
Then:
- Translation lookup attempts to replace these descriptions with target language versions
- If translation found and "Replace Missing Translations" = DefaultValue: use translation
- If translation missing and "Replace Missing Translations" = False: clear the field
Use Cases
- Regional APIs for specific language markets
- Language-specific integrations (e.g., French-only marketplace)
- Alternative language exports without main language
- Dedicated language APIs for secondary markets
- Geographic localization for specific regions
Key Differences from Other Types
| Aspect | API Simple | API Translation | Multilanguage API | ML Print |
|---|---|---|---|---|
| Languages | 1 (main) | 1 (alt) | Main + all | Main + all |
| Sublines Created | None | None | Multiple | Multiple |
| Translation Lookup | No | Yes | Yes | Yes |
| Storage | Publication Line | Publication Line | Sublines + Line | Sublines + Line |
| Source | Entity fields | Translations applied to Line | Translations | Translations |
| Use Case | Single lang | Regional | Global | Print/Design |