getCategoryImportTemplate

Requires permission categories:category:create.

Returns a sample CSV file for bulkImportCategories, with the column headers it expects and example rows. A child row must come below the row that defines its parent and refer to it by code. Requires permission to create categories.

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 GetCategoryImportTemplate {
  getCategoryImportTemplate
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query GetCategoryImportTemplate {\n  getCategoryImportTemplate\n}"
}
EOF

Response:

{
  "data": {
    "getCategoryImportTemplate": "string"
  }
}

getCategoryImportTemplate: String!

Type

String scalar

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.