This article explains how to use the Supplier Data Manager (SDM) REST API to track the progress of a job, list jobs in your organization, and retrieve job output data in JSON format.
All requests require an Authorization: Token <YOUR_TOKEN> header. For authentication setup, see Getting started with the API.
Get the status of an SDM job
To check the current status of a Supplier Data Manager job, call the job detail endpoint:
GET https://sdm.akeneo.cloud/api/v1/jobs/{job_id}/
Replace {job_id} with the UUID returned when the job was created.
The response includes a status field with one of the following values:
| Status | Meaning |
|---|---|
running |
The job is processing. Poll again in a few seconds. |
done |
The job has completed successfully. You can now retrieve the output data. |
error |
An error occurred. Check the message field in the response for details. |
pending |
The job is waiting for an action on your side before it can continue. |
Example response:
{
"status": "running",
"step": {
"id": 1
}
}
When status is error, the message field in the response contains a description of the failure.
Retrieve the list of SDM jobs
To retrieve all jobs created in your organization, call:
GET https://sdm.akeneo.cloud/api/v1/jobs/
Filter parameters
Narrow results by adding query parameters:
| Parameter | Description |
|---|---|
status |
Filter by job status: running, done, error, or pending
|
project |
Filter by project ID |
created_after |
Return only jobs created after this date (ISO 8601 format) |
created_before |
Return only jobs created before this date (ISO 8601 format) |
Example — all completed jobs for project 17 created after 1 January 2022:
GET https://sdm.akeneo.cloud/api/v1/jobs/?status=done&project=17&created_after=2022-01-01T00:00:00Z
Response format
Results are paginated. The default page size is 25. Use the page and page_size query parameters to control pagination.
{
"count": 100,
"next": "https://sdm.akeneo.cloud/api/v1/jobs/?page=2",
"previous": null,
"results": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"name": "Job 1",
"status": "done",
"creation_date": "2022-04-14T08:48:37.109159Z",
"completion_date": "2022-04-17T09:53:32.12Z"
}
]
}
next and previous contain the URL for the next and previous page respectively, or null if no such page exists.
Retrieve SDM job output data in JSON format
Once an SDM job has status: done, you can retrieve the output data in JSON format:
GET https://sdm.akeneo.cloud/api/v1/jobs/{job_id}/data/{output_format_id}/
Replace {job_id} with the job UUID and {output_format_id} with the ID of the output format configured for the project.
Example response:
[
{
"col1": "val1_1",
"col2": "val2_1"
}
]
The response is an array of objects, one per row of the output dataset. Each object's keys are the column names. Empty columns are omitted from the response.