Skip to main content

Create Integration

POST /v1/integration/:id/config

Creates a new integration configuration for importing resources. Validates the input, applies defaults, and returns the created integration with mappings, filters, and import options.

Request Body

{
"resource": "products",
"provider": "csv",
"name": "full-external",
"csvOptions": {
"fieldDelimiter": ",",
"valueDelimiter": ","
},
"fieldMapping": {
"name": "Varenr",
"sku": "Varenr",
"price": "Pris",
"media": ""
},
"propertyMapping": {
"vendor": [
"Cisco",
"Generic",
"Arista",
"Dell",
"Extreme",
"Huawei",
"Juniper"
],
"form-factor": [
"QSFP to SFP+ adapter",
"QSFP28 to SFP28 adapter"
],
"size": [
"SM"
],
"level": [
"5dB"
]
},
"importOptions": {
"isSubscription": false,
"isActive": true,
"salesChannels": [
"shop"
]
},
"filter": {
"all": true,
"ids": [0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30]
}
}

Response Example

{
"name": "example-external",
"tenant": "tenant-id-1",
"isGlobal": false,
"resource": "products",
"format": "csv",
"csvOptions": {
"fieldDelimiter": ",",
"valueDelimiter": ","
},
"filter": {
"all": true,
"ids": [0, 1, 2, 3]
},
"fieldMapping": {
"name": "ItemName",
"sku": "ItemNumber",
"price": "UnitPrice",
"media": ""
},
"propertyMapping": {
"vendor": ["Vendor A", "Vendor B", "Vendor C"],
"form-factor": ["Form A", "Form B"],
"size": ["Small"],
"level": ["Level-1"]
},
"importOptions": {
"isSubscription": false,
"isActive": true,
"salesChannels": ["shop"],
"matchingField": "sku"
},
"_id": "integration-id-1",
"created": "2025-10-31T12:00:00.000Z",
"updated": "2025-10-31T12:00:00.000Z",
"__v": 0
}