saveImportMappingProfile

Requires permission products:import:stage.

S2.2 — create (no id) or update (id) a per-supplier mapping profile. Enforces per-tenant name uniqueness.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation SaveImportMappingProfile($input: SaveImportMappingProfileInput!) {
  saveImportMappingProfile(input: $input) {
    id
    name
    supplierName
    createdAt
    fieldMap
    isActive
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SaveImportMappingProfile($input: SaveImportMappingProfileInput!) {\n  saveImportMappingProfile(input: $input) {\n    id\n    name\n    supplierName\n    createdAt\n    fieldMap\n    isActive\n  }\n}",
  "variables": {
    "input": {
      "fieldMap": {},
      "name": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "fieldMap": {},
    "name": "string"
  }
}

Response:

{
  "data": {
    "saveImportMappingProfile": {
      "id": "string",
      "name": "string",
      "supplierName": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "fieldMap": {},
      "isActive": true
    }
  }
}

saveImportMappingProfile(
  input: SaveImportMappingProfileInput!
): ImportMappingProfile!

Arguments

saveImportMappingProfile.input ● SaveImportMappingProfileInput! non-null input

The details of the import mapping profile to save.

Type

ImportMappingProfile object

A saved mapping of a supplier file's columns to product fields.