importMappingProfiles

Requires permission products:import:read.

S2.2 — saved per-supplier column-mapping profiles for the org.

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

query ImportMappingProfiles {
  importMappingProfiles {
    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": "query ImportMappingProfiles {\n  importMappingProfiles {\n    id\n    name\n    supplierName\n    createdAt\n    fieldMap\n    isActive\n  }\n}"
}
EOF

Response:

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

importMappingProfiles: [ImportMappingProfile!]!

Type

ImportMappingProfile object

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