This guide walks through the complete process of creating a job in the Supplier Data Manager (SDM) REST API: uploading a product data file, creating the job, and optionally attaching media files. Use this workflow to automate how product data is imported and processed in SDM.

Before you start

To create a job via the SDM REST API, you need:

• An active user account on the Supplier Data Manager platform
• A valid API token (obtained via the authentication endpoint — see Getting started with the API)
• The ID of the project you want to process data for
• At least one output format defined for that project

All requests must include the following header:

Authorization: Token <YOUR_TOKEN>

Step 1: Upload your product data file

SDM jobs require a source file containing product data. You can provide this file in two ways: as a flat file upload (CSV, Excel, or XML) or as a JSON payload.

Option A: Upload a flat file (CSV, Excel, or XML)

Send a multipart/form-data request to upload a CSV, Excel (.xlsx), or XML file.

Supported formats:

• Excel (.xlsx): Data must be in the first tab, encoded in UTF-8
• CSV: Accepts ,, ;, or | as separators; encoding must be UTF-8 or ISO 8859-1 / Latin-1
• XML: Requires an XML input format to be configured for your project in SDM

The file must have a header row as its first line and include all columns defined in the project template.

Request: To upload the file, you need to make the following request in multipart/form-data format:

POST https://sdm.akeneo.cloud/api/v1/files/

Headers:

Authorization: Token <YOUR_TOKEN>
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

Body:

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="products.csv"
Content-Type: text/csv

[INSERT_BINARY_FILE_CONTENT_HERE]
----WebKitFormBoundary7MA4YWxkTrZu0gW--

Optional body parameters:

Response:

File parsing is asynchronous. The response contains the file's id, which you use in the next step, along with the current parsing status (parsing, ready, or error).

{
    "id": 17,
    "status": "parsing",
    ...
}

For full file endpoint details, see the API reference.

Option B: Send a JSON payload

Use Content-Type: application/json to send product data directly as a list of objects. Each object represents one product row.

Request:

POST https://sdm.akeneo.cloud/api/v1/files/

Headers:

Authorization: Token <YOUR_TOKEN>
Content-Type: application/json

Body:

{
    "data": [
        {"col1": "val1_1", "col2": "val1_2"},
        {"col1": "val2_1", "col2": "val2_2"}
    ]
}

Each object in data must use column names as keys and column values as values. All columns defined in the project template must be present. Empty values can be omitted or set to null.

Response:

{
    "id": 17,
    "status": "ready",
    ...
}

The response id is the file ID to use when creating the job.

Step 2: Create a job

Once your file is uploaded and its status is ready, create a job to start processing. The job links your uploaded file to a project in SDM and begins the processing pipeline.

You need the following before calling this endpoint:

• file_id: The id returned from Step 1
• project: The integer ID of the SDM project (retrieve project IDs from GET https://sdm.akeneo.cloud/api/v1/projects/ — see the API reference)
• model_version: The version of the project configuration to use. Use 0 to target the initial configuration. This value must not exceed the project's current model_version.

Request:

POST https://sdm.akeneo.cloud/api/v1/jobs/

Headers:

Authorization: Token <YOUR_TOKEN>
Content-Type: application/json

Body:

{
    "file_id": 17,
    "name": "Spring 2025 catalog import",
    "project": 42,
    "model_version": 0
}

Request body fields:

Response:

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "status": "running",
    ...
}

The id in the response is the job's UUID. Save it — you will need it to monitor progress and optionally attach media files.

SDM begins processing your data immediately after the job is created. To monitor job progress, see Monitoring SDM jobs.

Step 3: Attach media files (optional)

You can attach media files to a job at any time during processing. SDM automatically links each media file to the matching product using the filename: if a product row contains a field value (for example, "main_image": "image_show_1.png") and a media file with that exact name is attached to the job, the link is established automatically.

Each media filename must be unique within a given job.

Request:

POST https://sdm.akeneo.cloud/api/v1/media/

Headers:

Authorization: Token <YOUR_TOKEN>
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

Body:

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="media_file"; filename="image_show_1.png"
Content-Type: image/png

[INSERT_BINARY_FILE_CONTENT_HERE]
----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="uploaded_for_job"
Content-Type: text/plain

XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
----WebKitFormBoundary7MA4YWxkTrZu0gW--

Required body fields:

Summary

The full job creation flow in the SDM REST API is:

1. Upload product data — POST /api/v1/files/ with a flat file or JSON payload. Capture the returned id.
2. Wait for parsing — Poll GET /api/v1/files/{id}/ until status is ready.
3. Create the job — POST /api/v1/jobs/ with the file_id, project, name, and model_version. Capture the returned job id.
4. Attach media (optional) — POST /api/v1/media/ with media_file and uploaded_for_job for each media file.
5. Monitor the job — Use GET /api/v1/jobs/{id}/ to track job progress. See Monitoring SDM jobs.

Related articles

• Getting started with the API — Authentication and prerequisites
• Monitoring SDM jobs — Track job status and retrieve output data
• Managing option collections — Manage select field options via the API
• SDM API reference — Full endpoint documentation