Import
This documents describes the format of the import data and the values that can be configured to setup how the importer handles this 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",
"texts": [
{
"iso": "en_GB",
"title": "Softshell creator 2D",
"description": ""
},
{
"iso": "de_DE",
"title": "Softshell creator 2D",
"description": ""
}
],
"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": [],
"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"
},
"texts": [
{
"iso": "en_GB",
"title": "Red"
},
{
"iso": "de_DE",
"title": "Rot"
}
],
"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"
},
{
"iso": "de_DE",
"title": "Rot"
}
],
"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"
},
{
"iso": "de_DE",
"title": "Rot"
}
],
"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",
"texts": [
{
"iso": "en_GB",
"title": "Softshell designer 2D",
"description": ""
},
{
"iso": "de_DE",
"title": "Softshell designer 2D",
"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,
"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>
<texts>
<text>
<description/>
<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>
</text>
<text>
<iso>de_DE</iso>
<title>Rot</title>
</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. If XML data is provided it is internally converted to json before importing.
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 “.” to make sure that it can be used in an URL.
texts: Titles and descriptions for different languages.
images: An item can have two different images: thumbnail and detailImage. Images are copied by the import and saved in the configurators directory structure.
minimumOrderAmount: The minimum order amount for an item. Optional, defaults to
visualizationModeIdentifier: The visualizationMode for the item. Required to have a visualization.
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 are “creator”, “designer” or “creator+designer”.
itemStatusIdentifier: Activate the product or disable.
overwriteComponentOrder: Use item’s component order instead of global.
prices: Bulk prices for different channels, for details see below.
attributes: A list of attributes for the item, for details see below.
children: optional. If the children are set the item is treated as an article group, for details see below.
designAreas: A list of design areas on the item, for details see below.
components: A list of components on the item, for details see below.
itemClassifications: Can be used to group items into categories.
Child item properties
A child item differs in two ways from a root item: - It cannot have further children (children). - It needs information about how to group within the root item (childGroups). It contains a list of child groups, see: [child group properties](#child-group-properties).
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.
group: a group has an identifier and has text entries to have translated titles for different languages
groupValue: a group value has an identifier and has text entries to have translated titles for different languages
Item prices
Item prices contain a list of bulk prices per channel.
channelIdentifier: The identifier of the channel the prices should be applied to.
bulkPrices: A list of prices. The bulks are defined by the itemAmountFrom property. The configurator does no vat calculation net prices can be applied as separate fields.
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: Attribute values have a “value” and an (optional) list of translations for the value.
Item statuses
configurationModeIdentifier: Configuration mode for that the item should be allowed to be configured. Allowed values are: “creator” and “designer”
available: Boolean.
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 (within the current item) identifier of the design area.
texts: Translations for the title of the design area.
widthMillimeter: The width of the design area in millimeters.
heightMillimeter: The height of the design area in millimeters.
visualData: A list of views in which the design area is visible and the positioning within that view, see: [design views](#design-views).
designProductionMethods: A list of design production methods and the prices for, see: [design production methods](#design-production-methods).
customData: The custom data object is directly saved serialized in the database.
visualizationBackgroundColors: A color per itemIdentifier that is used for the visualization of some desing production methods (engraving), see: [visualization background colors](#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 (within the current item) identifier of the design view.
texts: Translations for the title of the design view.
mediaURLs: A list of URLs for the visualization of the design view, see: [design view media URLs](#design-view-media-urls).
position: x and y values in Pixels to Position the design area on the background image (texture of the 3d object if using 3d data).
widthPixels: If a position is set, the width in pixels is used to display the design area in the correct size on the background image (texture if using 3d data).
heightPixels: If a position is set, the height in pixels is used to display the design area in the correct size on the background image (texture if using 3d data).
customData: The custom data object is directly saved serialized in the database.
Visualization background colors
wil be saved in the additional_data field
itemIdentifier: Identifier of the item, e.g. different background color per item (red, blue)
color: hex color of the color to be shown for visualizing some design production methods (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: Identifier of the item for which the media is applied, e.g. different background image per item (red, blue)
mediaURL: URL to get the media from, it can be an image file or a zip (e.g. for 3d models)
Design view images
A .jpg or .png image url depicting each view of the item. Separate image for parent and each child item. Image copied to the directory structure, named by [parent_item_identifier]/item_identifier/view_identifier.[jpg|png]
Design production methods
A list of design production methods that are allowed for the current design area, e.g. offset print, engraving. Design production methods are not created by the importer the importer just adds the relations to existing design production methods.
designProductionMethodIdentifier: Identifier of an existing design production method.
prices: The prices per channel when using this design production method on the current design area.
widthMillimeter: The size for the design production method on the current design area can be overwritten
heightMillimeter: The size for the design production method on the current design area can be overwritten
defaultColors: A design production method may have a defaultColors field, containing the item identifier + color / hex value and color palette identifier. If no matching data found, then this info is skipped.
default (bool): A default production method and design area can be set per item - if the import contains multiple default values, then the last one will be stared, resetting all other defaults (already stored or in current import)
allowBulkNames (bool): If bulk names are allowed here
Components
componentIdentifier: Identifier for a new or existing component
isMultiselect: is multiple option selectable
sequencenumber: the default priority order of the components
hiddenInFrontend: defines if the component is hidden in the frontend, defaults to false
images: thumbnail and detail images to import for a component
texts: Titles and descriptions for different languages.
attributes: A list of attributes for the component, see: [item attributes](#item-attributes).
options: an array of available options for this component
optionsOrder: an array of available options identifiers for this component that will override the global default priority order of the options
Options
optionIdentifier: Identifier for a new or existing option
amountIsSelectable: defaults to 1 piece or the amount can be set manually
sequencenumber: the default priority order of the components
images: thumbnail and detail images to import for an option
texts: Titles and descriptions for different languages.
attributes: A list of attributes for the component, see: [item attributes](#item-attributes).
prices: The prices for different channels, see: [item prices](#item-prices).
deltaPrices: Price difference per channels
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 |
|---|---|
deleteNonExistingItems |
boolean |
deleteNonExistingAttributeRelations |
boolean |
deleteNonExistingItemPrices |
boolean |
deleteNonExistingDesignAreas |
boolean |
deleteNonExistingDesignAreaVisualData |
boolean |
deleteNonExistingDesignAreaDesignProductionMethodPrices |
boolean |
deleteNonExistingDesignViewThumbnails |
boolean |
deleteNonExistingComponentRelations |
boolean |
Item Status
There is a parameter that controls if item statuses are updated from the import data.
Parameter |
Type |
|---|---|
updateItemStatuses |
boolean |
Price Channel
The “priceChannel” parameter defines if the import should manipulate prices only in this specified channel, e.g. “_default”:
Parameter |
Type |
|---|---|
priceChannel |
string |
Dry Run
The import can be called as dry-run
Parameter |
Type |
|---|---|
dryRun |
boolean |