cancelProductImport

Requires permission products:import:stage.

Cancels an import before commit has started.

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 CancelProductImport($importId: String!) {
  cancelProductImport(importId: $importId)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CancelProductImport($importId: String!) {\n  cancelProductImport(importId: $importId)\n}",
  "variables": {
    "importId": "string"
  }
}
EOF

Variables:

{
  "importId": "string"
}

Response:

{
  "data": {
    "cancelProductImport": true
  }
}

cancelProductImport(
  importId: String!
): Boolean!

Arguments

cancelProductImport.importId ● String! non-null scalar

The ID of the import.

Type

Boolean scalar

The Boolean scalar type represents true or false.