younifyd
Menu

Put Catalog Mapping Schema Product

Create or update the product mapping schema related to a catalog

PUT/api/rest/v1/catalogs/{id}/mapping-schemas/product

Use it in a workflow

  1. Add a step and choose the Akeneo connector.
  2. Pick the Put Catalog Mapping Schema Product action (under Mapping schema for products).
  3. Fill in the fields below, then reference the result from later steps as {{putCatalogMappingSchemaProduct.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.

$idstring

id of your schema

$schemastringrequired

$schema indicates which product mapping schema version your app uses

$commentstring

allows you to add a comment

titlestring

allows you to add a title to your mapping schema

descriptionstring

allows you to add a description of your mapping schema

typestring

should always be "object"

One ofobject

propertiesobjectrequired

list and describe the targets your app expects

json
{
  "$schema": "https://api.akeneo.com/mapping/product/1.0.0/schema",
  "properties": {
    "properties": {
      "code": {
        "title": "Model ID",
        "type": "string"
      },
      "brand": {
        "title": "Brand name",
        "type": "string"
      },
      "description": {
        "title": "Product description",
        "type": "string"
      },
      "fabrics": {
        "title": "Fabrics",
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "localized_names": {
        "title": "Name with multiple locales",
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "locale": {
              "type": "string"
            },
            "value": {
              "type": "string"
            }
          },
          "required": [
            "locale",
            "value"
          ]
        }
      }
    }
  },
  "$id": "https://example.com/product",
  "$comment": "This is a comment about the mapping schema",
  "title": "Product Mapping Schema",
  "description": "This schema describes the product mapping for our application",
  "type": "object"
}

Response

Returns 204 with a any. Read it in later steps with {{putCatalogMappingSchemaProduct.response.data.<field>}}.

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

Put Catalog Mapping Schema Product — Akeneo — Documentation