A job is a process that can be executed in the PIM to perform various tasks, such as importing or exporting data. Jobs can be used to synchronize data between the PIM and external systems, or to perform bulk operations on products, product models, or other entities.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/akeneo:akeneo-jobs-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Akeneo API REFERENCE Jobs API
version: 1.0.0
description: 'This is the reference documentation for the Akeneo PIM REST API.
It provides detailed information about the available endpoints, request and response formats, and authentication methods.
For more information, visit the Akeneo PIM documentation.'
license:
name: Open Software License 3.0
url: http://opensource.org/licenses/OSL-3.0
contact:
name: Akeneo Support
url: https://www.akeneo.com/support-help-center/
email: contact@akeneo.com
servers:
- url: '{your-pim-url}'
variables:
your-pim-url:
default: ''
description: 'Set the PIM url you want to target ex: https://my-pim.cloud.akeneo.com or https://localhost:8443'
tags:
- name: Jobs
description: 'A job is a process that can be executed in the PIM to perform various tasks, such as importing or exporting data.
Jobs can be used to synchronize data between the PIM and external systems, or to perform bulk operations on products, product models, or other entities.'
paths:
/api/rest/v1/jobs/export/{code}:
post:
operationId: post_export_job_by_code
x-visibility: public
summary: Launch export job by code
description: This endpoint allows you to launch an export job by code
tags:
- Jobs
security:
- bearerToken: []
parameters:
- in: path
name: code
description: 'This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.
It is essential for identifying the specific entity in the API requests.
Ensure that the code is correctly formatted and corresponds to an existing entity in the system.
'
required: true
schema:
type: string
example: my_entity_code
requestBody:
required: false
description: Export jobs accept an optional request body
content:
application/json:
schema:
type: object
additionalProperties: false
example: {}
responses:
'200':
description: Returns the execution ID for the launched job
content:
application/json:
schema:
type: object
properties:
job_execution_id:
description: The ID of the job execution that was launched
example: 12345
oneOf:
- type: integer
description: The ID of the job execution that was launched (integer format)
example: 12345
- type: string
description: The ID of the job execution that was launched (UUID format)
example: 97d314ee-115c-472b-a508-70c50880d775
examples:
integerExample:
summary: Job execution ID as integer
value:
job_execution_id: 12345
stringExample:
summary: Job execution ID as UUID string
value:
job_execution_id: 97d314ee-115c-472b-a508-70c50880d775
'400':
description: 'This response indicates that the server cannot process the request due to a client error, such as malformed request syntax, invalid request message framing, or deceptive request routing.
It is typically used when the server cannot understand the request due to invalid JSON or other client-side issues.
'
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: HTTP status code
example: 401
message:
type: string
description: Message explaining the error
example: Full authentication is required to access this resource.
example:
code: 400
message: Invalid JSON message received
'403':
description: 'This response indicates that the request is not authorized. This can occur when the user lacks the necessary permissions to access a resource or perform an action, or when the request payload is too large for the platform to process.
'
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: HTTP status code
example: 401
message:
type: string
description: Message explaining the error
example: Full authentication is required to access this resource.
example:
code: 403
message: Access forbidden. You are not allowed to list this entity.
'404':
description: 'This response indicates that the requested resource could not be found on the server.
It can occur when the resource code given in the URI does not correspond to any existing PIM resource.
'
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: HTTP status code
example: 401
message:
type: string
description: Message explaining the error
example: Full authentication is required to access this resource.
example:
code: 404
message: Resource `my_resource_code` does not exist.
'422':
description: 'This response indicates that the validation of the entity given in the body of the request failed.
It occurs when the server understands the request but cannot process it due to validation errors in the provided data.
'
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: HTTP status code
example: 422
message:
type: string
description: Message explaining the error
example: Validation failed.
errors:
type: array
description: A list of validation error messages (optional)
items:
type: object
properties:
property:
type: string
description: Name of the invalid property
message:
type: string
description: Human-readable error message
attribute:
type:
- string
- 'null'
description: Attribute code (if the error is on an attribute)
locale:
type:
- string
- 'null'
description: Locale code involved in the error, if any
scope:
type:
- string
- 'null'
description: Channel code involved in the error, if any
example:
- property: family
message: The tshirts family does not exist in your PIM.
_links:
type: object
properties:
documentation:
type: object
properties:
href:
type: string
example:
documentation:
href: http://api.akeneo.com/api-reference.html
example:
code: 422
message: Validation failed.
errors:
- property: family
message: The tshirts family does not exist in your PIM.
- property: categories
message: The "tvs_projectors" category does not exist.
- property: associations.SUBSTITUTION.groups
message: You should associate existing groups. The "promotion" group does not exist.
- property: values
message: The "description" attribute requires a channel.
attribute: description
locale: en_US
scope: null
- property: values
message: The "name" attribute requires a locale.
attribute: name
locale: null
scope: null
_links:
documentation:
href: http://api.akeneo.com/api-reference.html
/api/rest/v1/jobs/import/{code}:
post:
operationId: post_import_job_by_code
x-visibility: public
summary: Launch import job by code
description: This endpoint allows you to launch an import job by code
tags:
- Jobs
security:
- bearerToken: []
parameters:
- in: path
name: code
description: 'This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.
It is essential for identifying the specific entity in the API requests.
Ensure that the code is correctly formatted and corresponds to an existing entity in the system.
'
required: true
schema:
type: string
example: my_entity_code
requestBody:
required: false
description: Body to change the import mode for this job.
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
import_mode:
type: string
enum:
- create_only
- update_only
- create_or_update
description: 'Change the import mode for this job by overriding the profile value.
Available values are: *create_only*, *update_only* and *create_or_update*.
'
example: create_or_update
responses:
'200':
description: Returns the execution ID for the launched job
content:
application/json:
schema:
type: object
properties:
job_execution_id:
description: The ID of the job execution that was launched
example: 12345
oneOf:
- type: integer
description: The ID of the job execution that was launched (integer format)
example: 12345
- type: string
description: The ID of the job execution that was launched (UUID format)
example: 97d314ee-115c-472b-a508-70c50880d775
examples:
integerExample:
summary: Job execution ID as integer
value:
job_execution_id: 12345
stringExample:
summary: Job execution ID as UUID string
value:
job_execution_id: 97d314ee-115c-472b-a508-70c50880d775
'400':
description: 'This response indicates that the server cannot process the request due to a client error, such as malformed request syntax, invalid request message framing, or deceptive request routing.
It is typically used when the server cannot understand the request due to invalid JSON or other client-side issues.
'
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: HTTP status code
example: 401
message:
type: string
description: Message explaining the error
example: Full authentication is required to access this resource.
example:
code: 400
message: Invalid JSON message received
'403':
description: 'This response indicates that the request is not authorized. This can occur when the user lacks the necessary permissions to access a resource or perform an action, or when the request payload is too large for the platform to process.
'
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: HTTP status code
example: 401
message:
type: string
description: Message explaining the error
example: Full authentication is required to access this resource.
example:
code: 403
message: Access forbidden. You are not allowed to list this entity.
'404':
description: 'This response indicates that the requested resource could not be found on the server.
It can occur when the resource code given in the URI does not correspond to any existing PIM resource.
'
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: HTTP status code
example: 401
message:
type: string
description: Message explaining the error
example: Full authentication is required to access this resource.
example:
code: 404
message: Resource `my_resource_code` does not exist.
'422':
description: 'This response indicates that the validation of the entity given in the body of the request failed.
It occurs when the server understands the request but cannot process it due to validation errors in the provided data.
'
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: HTTP status code
example: 422
message:
type: string
description: Message explaining the error
example: Validation failed.
errors:
type: array
description: A list of validation error messages (optional)
items:
type: object
properties:
property:
type: string
description: Name of the invalid property
message:
type: string
description: Human-readable error message
attribute:
type:
- string
- 'null'
description: Attribute code (if the error is on an attribute)
locale:
type:
- string
- 'null'
description: Locale code involved in the error, if any
scope:
type:
- string
- 'null'
description: Channel code involved in the error, if any
example:
- property: family
message: The tshirts family does not exist in your PIM.
_links:
type: object
properties:
documentation:
type: object
properties:
href:
type: string
example:
documentation:
href: http://api.akeneo.com/api-reference.html
example:
code: 422
message: Validation failed.
errors:
- property: family
message: The tshirts family does not exist in your PIM.
- property: categories
message: The "tvs_projectors" category does not exist.
- property: associations.SUBSTITUTION.groups
message: You should associate existing groups. The "promotion" group does not exist.
- property: values
message: The "description" attribute requires a channel.
attribute: description
locale: en_US
scope: null
- property: values
message: The "name" attribute requires a locale.
attribute: name
locale: null
scope: null
_links:
documentation:
href: http://api.akeneo.com/api-reference.html
components:
securitySchemes:
basicToken:
scheme: basic
type: http
description: 'HTTP Basic authentication using user credentials.
[More information here](https://api.akeneo.com/documentation/authentication.html)
'
bearerToken:
scheme: bearer
type: http
description: 'Bearer token obtained via the "Password Grant" flow.
This token authenticates a user, is valid for one hour, and can be refreshed using a refresh token.
[More information here](https://api.akeneo.com/documentation/authentication.html)
'
appToken:
scheme: bearer
type: http
description: 'Bearer token for Apps, obtained via the OAuth 2.0 flow.
This permanent token allows an application to make requests on behalf of a user.
[More information here](https://api.akeneo.com/apps/authentication-and-authorization.html)
'
x-provenance:
method: harvested
publisher: Akeneo
source: https://storage.googleapis.com/akecld-prd-pim-saas-shared-openapi-spec/openapi.yaml
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)