Skip to main content
Start a new mapping job for a partner inventory. The job runs asynchronously. You receive a job ID immediately and poll the status endpoint to track progress. Once complete, results are available via the search endpoint and can be exported on demand.

Request

string
required
UUID of the partner inventory to map. The inventory must already be uploaded and belong to your organization.
string
Mapping mode to use. If omitted, your organization’s default mode preference is applied.
ID_TO_ID and HYBRID modes require the inventory to have a supplierCode set and a connected supplier configured in your organization. If either condition is not met, the request returns 400 Bad Request before a job is created.

Response

A successful request returns HTTP 202 Accepted with a job object. Use the mappingJobId to check status or retrieve results.
string
required
UUID of the newly created mapping job. Use this to poll for status and access results.
string
required
UUID of the partner inventory being mapped.
string
required
Initial status of the job. Always PENDING immediately after creation.
string
required
The resolved mapping mode for this job, either the mode you specified or your organization’s configured default.
string
required
ISO 8601 timestamp of when the job was created.

Error responses

Free plan organizations have a daily mapping limit. Once the limit is reached, additional mappings require available credits. Upgrade to a paid plan for unlimited mappings.

Example