Start a full historical sync job for all customers

POST

/api/customer-product-mixes/sync/start

This endpoint starts a background job that processes all customers with orders.
The job runs asynchronously - use GET /progress/{jobId} to track status.

Prerequisites:

Product Mix settings must be in AutoCalculated mode

User must have backoffice permissions

Example:
POST /api/customer-product-mixes/sync/start

Response:
{
"jobId": "sync-abc-123",
"totalCustomers": 500,
"estimatedDurationMinutes": 15,
"message": "Sync job queued. Use the progress endpoint to track status."
}

Request

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢202

application/json

Accepted

Body

Example

{
    "jobId": "string",
    "totalCustomers": 0,
    "estimatedDurationMinutes": 0,
    "message": "string",
    "isExistingJob": true
}

🟠400

🟠401

🔴500

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

Returns the PUBLIC storefront settings for the product mix of the current company. This endpoint is accessible without authentication and returns only the minimal data needed for storefront behavior. Scoped by x-companyid header.

Get the progress of a sync job