Cancel a running sync job

POST

/api/customer-product-mixes/sync/cancel/{jobId}

Cancels a sync job that is currently running or pending.
The job will stop after completing the current customer being processed.
Already processed customers will retain their synced data.

Note: Cancellation is graceful - the job won't stop mid-customer.

Example response:

{
  "jobId": "sync-company-abc123",
  "success": true,
  "message": "Cancellation requested. The job will stop after completing the current customer.",
  "finalStatus": "CancellationRequested"
}

Request

Path Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Body

Example

{
    "jobId": "string",
    "success": true,
    "message": "string",
    "finalStatus": "Pending"
}

🟠401

🟠404

Modified at 2026-03-16 09:55:56

Get the progress of a sync job

Sync a single customer's product mix from their order history