Patch Catalog By Id

Update a catalog

PATCH/api/rest/v1/catalogs/{id}

Use it in a workflow

Add a step and choose the Akeneo connector.
Pick the Patch Catalog By Id action (under Catalogs).
Fill in the fields below, then reference the result from later steps as {{patchCatalogById.response.data}}.

Request

Path parameters

idstring (uuid)required

This path parameter is used to specify the unique identifier of the catalog you want to retrieve or manipulate. It is essential for identifying the specific entity in the API requests. Ensure that the catalog ID is correctly formatted and corresponds to an existing entity in the system.

Request body

Enter the body as JSON in the step's Body field.

namestring

Catalog name

managed_currenciesarray<string>

List of currency codes

managed_localesarray<string>

List of locale codes

json

{
  "name": "My app catalog",
  "managed_currencies": [
    "EUR",
    "USD",
    "GBP"
  ],
  "managed_locales": [
    "fr_FR",
    "en_US"
  ]
}

Response

Returns 200 with an object. Read it in later steps with {{patchCatalogById.response.data.<field>}}.

idstring

Catalog id

namestring

Catalog name

enabledboolean

Whether the catalog is enabled or not

Default false

managed_currenciesarray<string>

List of currency codes

managed_localesarray<string>

List of locale codes

json

{
  "id": "12351d98-200e-4bbc-aa19-7fdda1bd14f2",
  "name": "My app catalog",
  "enabled": false,
  "managed_currencies": [
    "EUR",
    "USD",
    "GBP"
  ],
  "managed_locales": [
    "fr_FR",
    "en_US"
  ]
}

Need more? See the Akeneo guide for connection setup and behaviour shared by every action.

Was this page helpful?