curl --request POST \
--url https://api.arcuserp.com/v1/entities/{entity_id}/migration/jobs/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reason": "queue_cleanup_2026_05_22_abandoned_for_new_entity"
}
'{
"object": "migration_jobs_cancel_result",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cancelled": 123,
"job_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"reason": "<string>",
"include_running": true
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}Migration
Cancel migration jobs
Cancels every pending migration job for the entity, and every running job as well when include_running is set to true. A cancelled job is distinct from a failed one for monitoring purposes, and the reason (default admin_cancelled) is recorded on each job for audit; requires migration:write scope.
POST
/
entities
/
{entity_id}
/
migration
/
jobs
/
cancel
curl --request POST \
--url https://api.arcuserp.com/v1/entities/{entity_id}/migration/jobs/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reason": "queue_cleanup_2026_05_22_abandoned_for_new_entity"
}
'{
"object": "migration_jobs_cancel_result",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cancelled": 123,
"job_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"reason": "<string>",
"include_running": true
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}Authorizations
API key issued per entity via Settings > Developers > API Keys.
Each key carries scopes (e.g. orders:read, products:write).
Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.
Path Parameters
Body
application/json
Response
Cancel result with the list of cancelled job IDs
Was this page helpful?