Import
This document describes the format of the import data and the values that can be configured to control how the importer handles that data.
Execution
The importer is implemented as a command line application of bin/console. To run it use:
path/to/project/bin/console configuratorware:import [parameters]
For a description of parameters see: Parameters
The importer can also be called with a POST request via the Connector API, see Rest APIs
Important properties
The following properties control access and visibility of items. Find a complete explanation for all properties: Nodes
Property |
Possible values |
|---|---|
itemIdentifier |
string to identify and open a product: “https://[configuratorURL]/identifier:{itemIdentifier}” |
itemStatusIdentifier |
“available”, “not_available” |
visualizationModeIdentifier |
“2dLayer”, “2dVariant”, “3dScene”, “3dVariant” |
configurationMode |
“creator”, “designer”, “creator+designer” |
Examples
JSON: Creator
[
{
"itemIdentifier": "softshell_creator_2d",
"externalId": "softshell_creator_2d_external",
"texts": [
{
"iso": "en_GB",
"title": "Softshell creator 2D",
"description": "",
"abstract": "Customizable softshell jacket"
},
{
"iso": "de_DE",
"title": "Softshell creator 2D",
"description": "",
"abstract": "Anpassbare Softshell-Jacke"
}
],
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/creator/item/softshell_2d/softshell_2d_red_thumb.jpg",
"itemImage": "https://pkg.configuratorware.com/demo-items/creator/item/softshell_2d/softshell_2d_red.jpg"
},
"minimumOrderAmount": 1,
"accumulateAmounts": true,
"visualizationModeIdentifier": "2dLayer",
"configurationMode": "creator",
"itemStatusIdentifier": "available",
"prices": [
{
"channelIdentifier": "_default",
"bulkPrices": [
{
"itemAmountFrom": 1,
"price": 59.00,
"priceNet": 0
},
{
"itemAmountFrom": 10,
"price": 54.00,
"priceNet": 0
}
]
}
],
"attributes": [
{
"attributeIdentifier": "myNumberAttributeIdentifier",
"type": "number",
"texts": [],
"attributeValues": [
{
"value": 10,
"translations": []
}
]
},
{
"attributeIdentifier": "myBooleanAttributeIdentifier",
"type": "boolean",
"texts": [],
"attributeValues": [
{
"value": true,
"translations": []
}
]
},
{
"attributeIdentifier": "myStringAttributeIdentifier",
"type": "string",
"texts":[],
"attributeValues": [
{
"value": "#FF0000",
"translations": [
{
"iso":"de_DE",
"translation":"Rot"
},
{
"iso":"en_GB",
"translation":"red"
}
]
}
]
}
],
"children": [],
"designAreas": [],
"creatorViews": [
{
"identifier": "front_view",
"sequenceNumber": "1"
}
],
"itemClassifications": [
{
"identifier": "clothing",
"texts": [
{
"iso": "en_GB",
"title": "Clothing",
"description": ""
},
{
"iso": "de_DE",
"title": "Bekleidung",
"description": ""
}
]
},
{
"identifier": "hoodies"
}
],
"components": [
{
"componentIdentifier": "softshell_body",
"isMultiselect": false,
"sequencenumber": 1,
"minamount": 1,
"maxamount": 10,
"isMandatory": true,
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/creator/components/softshell_body.png"
},
"texts": [
{
"iso": "en_GB",
"title": "body"
},
{
"iso": "de_DE",
"title": "Body"
}
],
"attributes": [],
"defaultSelections": [
{
"optionIdentifier": "softshell_red",
"amount": 1,
"inputText": "User input text for default selection"
}
],
"options": [
{
"optionIdentifier": "softshell_red",
"amountIsSelectable": false,
"sequencenumber": 1,
"hasTextinput": 1,
"inputValidationType": "optionInputNotEmpty",
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_red.png",
"detailImage": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_red.png",
"visualization": {
"front_view": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_red.png"
}
},
"texts": [
{
"iso": "en_GB",
"title": "Red",
"abstract": "Red color variant"
},
{
"iso": "de_DE",
"title": "Rot",
"abstract": "Rote Farbvariante"
}
],
"prices": [],
"deltaPrices": [],
"attributes": []
},
{
"optionIdentifier": "softshell_avocado",
"amountIsSelectable": false,
"sequencenumber": 2,
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_avocado.png",
"detailImage": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_avocado.png"
},
"texts": [
{
"iso": "en_GB",
"title": "Avocado"
},
{
"iso": "de_DE",
"title": "Avocado"
}
],
"prices": [],
"deltaPrices": [],
"attributes": []
}
],
"optionsOrder": [
"softshell_avocado",
"softshell_red"
]
},
{
"componentIdentifier": "softshell_hood",
"isMultiselect": false,
"sequencenumber": 2,
"isMandatory": false,
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/creator/components/softshell_hood.png"
},
"texts": [
{
"iso": "en_GB",
"title": "hood"
},
{
"iso": "de_DE",
"title": "Kapuze"
}
],
"attributes": [],
"defaultSelections": [
{
"optionIdentifier": "softshell_red",
"amount": 1
}
],
"options": [
{
"optionIdentifier": "softshell_red",
"amountIsSelectable": false,
"sequencenumber": 1,
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_red.png",
"detailImage": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_red.png"
},
"texts": [
{
"iso": "en_GB",
"title": "Red",
"abstract": "Red color variant"
},
{
"iso": "de_DE",
"title": "Rot",
"abstract": "Rote Farbvariante"
}
],
"prices": [],
"deltaPrices": [],
"attributes": []
},
{
"optionIdentifier": "softshell_avocado",
"amountIsSelectable": false,
"sequencenumber": 2,
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_avocado.png",
"detailImage": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_avocado.png"
},
"texts": [
{
"iso": "en_GB",
"title": "Avocado"
},
{
"iso": "de_DE",
"title": "Avocado"
}
],
"prices": [],
"deltaPrices": [],
"attributes": []
}
]
},
{
"componentIdentifier": "softshell_zipper",
"isMultiselect": false,
"sequencenumber": 3,
"hiddenInFrontend": 1,
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/creator/components/softshell_zipper.png"
},
"texts": [
{
"iso": "en_GB",
"title": "zipper"
},
{
"iso": "de_DE",
"title": "Reißverschluss"
}
],
"attributes": [],
"defaultSelections": [
{
"optionIdentifier": "softshell_red",
"amount": 1
}
],
"options": [
{
"optionIdentifier": "softshell_red",
"amountIsSelectable": false,
"sequencenumber": 1,
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_red.png",
"detailImage": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_red.png"
},
"texts": [
{
"iso": "en_GB",
"title": "Red",
"abstract": "Red color variant"
},
{
"iso": "de_DE",
"title": "Rot",
"abstract": "Rote Farbvariante"
}
],
"prices": [],
"deltaPrices": [],
"attributes": []
},
{
"optionIdentifier": "softshell_avocado",
"amountIsSelectable": false,
"sequencenumber": 2,
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_avocado.png",
"detailImage": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_avocado.png"
},
"texts": [
{
"iso": "en_GB",
"title": "Avocado"
},
{
"iso": "de_DE",
"title": "Avocado"
}
],
"prices": [],
"deltaPrices": [],
"attributes": []
}
]
},
{
"componentIdentifier": "softshell_application",
"isMultiselect": false,
"sequencenumber": 4,
"hiddenInPdf": 1,
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/creator/components/softshell_application.png"
},
"texts": [
{
"iso": "en_GB",
"title": "application"
},
{
"iso": "de_DE",
"title": "Applikation"
}
],
"attributes": [],
"defaultSelections": [
{
"optionIdentifier": "softshell_redblack",
"amount": 1
}
],
"options": [
{
"optionIdentifier": "softshell_redblack",
"amountIsSelectable": false,
"sequencenumber": 1,
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_redblack.png",
"detailImage": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_redblack.png"
},
"texts": [
{
"iso": "en_GB",
"title": "Red/Black"
},
{
"iso": "de_DE",
"title": "Rot/Schwarz"
}
],
"prices": [],
"deltaPrices": [],
"attributes": []
},
{
"optionIdentifier": "softshell_whitegreen",
"amountIsSelectable": false,
"sequencenumber": 2,
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_whitegreen.png",
"detailImage": "https://pkg.configuratorware.com/demo-items/creator/options/softshell_whitegreen.png"
},
"texts": [
{
"iso": "en_GB",
"title": "Green/White"
},
{
"iso": "de_DE",
"title": "Grün/Weiß"
}
],
"prices": [],
"deltaPrices": [],
"attributes": []
}
]
}
]
}
]
JSON: Designer
[
{
"itemIdentifier": "softshell_designer_2d",
"externalId": "softshell_designer_2d_external",
"texts": [
{
"iso": "en_GB",
"title": "Softshell designer 2D",
"description": "",
"abstract": "Customizable softshell jacket"
},
{
"iso": "de_DE",
"title": "Softshell designer 2D",
"description": "",
"abstract": "Anpassbare Softshell-Jacke"
}
],
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/designer/item/softshell_2d/softshell_2d_red_thumb.jpg",
"itemImage": "https://pkg.configuratorware.com/demo-items/designer/item/softshell_2d/softshell_2d_red.jpg"
},
"minimumOrderAmount": 1,
"accumulateAmounts": true,
"visualizationModeIdentifier": "2dVariant",
"configurationMode": "designer",
"itemStatusIdentifier": "available",
"prices": [
{
"channelIdentifier": "_default",
"bulkPrices": [
{
"itemAmountFrom": 1,
"price": 59.00,
"priceNet": 0
},
{
"itemAmountFrom": 10,
"price": 54.00,
"priceNet": 0
}
]
}
],
"attributes": [
{
"attributeIdentifier": "myNumberAttributeIdentifier",
"type": "number",
"texts": [],
"attributeValues": [
{
"value": 10,
"translations": []
}
]
},
{
"attributeIdentifier": "myBooleanAttributeIdentifier",
"type": "boolean",
"texts": [],
"attributeValues": [
{
"value": true,
"translations": []
}
]
},
{
"attributeIdentifier": "myStringAttributeIdentifier",
"type": "string",
"texts":[],
"attributeValues": [
{
"value": "#FF0000",
"translations": [
{
"iso":"de_DE",
"translation":"Rot"
},
{
"iso":"en_GB",
"translation":"red"
}
]
}
]
}
],
"itemClassifications": [
{
"identifier": "clothing",
"texts": [
{
"iso": "en_GB",
"title": "Clothing",
"description": ""
},
{
"iso": "de_DE",
"title": "Bekleidung",
"description": ""
}
]
},
{
"identifier": "hoodies"
}
],
"children": [
{
"itemIdentifier": "softshell_designer_2d_red_m",
"texts": [
{
"iso": "en_GB",
"title": "Softshell creator 2D red M",
"description": ""
},
{
"iso": "de_DE",
"title": "Softshell creator 2D rot M",
"description": ""
}
],
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/designer/item/softshell_2d/softshell_2d_red_thumb.jpg",
"itemImage": "https://pkg.configuratorware.com/demo-items/designer/item/softshell_2d/softshell_2d_red.jpg"
},
"minimumOrderAmount": 1,
"accumulateAmounts": true,
"prices": [],
"attributes": [],
"childGroups": [
{
"group": {
"groupIdentifier": "color",
"texts": [
{
"iso": "en_GB",
"title": "Color"
},
{
"iso": "de_DE",
"title": "Farbe"
}
]
},
"groupValue": {
"groupValueIdentifier": "red",
"texts": [
{
"iso": "en_GB",
"title": "Red"
},
{
"iso": "de_DE",
"title": "Rot"
}
]
}
},
{
"group": {
"groupIdentifier": "size",
"texts": [
{
"iso": "en_GB",
"title": "Size"
},
{
"iso": "de_DE",
"title": "Größe"
}
]
},
"groupValue": {
"groupValueIdentifier": "m",
"texts": [
{
"iso": "en_GB",
"title": "M"
},
{
"iso": "de_DE",
"title": "M"
}
]
}
}
]
},
{
"itemIdentifier": "softshell_designer_2d_red_l",
"itemStatusIdentifier": "not_available",
"texts": [
{
"iso": "en_GB",
"title": "Softshell creator 2D red L",
"description": ""
},
{
"iso": "de_DE",
"title": "Softshell creator 2D red L",
"description": ""
}
],
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/designer/item/softshell_2d/softshell_2d_red_thumb.jpg",
"itemImage": "https://pkg.configuratorware.com/demo-items/designer/item/softshell_2d/softshell_2d_red.jpg"
},
"minimumOrderAmount": 1,
"accumulateAmounts": true,
"prices": [],
"attributes": [],
"childGroups": [
{
"group": {
"groupIdentifier": "color",
"texts": [
{
"iso": "en_GB",
"title": "Color"
},
{
"iso": "de_DE",
"title": "Farbe"
}
]
},
"groupValue": {
"groupValueIdentifier": "red",
"texts": [
{
"iso": "en_GB",
"title": "Red"
},
{
"iso": "de_DE",
"title": "Red"
}
]
}
},
{
"group": {
"groupIdentifier": "size",
"texts": [
{
"iso": "en_GB",
"title": "Size"
},
{
"iso": "de_DE",
"title": "Größe"
}
]
},
"groupValue": {
"groupValueIdentifier": "l",
"texts": [
{
"iso": "en_GB",
"title": "L"
},
{
"iso": "de_DE",
"title": "L"
}
]
}
}
]
},
{
"itemIdentifier": "softshell_designer_2d_avocado_m",
"texts": [
{
"iso": "en_GB",
"title": "Softshell creator 2D avocado M",
"description": ""
},
{
"iso": "de_DE",
"title": "Softshell creator 2D avocado M",
"description": ""
}
],
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/designer/item/softshell_2d/softshell_2d_avocado_thumb.jpg",
"itemImage": "https://pkg.configuratorware.com/demo-items/designer/item/softshell_2d/softshell_2d_avocado.jpg"
},
"minimumOrderAmount": 1,
"accumulateAmounts": true,
"prices": [],
"attributes": [],
"childGroups": [
{
"group": {
"groupIdentifier": "color",
"texts": [
{
"iso": "en_GB",
"title": "Color"
},
{
"iso": "de_DE",
"title": "Farbe"
}
]
},
"groupValue": {
"groupValueIdentifier": "avocado",
"texts": [
{
"iso": "en_GB",
"title": "Avocado"
},
{
"iso": "de_DE",
"title": "Avocado"
}
]
}
},
{
"group": {
"groupIdentifier": "size",
"texts": [
{
"iso": "en_GB",
"title": "Size"
},
{
"iso": "de_DE",
"title": "Größe"
}
]
},
"groupValue": {
"groupValueIdentifier": "m",
"texts": [
{
"iso": "en_GB",
"title": "M"
},
{
"iso": "de_DE",
"title": "M"
}
]
}
}
]
},
{
"itemIdentifier": "softshell_designer_2d_avocado_l",
"texts": [
{
"iso": "en_GB",
"title": "Softshell creator 2D avocado L",
"description": ""
},
{
"iso": "de_DE",
"title": "Softshell creator 2D avocado L",
"description": ""
}
],
"images": {
"thumbnail": "https://pkg.configuratorware.com/demo-items/designer/item/softshell_2d/softshell_2d_avocado_thumb.jpg",
"itemImage": "https://pkg.configuratorware.com/demo-items/designer/item/softshell_2d/softshell_2d_avocado.jpg"
},
"minimumOrderAmount": 1,
"accumulateAmounts": true,
"prices": [],
"attributes": [],
"childGroups": [
{
"group": {
"groupIdentifier": "color",
"texts": [
{
"iso": "en_GB",
"title": "Color"
},
{
"iso": "de_DE",
"title": "Farbe"
}
]
},
"groupValue": {
"groupValueIdentifier": "avocado",
"texts": [
{
"iso": "en_GB",
"title": "Avocado"
},
{
"iso": "de_DE",
"title": "Avocado"
}
]
}
},
{
"group": {
"groupIdentifier": "size",
"texts": [
{
"iso": "en_GB",
"title": "Size"
},
{
"iso": "de_DE",
"title": "Größe"
}
]
},
"groupValue": {
"groupValueIdentifier": "l",
"texts": [
{
"iso": "en_GB",
"title": "L"
},
{
"iso": "de_DE",
"title": "L"
}
]
}
}
]
}
],
"designAreas": [
{
"designAreaIdentifier": "chest",
"texts": [
{
"iso": "en_GB",
"title": "Chest"
},
{
"iso": "de_DE",
"title": "Brust"
}
],
"widthMillimeter": 100,
"heightMillimeter": 100,
"visualData": [
{
"designViewIdentifier": "front_view",
"baseShape": "{\"type\":\"Plane\",\"width\":144,\"height\":144,\"x\":-179.99999999999997,\"y\":-68.18181818181799,\"rotation\":{\"x\":0,\"y\":0,\"z\":0,\"order\":\"XYZ\"}}",
"default": false,
"customData": {},
"texts": [
{
"iso": "en_GB",
"title": "Front view"
},
{
"iso": "de_DE",
"title": "Vorderansicht"
}
],
"mediaURLs": [
{
"itemIdentifier": "softshell_designer_2d_red_m",
"mediaURL": "https://pkg.configuratorware.com/demo-items/designer/view/softshell_designer_2d/front_view/softshell_designer_2d_red_m.jpg"
},
{
"itemIdentifier": "softshell_designer_2d_avocado_m",
"mediaURL": "https://pkg.configuratorware.com/demo-items/designer/view/softshell_designer_2d/front_view/softshell_designer_2d_avocado_m.jpg"
},
{
"itemIdentifier": "softshell_designer_2d_red_l",
"mediaURL": "https://pkg.configuratorware.com/demo-items/designer/view/softshell_designer_2d/front_view/softshell_designer_2d_red_l.jpg"
},
{
"itemIdentifier": "softshell_designer_2d_avocado_l",
"mediaURL": "https://pkg.configuratorware.com/demo-items/designer/view/softshell_designer_2d/front_view/softshell_designer_2d_avocado_l.jpg"
}
],
"viewThumbnails": [],
"position": {
"x": 72,
"y": 72
},
"widthPixels": 144,
"heightPixels": 144
}
],
"visualizationBackgroundColors": [],
"customData": {},
"designProductionMethods": [
{
"designProductionMethodIdentifier": "screen_printing",
"widthMillimeter": 0,
"heightMillimeter": 0,
"allowBulkNames": false,
"default": true,
"designElementsLocked": true,
"maxElements": 5,
"maxImages": 2,
"maxTexts": 3,
"oneLineText": false,
"prices": [
{
"channelIdentifier": "_default",
"calculationTypes": [
{
"typeIdentifier": "printing_costs_screen_printing",
"bulkPrices": [
{
"itemAmountFrom": 1,
"colorAmountFrom": 1,
"price": 0.25,
"priceNet": 0
},
{
"itemAmountFrom": 10,
"colorAmountFrom": 1,
"price": 0.20,
"priceNet": 0
}
]
}
]
}
],
"defaultColors": [],
"minimumOrderAmount": 1
},
{
"designProductionMethodIdentifier": "digital_printing",
"widthMillimeter": 0,
"heightMillimeter": 0,
"allowBulkNames": false,
"default": false,
"designElementsLocked": false,
"maxImages": 1,
"maxTexts": 2,
"oneLineText": true,
"prices": [
{
"channelIdentifier": "_default",
"calculationTypes": [
{
"typeIdentifier": "printing_costs_digital_printing",
"bulkPrices": [
{
"itemAmountFrom": 1,
"colorAmountFrom": 1,
"price": 0.70,
"priceNet": 0
},
{
"itemAmountFrom": 10,
"colorAmountFrom": 1,
"price": 0.60,
"priceNet": 0
}
]
}
]
}
],
"defaultColors": [],
"minimumOrderAmount": 1
}
]
},
{
"designAreaIdentifier": "sleeve",
"texts": [
{
"iso": "en_GB",
"title": "Sleeve"
},
{
"iso": "de_DE",
"title": "Ärmel"
}
],
"widthMillimeter": 140,
"heightMillimeter": 100,
"visualData": [
{
"designViewIdentifier": "front_view",
"baseShape": "{\"type\":\"Cylinder\",\"width\":173,\"height\":124,\"x\":286,\"y\":-16,\"rotation\":{\"x\":0.1213,\"y\":0.6705,\"z\":0.17792256549810162,\"order\":\"XYZ\"},\"r\":64}",
"default": false,
"customData": {},
"texts": [
{
"iso": "en_GB",
"title": "Front view"
},
{
"iso": "de_DE",
"title": "Vorderansicht"
}
],
"mediaURLs": [
{
"itemIdentifier": "softshell_designer_2d_red_m",
"mediaURL": "https://pkg.configuratorware.com/demo-items/designer/view/softshell_designer_2d/front_view/softshell_designer_2d_red_m.jpg"
},
{
"itemIdentifier": "softshell_designer_2d_avocado_m",
"mediaURL": "https://pkg.configuratorware.com/demo-items/designer/view/softshell_designer_2d/front_view/softshell_designer_2d_avocado_m.jpg"
},
{
"itemIdentifier": "softshell_designer_2d_red_l",
"mediaURL": "https://pkg.configuratorware.com/demo-items/designer/view/softshell_designer_2d/front_view/softshell_designer_2d_red_l.jpg"
},
{
"itemIdentifier": "softshell_designer_2d_avocado_l",
"mediaURL": "https://pkg.configuratorware.com/demo-items/designer/view/softshell_designer_2d/front_view/softshell_designer_2d_avocado_l.jpg"
}
],
"viewThumbnails": [],
"position": {
"x": 86,
"y": 62
},
"widthPixels": 172,
"heightPixels": 123
},
{
"designViewIdentifier": "side_view",
"baseShape": "{\"type\":\"Cylinder\",\"width\":101,\"height\":72,\"x\":330.0000000000003,\"y\":21.81818181818182,\"r\":128,\"rotation\":{\"x\":9.02129208547617e-17,\"y\":0.012721785742363836,\"z\":0.2679774739697903,\"order\":\"XYZ\"},\"inside\":false}",
"default": false,
"customData": {},
"texts": [
{
"iso": "en_GB",
"title": "Side view"
},
{
"iso": "de_DE",
"title": "Seitenansicht"
}
],
"mediaURLs": [
{
"itemIdentifier": "softshell_designer_2d_red_m",
"mediaURL": "https://pkg.configuratorware.com/demo-items/designer/view/softshell_designer_2d/side_view/softshell_designer_2d_red_m.jpg"
},
{
"itemIdentifier": "softshell_designer_2d_avocado_m",
"mediaURL": "https://pkg.configuratorware.com/demo-items/designer/view/softshell_designer_2d/side_view/softshell_designer_2d_avocado_m.jpg"
},
{
"itemIdentifier": "softshell_designer_2d_red_l",
"mediaURL": "https://pkg.configuratorware.com/demo-items/designer/view/softshell_designer_2d/side_view/softshell_designer_2d_red_l.jpg"
},
{
"itemIdentifier": "softshell_designer_2d_avocado_l",
"mediaURL": "https://pkg.configuratorware.com/demo-items/designer/view/softshell_designer_2d/side_view/softshell_designer_2d_avocado_l.jpg"
}
],
"viewThumbnails": [],
"position": {
"x": 50,
"y": 36
},
"widthPixels": 71,
"heightPixels": 100
}
],
"visualizationBackgroundColors": [],
"customData": {},
"designProductionMethods": [
{
"designProductionMethodIdentifier": "embroidery",
"widthMillimeter": 0,
"heightMillimeter": 0,
"allowBulkNames": false,
"default": false,
"prices": [
{
"channelIdentifier": "_default",
"calculationTypes": [
{
"typeIdentifier": "printing_costs_embroidery",
"bulkPrices": [
{
"itemAmountFrom": 1,
"colorAmountFrom": 1,
"price": 2,
"priceNet": 0
},
{
"itemAmountFrom": 1,
"colorAmountFrom": 2,
"price": 2,
"priceNet": 0
},
{
"itemAmountFrom": 1,
"colorAmountFrom": 3,
"price": 2,
"priceNet": 0
},
{
"itemAmountFrom": 1,
"colorAmountFrom": 4,
"price": 2,
"priceNet": 0
},
{
"itemAmountFrom": 10,
"colorAmountFrom": 1,
"price": 1.8,
"priceNet": 0
},
{
"itemAmountFrom": 10,
"colorAmountFrom": 2,
"price": 1.8,
"priceNet": 0
},
{
"itemAmountFrom": 10,
"colorAmountFrom": 3,
"price": 1.8,
"priceNet": 0
},
{
"itemAmountFrom": 10,
"colorAmountFrom": 4,
"price": 1.8,
"priceNet": 0
}
]
}
]
}
],
"defaultColors": [],
"minimumOrderAmount": 1
},
{
"designProductionMethodIdentifier": "digital_printing",
"widthMillimeter": 0,
"heightMillimeter": 0,
"allowBulkNames": false,
"default": false,
"prices": [
{
"channelIdentifier": "_default",
"calculationTypes": [
{
"typeIdentifier": "printing_costs_digital_printing",
"bulkPrices": [
{
"itemAmountFrom": 1,
"colorAmountFrom": 1,
"price": 0.70,
"priceNet": 0
},
{
"itemAmountFrom": 10,
"colorAmountFrom": 1,
"price": 0.60,
"priceNet": 0
}
]
}
]
}
],
"defaultColors": [],
"minimumOrderAmount": 1
}
]
},
{
"designAreaIdentifier": "back_center",
"texts": [
{
"iso": "en_GB",
"title": "Back center"
},
{
"iso": "de_DE",
"title": "Rückseite Mitte"
}
],
"widthMillimeter": 400,
"heightMillimeter": 500,
"visualData": [
{
"designViewIdentifier": "back_view",
"baseShape": "{\"type\":\"Plane\",\"width\":396,\"height\":495,\"x\":-87,\"y\":-100,\"rotation\":{\"x\":0,\"y\":0,\"z\":0,\"order\":\"XYZ\"}}",
"default": false,
"customData": {},
"texts": [
{
"iso": "en_GB",
"title": "Back view"
},
{
"iso": "de_DE",
"title": "Rückansicht"
}
],
"mediaURLs": [
{
"itemIdentifier": "softshell_designer_2d_red_m",
"mediaURL": "https://pkg.configuratorware.com/demo-items/designer/view/softshell_designer_2d/back_view/softshell_designer_2d_red_m.jpg"
},
{
"itemIdentifier": "softshell_designer_2d_avocado_m",
"mediaURL": "https://pkg.configuratorware.com/demo-items/designer/view/softshell_designer_2d/back_view/softshell_designer_2d_avocado_m.jpg"
},
{
"itemIdentifier": "softshell_designer_2d_red_l",
"mediaURL": "https://pkg.configuratorware.com/demo-items/designer/view/softshell_designer_2d/back_view/softshell_designer_2d_red_l.jpg"
},
{
"itemIdentifier": "softshell_designer_2d_avocado_l",
"mediaURL": "https://pkg.configuratorware.com/demo-items/designer/view/softshell_designer_2d/back_view/softshell_designer_2d_avocado_l.jpg"
}
],
"viewThumbnails": [],
"position": {
"x": 198,
"y": 248
},
"widthPixels": 395,
"heightPixels": 494
}
],
"visualizationBackgroundColors": [],
"customData": {},
"designProductionMethods": [
{
"designProductionMethodIdentifier": "embroidery",
"widthMillimeter": 0,
"heightMillimeter": 0,
"allowBulkNames": false,
"default": false,
"prices": [
{
"channelIdentifier": "_default",
"calculationTypes": [
{
"typeIdentifier": "printing_costs_embroidery",
"bulkPrices": [
{
"itemAmountFrom": 1,
"colorAmountFrom": 1,
"price": 3,
"priceNet": 0
},
{
"itemAmountFrom": 1,
"colorAmountFrom": 2,
"price": 3,
"priceNet": 0
},
{
"itemAmountFrom": 1,
"colorAmountFrom": 3,
"price": 3,
"priceNet": 0
},
{
"itemAmountFrom": 1,
"colorAmountFrom": 4,
"price": 3,
"priceNet": 0
},
{
"itemAmountFrom": 10,
"colorAmountFrom": 1,
"price": 2.5,
"priceNet": 0
},
{
"itemAmountFrom": 10,
"colorAmountFrom": 2,
"price": 2.5,
"priceNet": 0
},
{
"itemAmountFrom": 10,
"colorAmountFrom": 3,
"price": 2.5,
"priceNet": 0
},
{
"itemAmountFrom": 10,
"colorAmountFrom": 4,
"price": 2.5,
"priceNet": 0
}
]
}
]
}
],
"defaultColors": [],
"minimumOrderAmount": 1
},
{
"designProductionMethodIdentifier": "digital_printing",
"widthMillimeter": 0,
"heightMillimeter": 0,
"allowBulkNames": false,
"default": false,
"prices": [
{
"channelIdentifier": "_default",
"calculationTypes": [
{
"typeIdentifier": "printing_costs_digital_printing",
"bulkPrices": [
{
"itemAmountFrom": 1,
"colorAmountFrom": 1,
"price": 0.99,
"priceNet": 0
},
{
"itemAmountFrom": 10,
"colorAmountFrom": 1,
"price": 0.89,
"priceNet": 0
}
]
}
]
}
],
"defaultColors": [],
"minimumOrderAmount": 1
}
]
}
]
}
]
XML: Creator + Designer
<?xml version="1.0" encoding="UTF-8"?>
<items>
<item>
<itemIdentifier>t_shirt</itemIdentifier>
<externalId>t_shirt_external</externalId>
<texts>
<text>
<description/>
<abstract>Customizable t-shirt</abstract>
<iso>en_GB</iso>
<title>T-shirt</title>
</text>
</texts>
<images>
<detailImage>//www.</detailImage>
<thumbnail>//www.</thumbnail>
</images>
<minimumOrderAmount>1</minimumOrderAmount>
<accumulateAmounts>true</accumulateAmounts>
<visualizationModeIdentifier>2dLayer</visualizationModeIdentifier>
<configurationMode>creator+designer</configurationMode>
<itemStatusIdentifier>available</itemStatusIdentifier>
<overwriteComponentOrder>true</overwriteComponentOrder>
<prices>
<price>
<bulkPrices>
<bulkPrice>
<itemAmountFrom>1</itemAmountFrom>
<price>19.9</price>
<priceNet>16.7</priceNet>
</bulkPrice>
</bulkPrices>
<channelIdentifier>de_eur</channelIdentifier>
</price>
</prices>
<attributes>
<attribute>
<attributeIdentifier>tag</attributeIdentifier>
<attributeValues>
<attributeValue>
<translations>
<translation>
<iso>en_GB</iso>
<translation>Summer</translation>
</translation>
</translations>
<value>summer</value>
</attributeValue>
</attributeValues>
<texts>
<text>
<iso>en_GB</iso>
<title>Tag</title>
</text>
</texts>
<type>string</type>
</attribute>
</attributes>
<children>
<item>
<attributes>
<attribute>
<attributeIdentifier>tag</attributeIdentifier>
<attributeValues>
<attributeValue>
<translations>
<translation>
<iso>en_GB</iso>
<translation>Summer</translation>
</translation>
<translation>
<iso>de_DE</iso>
<translation>Sommer</translation>
</translation>
</translations>
<value>summer</value>
</attributeValue>
</attributeValues>
<texts>
<text>
<iso>en_GB</iso>
<title>Tag</title>
</text>
</texts>
<type>string</type>
</attribute>
</attributes>
<childGroups>
<childGroup>
<group>
<groupIdentifier>color</groupIdentifier>
<texts>
<text>
<iso>en_GB</iso>
<title>Color</title>
</text>
</texts>
</group>
<groupValue>
<groupValueIdentifier>red</groupValueIdentifier>
<texts>
<text>
<iso>en_GB</iso>
<title>Red</title>
</text>
</texts>
</groupValue>
</childGroup>
<childGroup>
<group>
<groupIdentifier>size</groupIdentifier>
<texts>
<text>
<iso>en_GB</iso>
<title>Size</title>
</text>
</texts>
</group>
<groupValue>
<groupValueIdentifier>s</groupValueIdentifier>
<texts>
<text>
<iso>en_GB</iso>
<title>S</title>
</text>
</texts>
</groupValue>
</childGroup>
</childGroups>
<images>
<detailImage>//www....</detailImage>
<thumbnail>//www....</thumbnail>
</images>
<minimumOrderAmount>1</minimumOrderAmount>
<accumulateAmounts>true</accumulateAmounts>
<itemIdentifier>t_shirt_red_s</itemIdentifier>
<itemStatusIdentifier>not_available</itemStatusIdentifier>
<prices>
<price>
<bulkPrices>
<bulkPrice>
<itemAmountFrom>1</itemAmountFrom>
<price>19.9</price>
<priceNet>16.7</priceNet>
</bulkPrice>
</bulkPrices>
<channelIdentifier>de_eur</channelIdentifier>
</price>
</prices>
<texts>
<text>
<description/>
<iso>en_GB</iso>
<title>T-shirt, red, s</title>
</text>
</texts>
</item>
</children>
<designAreas>
<designArea>
<customData/>
<designAreaIdentifier>front_top</designAreaIdentifier>
<designProductionMethods>
<designProductionMethod>
<designProductionMethodIdentifier>offset_print</designProductionMethodIdentifier>
<heightMillimeter>30</heightMillimeter>
<prices>
<price>
<calculationTypes>
<calculationType>
<bulkPrices>
<bulkPrice>
<colorAmountFrom>1</colorAmountFrom>
<itemAmountFrom>1</itemAmountFrom>
<price>1.99</price>
<priceNet>1.67</priceNet>
</bulkPrice>
</bulkPrices>
<typeIdentifier>productionPrice</typeIdentifier>
</calculationType>
</calculationTypes>
<channelIdentifier>de_eur</channelIdentifier>
</price>
</prices>
<widthMillimeter>320</widthMillimeter>
<allowBulkNames>true</allowBulkNames>
<default>true</default>
<designElementsLocked>true</designElementsLocked>
<maxElements>5</maxElements>
<maxImages>2</maxImages>
<maxTexts>3</maxTexts>
<oneLineText>false</oneLineText>
<defaultColors>
<defaultColor>
<itemIdentifier>t_shirt_red_s</itemIdentifier>
<paletteIdentifier>default</paletteIdentifier>
<color>red</color>
</defaultColor>
</defaultColors>
<minimumOrderAmount>100</minimumOrderAmount>
</designProductionMethod>
</designProductionMethods>
<heightMillimeter>30</heightMillimeter>
<texts>
<text>
<iso>de_DE</iso>
<title>front top</title>
</text>
</texts>
<visualData>
<designView>
<customData/>
<designViewIdentifier>front</designViewIdentifier>
<default>true</default>
<heightPixels>20</heightPixels>
<viewThumbnails>
<viewThumbnail>
<itemIdentifier>t_shirt_red_s</itemIdentifier>
<viewThumbnailURL>//www....</viewThumbnailURL>
</viewThumbnail>
</viewThumbnails>
<mediaURLs>
<mediaURL>
<itemIdentifier>t_shirt_red_s</itemIdentifier>
<mediaURL>//www....</mediaURL>
</mediaURL>
</mediaURLs>
<position>
<x>400</x>
<y>200</y>
</position>
<texts>
<text>
<iso>en_GB</iso>
<title>Front view</title>
</text>
</texts>
<widthPixels>200</widthPixels>
</designView>
</visualData>
<visualizationBackgroundColors>
<visualizationBackgroundColor>
<itemIdentifier>t_shirt_red_s</itemIdentifier>
<color>#fffff</color>
</visualizationBackgroundColor>
</visualizationBackgroundColors>
<widthMillimeter>300</widthMillimeter>
</designArea>
</designAreas>
<components>
<component>
<componentIdentifier>main_color</componentIdentifier>
<isMultiselect>true</isMultiselect>
<sequencenumber>3</sequencenumber>
<hiddenInFrontend>0</hiddenInFrontend>
<images>
<thumbnail>http://localhost/tests/sample-1.jpg</thumbnail>
</images>
<texts>
<text>
<iso>en_GB</iso>
<title>Main Color</title>
</text>
<text>
<iso>de_DE</iso>
<title>Hauptfarbe</title>
</text>
</texts>
<attributes>
<attribute>
<attributeIdentifier>category_type</attributeIdentifier>
<attributeValues>
<attributeValue>
<translations>
<translation>
<iso>en_GB</iso>
<translation>Fabrics</translation>
</translation>
<translation>
<iso>de_DE</iso>
<translation>Stoffe</translation>
</translation>
</translations>
<value>fabrics</value>
</attributeValue>
</attributeValues>
<texts>
<text>
<iso>en_GB</iso>
<title>Category Type</title>
</text>
<text>
<iso>de_DE</iso>
<title>Kategorie Typ</title>
</text>
</texts>
<type>string</type>
</attribute>
</attributes>
<defaultSelections>
<defaultSelection>
<optionIdentifier>red</optionIdentifier>
<amount>1</amount>
</defaultSelection>
</defaultSelections>
<options>
<option>
<optionIdentifier>red</optionIdentifier>
<amountIsSelectable>false</amountIsSelectable>
<sequencenumber>2</sequencenumber>
<images>
<thumbnail>http://localhost/tests/sample-1.jpg</thumbnail>
<detailImage>http://localhost/tests/sample-1.jpg</detailImage>
</images>
<texts>
<text>
<iso>en_GB</iso>
<title>Red</title>
<abstract>Red color variant</abstract>
</text>
<text>
<iso>de_DE</iso>
<title>Rot</title>
<abstract>Rote Farbvariante</abstract>
</text>
</texts>
<prices>
<price>
<prices>
<price>
<amountFrom>1</amountFrom>
<price>5.1</price>
<priceNet>4.29</priceNet>
</price>
</prices>
<channelIdentifier>de_eur</channelIdentifier>
</price>
</prices>
<deltaPrices>
<deltaPrice>
<prices>
<price>
<price>3.9</price>
<priceNet>3.28</priceNet>
</price>
</prices>
<channelIdentifier>de_eur</channelIdentifier>
</deltaPrice>
</deltaPrices>
<attributes>
<attribute>
<attributeIdentifier>color_filter</attributeIdentifier>
<attributeValues>
<attributeValue>
<translations>
<translation>
<iso>en_GB</iso>
<translation>Warm Colors</translation>
</translation>
<translation>
<iso>de_DE</iso>
<translation>Warme Farben</translation>
</translation>
</translations>
<value>warm_colors</value>
</attributeValue>
</attributeValues>
<texts>
<text>
<iso>en_GB</iso>
<title>Color Filter</title>
</text>
<text>
<iso>de_DE</iso>
<title>Farb Filter</title>
</text>
</texts>
<type>string</type>
</attribute>
</attributes>
</option>
</options>
</component>
</components>
</item>
</items>
Data format
The importer works with JSON data. It also supports XML; XML is converted to the same array structure before importing.
Legacy field aliases
The importer accepts the following aliases for backward compatibility (normalized before processing; deprecated, please use the new fields instead):
images.itemImage→images.detailImageitemStatuses(array) →configurationModeanditemStatusIdentifierOption
prices[].prices→prices[].bulkPrices
Nodes
Item
An item describes an article (sku) or a group of articles.
Item properties
itemIdentifier: Unique identifier for the item. As for all identifier fields: use only lowercase letters, numbers, and no special characters except
-,_, and.so the value can be used in URLs.externalId: Optional external reference stored on the item (for example an ERP SKU).
texts: Titles and descriptions per language. Each entry has the following fields:
iso: ISO language code, e.g.
en_GBorde_DE.title: Title of the item.
description: Long description (optional).
abstract: Short teaser text (optional).
images: Item media copied into the configurator storage:
thumbnail: Thumbnail image URL.
detailImage: Detail image URL (legacy alias:
itemImage, deprecated).
minimumOrderAmount: Minimum order quantity. Optional, defaults to
1.accumulateAmounts: Whether option amounts are accumulated on the item. Optional, defaults to
true.visualizationModeIdentifier: Visualization mode for root items (not used on child variants). Examples:
2dLayer,2dVariant,3dScene,3dVariant.configurationMode:
In case the license covers only “creator” or “designer”, this value needs to be set for each item the same. For licenses for creator+designer this can be used to specify the usage of the item.
Possible values:
creator,designer, orcreator+designer.Required on new items; on updates it may be omitted and is then taken from the database.
itemStatusIdentifier: Availability, e.g.
availableornot_available(legacy:itemStatusesarray, deprecated).overwriteComponentOrder: When
true, the item uses its own component sequence instead of the global default.prices: Bulk prices per channel; see Item prices.
attributes: Item attributes; see Item attributes.
children: Child variant items for grouped articles; see Child item properties.
designAreas: Design areas for designer/creator+designer items; see Design areas.
components: Configurator components (option classifications); see Components.
itemClassifications: Category/classification relations, use to group items into categories; see Item classifications.
creatorViews: Creator views for layer-based items (
identifier,sequenceNumber); use together withoptions[].images.visualization; see Creator views and layer images.
Child item properties
A child item differs from a root item in two ways:
It cannot have further
children.It must define
childGroupsso the configurator can place it in the parent’s variant hierarchy.
Child items support the same fields as root items except visualizationModeIdentifier, configurationMode (inherited from the parent import pass), and children. itemStatusIdentifier may be set per variant (for example not_available on one size).
Child group properties
An item can be put in multiple groups within a root item. It gets a value for each group it is put in. For example an item can have a group “color” with the value “red” and the group “size” with the value “s”.
From having groups and values for each group an item is in the configurator can build up a hierarchy within the root item.
Each childGroups entry assigns the child to one variant axis (e.g. color red and size m).
group:
groupIdentifier: Identifier of the group (e.g.
color).texts: Optional translated group titles (
iso,title).
groupValue:
groupValueIdentifier: Identifier of the value within the group (e.g.
red).texts: Optional translated value titles.
Item prices
Item prices contain a list of bulk prices per channel.
channelIdentifier: Identifier of the channel the prices apply to (e.g.
_default).bulkPrices: Tiered prices, configuratorware does not calculate vat amounts, net prices can be applied as separate fields:
itemAmountFrom: Minimum item quantity for this tier (required, ≥ 1).
price: Gross price.
priceNet: Net price (optional).
When the import runs with priceChannel set, only prices for that channel are updated; other channels are left unchanged.
Item attributes
An item can have multiple attributes and multiple attribute values per attribute.
attributeIdentifier: Unique identifier for the attribute.
type: Data type of the attribute, allowed values are “string”, “number” and “boolean”.
texts: Translations for the attribute title
attributeValues: Each value has
valueand an optionaltranslationslist (iso,translation).
Item classifications
identifier: Classification identifier (created if missing).
texts: Optional translated titles (
iso,title,description).
Legacy item statuses
Deprecated: use itemStatusIdentifier and configurationMode on the item instead. The legacy itemStatuses array contains entries with:
configurationModeIdentifier:
creatorordesigneravailable: Boolean
The importer derives configurationMode and itemStatusIdentifier from this array when present.
Design areas
Design areas describe areas on an item that can be designed in the configurator. They also contain information of how to visualize them, how they are produced and whats the price for designing them.
designAreaIdentifier: Unique identifier within the item.
sequenceNumber: Optional display order; auto-assigned if omitted.
texts: Translated titles (
iso,title).widthMillimeter: Width in millimeters.
heightMillimeter: Height in millimeters.
visualData: A list of views in which the design area is visible and the positioning within that view; see Design views.
designProductionMethods: A list of production methods with prices used in this design area; see Design production methods.
customData: Arbitrary JSON stored on the design area and saved serialized in the database.
visualizationBackgroundColors: Per-variant background colors, e.g. for engraving visualization; see Visualization background colors.
Design views
Design views describe different views on the item. It can be only one view for 3d, or views from different sides, e.g. “front”, “back”. Positioning and size in pixels will be translated to relative positions by the importer to be able to scale correctly if displayed in the frontend.
designViewIdentifier: Unique view identifier within the item (e.g.
front_view).texts: Translated view titles (
iso,title).baseShape: JSON string describing the printable shape (merged with defaults; used for 3D/cylindrical areas).
default: When
true, marks this view as the default for the design area (lasttruein the import wins).mediaURLs: Background media per variant; see Design view media URLs.
viewThumbnails: Optional thumbnails per variant (
itemIdentifier,viewThumbnailURL).position:
xandyin pixels to position the design area on the background image or texture of the 3d object if using 3d data.widthPixels / heightPixels: Design area size in pixels on the background image or texture of the 3d object if using 3d data (required for designer visual data validation).
customData: Arbitrary JSON stored on the view / view–area relation and saved serialized in the database.
Visualization background colors
Stored on the design-area/production-method relation (additional_data).
itemIdentifier: Variant item identifier for which the background color is applied (e.g. different background color per item).
color: Hex color used when visualizing design production methods, e.g. engraving.
Design view media URLs
For single items (no grouping) there is only one entry, but when in a grouped item it contains an entry for each item within the group. Images are copied by the import and saved in the configurators directory structure.
itemIdentifier: Variant item identifier the media applies to.
mediaURL: URL to an image or ZIP (e.g. 3D assets). Files are copied into configurator storage.
Image files are typically JPEG or PNG; WebP is also accepted. For grouped articles, provide one mediaURLs entry per child variant (each with that variant’s itemIdentifier). The importer stores downloaded images under the design-view image path as {rootItemIdentifier}/{designViewIdentifier}/{variantItemIdentifier}.{ext}, where rootItemIdentifier is the imported parent item and variantItemIdentifier is the itemIdentifier from the mediaURLs entry.
Design production methods
Design production methods are not created by the importer; it links existing methods to the design area so that only these methods can be used on the design area.
designProductionMethodIdentifier: Identifier of an existing design production method in the configurator.
prices: Per-channel prices. Each entry has
channelIdentifierandcalculationTypes:typeIdentifier: Calculation type identifier (must exist for the method).
bulkPrices: Tiers with
itemAmountFrom,colorAmountFrom(optional, default1),price,priceNet.
widthMillimeter / heightMillimeter: Optional size override on this design area.
defaultColors: Optional list of
itemIdentifier,color(hex or palette color id),paletteIdentifier. Unresolvable colors are skipped.default: When
true, marks this method as default for the item (lasttruein the import resets other defaults).allowBulkNames: Whether bulk names are allowed.
designElementsLocked: Restrict editing of design elements when
true.maxElements / maxImages / maxTexts: Optional limits on design content.
oneLineText: When
true, text elements are limited to a single line.minimumOrderAmount: Optional minimum order quantity for this method on the design area.
Components
componentIdentifier: Identifier for a new or existing component.
isMultiselect: Whether multiple options can be selected.
sequencenumber: Component sort order on the item.
minamount / maxamount: Optional selectable quantity bounds on the item–component relation.
isMandatory: Whether a selection is required (defaults to
true).hiddenInFrontend: Hide the component in the frontend (defaults to
false).hiddenInPdf: Hide the component in PDF output (defaults to
false).images:
thumbnailURL for the component image.texts: Translated titles (
iso,title, optionaldescription).attributes: Component attributes; same structure as Item attributes.
defaultSelections: Preselected options for the default configuration:
optionIdentifier: Selected option.
amount: Selected quantity (defaults to
1).inputText: Optional default text when the option has text input.
options: Options selectable on this component; see Options.
optionsOrder: Array of
optionIdentifiervalues defining display order on this item.
Options
optionIdentifier: Identifier for a new or existing option.
amountIsSelectable: Whether the user can change the quantity (defaults to fixed quantity
1).sequencenumber: Global option sort order (may be overridden per item via
optionsOrder).hasTextinput: Enable free-text input on the option (
0/1).inputValidationType: Validation rule when text input is enabled (currently,
optionInputNotEmpty,optionInputNumber).images:
thumbnail / detailImage: URL to option preview images. Files are copied into configurator storage.
visualization: Layer images per creator view (
configurationModecreator/2dLayer). Object keys must matchcreatorViews[].identifier; see Creator views and layer images.
texts: Per-language
iso,title, optionaldescriptionandabstract.attributes: Option attributes; same structure as Item attributes.
prices: Per-channel option prices (
channelIdentifier,bulkPriceswithitemAmountFrom,price,priceNet).deltaPrices: Price differences per item–component–option relation, per channel:
channelIdentifierandpricesarray (price,priceNet, optionalamountFrom).
Creator views and layer images
For configurationMode creator (and 2dLayer visualization) items:
creatorViews– which views exist and in which order (identifier,sequenceNumber). Creates or keeps matchingcreator_viewrecords.components[].options[].images.visualization– layer image URL per view for each option. Object keys listed increatorViewsare usable.
Example: creatorViews lists front_view and back_view; each option’s visualization provides "front_view": "https://…" (and back_view when applicable).
To upload layer images to the default view, use the key _default, with sequence number 1.
If sequenceNumber is omitted on a creatorViews entry, position in the array is used (1, 2, …).
Use deleteNonExistingCreatorViews and deleteNonExistingCreatorViewLayerImages to remove views or layer files not present in the import.
Parameters
The behaviour of the import can be configured by setting parameters when calling the command.
Note
By running path/to/project/bin/console configuratorware:import -h all parameters and default values will be listed.
Source
The source of the import can either be set to a directory (read XML or json files) or to a URL that supplies the data.
Parameter |
Type |
|---|---|
source |
string |
Delete
Different nodes in the data can be defined to be deleted if they do not exist in the current import data set. If one of these nodes is deleted all data below is also deleted from the database. The behavior defaults to these settings if they are not set in the commands parameters:
Parameter |
Type |
Default Value |
|---|---|---|
deleteNonExistingItems |
boolean |
false |
deleteNonExistingVariants |
boolean |
false |
deleteNonExistingItemPrices |
boolean |
true |
deleteNonExistingItemImages |
boolean |
false |
deleteNonExistingItemClassificationRelations |
boolean |
true |
deleteNonExistingAttributeRelations |
boolean |
true |
deleteWriteProtectedAttributes |
boolean |
false |
deleteNonExistingComponentRelations |
boolean |
false |
deleteNonExistingComponentThumbnails |
boolean |
false |
deleteNonExistingOptionThumbnails |
boolean |
false |
deleteNonExistingOptionImages |
boolean |
false |
deleteNonExistingCreatorViews |
boolean |
false |
deleteNonExistingCreatorViewLayerImages |
boolean |
false |
deleteNonExistingDesignAreas |
boolean |
true |
deleteNonExistingDesignAreaVisualData |
boolean |
false |
deleteNonExistingDesignAreaVisualDataImages |
boolean |
false |
deleteNonExistingDesignAreaDesignProductionMethod |
boolean |
true |
deleteNonExistingDesignAreaDesignProductionMethodPrices |
boolean |
true |
deleteNonExistingDesignViewThumbnails |
boolean |
false |
overwriteItemImages |
boolean |
false |
deleteNonExistingOptionThumbnails is deprecated; use deleteNonExistingOptionImages to remove both option thumbnails and detail images when absent from the import.
Price Channel
The “priceChannel” parameter defines if the import should manipulate prices only in this specified channel, e.g. “_default”:
Parameter |
Type |
|---|---|
priceChannel |
string |
Other options
Parameter |
Type |
Default Value |
|---|---|---|
dryRun |
boolean |
false |
logSql |
boolean |
false |
moveProcessedFile |
boolean |
true |
dryRun / logSql: Roll back after import;
logSqlalso prints executed SQL.moveProcessedFile: When importing from a directory, move processed files to the log directory (CLI only).