Winter collection description
\",\n \"channel\": \"ecommerce\",\n \"locale\": \"en_US\",\n \"attribute_code\": \"a_text_area_attribute\"\n },\n {\n \"data\": true,\n \"channel\": \"ecommerce\",\n \"locale\": \"en_US\",\n \"attribute_code\": \"a_boolean_attribute\"\n }\n ],\n \"validations\": {\n \"max_categories_per_product\": 42,\n \"only_leaves\": false,\n \"is_mandatory\": true\n },\n \"channel_requirements\": [\n \"ecommerce\",\n \"mobile\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b043284c-319f-47de-99b7-cb9fb3d1b9aa", "name": "Create or update several categories", "request": { "name": "Create or update several categories", "description": { "content": "This endpoint allows you to update and/or create several categories at once.", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/vnd.akeneo.collection+json" }, { "key": "Accept", "value": "application/vnd.akeneo.collection+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\"code\":\"spring_collection\",\"parent\":null}\n{\"code\":\"woman\",\"parent\":\"spring_collectionn\"}\n{\"code\":\"man\",\"parent\":\"spring_collection\"}\n", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "b743ba3f-dcab-4aeb-81f0-911e263c9383", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[PATCH]::/api/rest/v1/categories - Content-Type is application/vnd.akeneo.collection+json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/vnd.akeneo.collection+json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PATCH]::/api/rest/v1/categories - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"string\"}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/rest/v1/categories - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb498a28-18dd-49bc-a7c9-ce478c0c520c", "name": "Get a category", "request": { "name": "Get a category", "description": { "content": "This endpoint allows you to retrieve a category by its code. The response includes the category's details such as its labels, values, and channel requirements.\nYou can also specify the withposition query parameter to include the position of the category in its level.\nThe withenriched_attributes query parameter allows you to include enriched attributes.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "categories", ":code" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Return information about the category's position within its category tree.", "type": "text/plain" }, "key": "with_position", "value": "true" }, { "disabled": true, "description": { "content": "Return the attribute values of the category.", "type": "text/plain" }, "key": "with_enriched_attributes", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "a1f52190-addd-49df-8f46-db005dbffac2", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/categories/:code - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/categories/:code - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Category code\",\"x-immutable\":true},\"parent\":{\"type\":[\"string\",\"null\"],\"description\":\"Category code of the parent's category\",\"x-validation-rules\":\"- It is either equal to `null` or to an existing category code.\\n- If equal to an existing category code, it cannot reference itself.\\n\"},\"updated\":{\"type\":\"string\",\"description\":\"Date of the last update\",\"format\":\"date-time\"},\"position\":{\"type\":\"integer\",\"description\":\"Position of the category in its level, start from 1 (only available when query parameter `with_position` is set to `true`)\"},\"labels\":{\"type\":\"object\",\"default\":{},\"patternProperties\":{\"^[a-zA-Z]{2,}_[a-zA-Z0-9_]{2,}$\":{\"description\":\"Category label for the specified locale\",\"type\":[\"string\",\"null\"]}},\"x-validation-rules\":\"The `localeCode` is the code of an existing and activated locale\"},\"channel_requirements\":{\"type\":\"array\",\"description\":\"List of Channel codes on which the category is required for products completeness.\\nOnly category trees can be required, not child categories.\\n\",\"items\":{\"type\":\"string\"},\"default\":[]},\"values\":{\"type\":\"object\",\"description\":\"Attribute values\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"The attribute type\"},\"locale\":{\"type\":[\"string\",\"null\"],\"description\":\"[Locale](https://api.akeneo.com/api-reference.html#Locale) code of the attribute value\"},\"channel\":{\"type\":[\"string\",\"null\"],\"description\":\"[Channel](https://api.akeneo.com/api-reference.html#Channel) code of the attribute value\"},\"attribute_code\":{\"type\":\"string\",\"description\":\"The attribute code with its uuid (attributeCode|attributeUuid)\"},\"data\":{\"description\":\"Attribute value\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"boolean\"},{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"product_uuid\":{\"type\":\"string\"},\"product_model_code\":{\"type\":\"string\"}}}]}},{\"type\":\"object\",\"properties\":{\"size\":{\"type\":\"integer\",\"description\":\"Size of the file in bytes\"},\"extension\":{\"type\":\"string\",\"description\":\"File extension\"},\"file_path\":{\"type\":\"string\",\"description\":\"Path to the file in the storage\"},\"mime_type\":{\"type\":\"string\",\"description\":\"MIME type of the file\"},\"original_filename\":{\"type\":\"string\",\"description\":\"Original filename before upload\"}}}]}}}},\"validations\":{\"type\":\"object\",\"description\":\"Category validations\",\"x-validation-rules\":\"Only applicable to root category\",\"default\":{},\"properties\":{\"max_categories_per_product\":{\"type\":\"integer\",\"description\":\"Maximum number of categories per product\"},\"only_leaves\":{\"type\":\"boolean\",\"description\":\"Categorization restricted to the lowest level\"},\"is_mandatory\":{\"type\":\"boolean\",\"description\":\"Category is mandatory for every product\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/categories/:code - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b68b50f9-7cab-4be1-92e6-4042b0817919", "name": "Create or update a category", "request": { "name": "Create or update a category", "description": { "content": "This endpoint allows you to update a given category. Note that if no category exists for the given code, it creates it.\nYou can specify the category's code, parent category, labels, values, validations, and channel requirements.\nThe request body should be in JSON format and include the necessary fields for the category.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "categories", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"winter_collection\",\n \"parent\": null,\n \"labels\": {\n \"en_US\": \"Winter collection\",\n \"fr_FR\": \"Collection hiver\"\n },\n \"values\": [\n {\n \"data\": \"Winter collection description
\",\n \"channel\": \"ecommerce\",\n \"locale\": \"en_US\",\n \"attribute_code\": \"a_text_area_attribute\"\n },\n {\n \"data\": true,\n \"channel\": \"ecommerce\",\n \"locale\": \"en_US\",\n \"attribute_code\": \"a_boolean_attribute\"\n }\n ],\n \"validations\": {\n \"max_categories_per_product\": 42,\n \"only_leaves\": false,\n \"is_mandatory\": true\n },\n \"channel_requirements\": [\n \"ecommerce\",\n \"mobile\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "739e7d35-ecd3-47ca-9a18-9906937cf276", "name": "Create a category media file", "request": { "name": "Create a category media file", "description": { "content": "This endpoint allows you to create a new media file and associate it to anattribute value of a given enriched category.\nIt is used to upload media files that are linked to categories, such as images or documents.\nThe request body should include the category information and the binary file data.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "category-media-files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Equal to 'multipart/form-data' (with [boundary value](https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.2)), no other value allowed.\n", "type": "text/plain" }, "key": "Content-Type", "value": "multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The category to which the media file will be associated.\nIt is a JSON string that follows this format:\n'{\"code\":\"category code\", \"attribute_code\":\"attribute code\", \"channel\":\"channel code or null\", \"locale\":\"locale code or null\"}'.\n", "type": "text/plain" }, "key": "category", "value": "{\"code\":\"ecomm\", \"attribute_code\":\"image_1\", \"channel\":\"ecommerce\", \"locale\":\"en_US\"}", "type": "text" }, { "description": { "content": "(Required) The media file to be uploaded.\nIt should be provided as a binary file.\nEnsure that the file format is supported by the system.\n", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1893e72-cb62-4442-bdd4-c387920b2b54", "name": "Download a category media file", "request": { "name": "Download a category media file", "description": { "content": "This endpoint allows you to download a given media file that is used as an attribute value of a enriched category.\nThe media file is identified by its path, which is provided in the request.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "category-media-files", ":file_path", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the media file you want to download.\nIt is essential for identifying the specific media file in the API requests.\nEnsure that the file path is correctly formatted and corresponds to an existing media file in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_resource_code", "key": "file_path" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "cd5d7c2b-a730-46ba-9c40-e408f1b1146d", "name": "Channel", "description": { "content": "A channel is a way to define how products are presented in different contexts, such as online stores, mobile applications, or print catalogs.\nChannels can have different configurations, such as currencies, locales, and measurement systems.\nThey allow you to tailor the product information to specific markets or audiences.\n", "type": "text/plain" }, "item": [ { "id": "e29430e0-bd94-4b6d-b7c3-e9d61eab7433", "name": "Get a list of channels", "request": { "name": "Get a list of channels", "description": { "content": "This endpoint allows you to get a list of channels.\nChannels are paginated and sorted by code.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "channels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Specify which page of results to retrieve when using pagination.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": true, "description": { "content": "Specify the maximum number of results to return per page.", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": true, "description": { "content": "Return the count of items in the response.", "type": "text/plain" }, "key": "with_count", "value": "true" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "9198009b-2fc2-427b-a5fb-84e1b636bdc7", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/channels - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/channels - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"title\":\"Channels\",\"type\":\"object\",\"allOf\":[{\"type\":\"object\",\"properties\":{\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the current page of resources\"}}},\"first\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the first page of resources\"}}},\"previous\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the previous page of resources\"}}},\"next\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the next page of resources\"}}}}}}},{\"type\":\"object\",\"properties\":{\"current_page\":{\"type\":\"integer\",\"description\":\"Current page number\"},\"items_count\":{\"type\":\"integer\",\"description\":\"Total number of items (only if `with_count` parameter is set to true)\"},\"_embedded\":{\"type\":\"object\",\"properties\":{\"items\":{\"type\":\"array\",\"items\":{\"allOf\":[{\"type\":\"object\",\"properties\":{\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the resource\"}}}}}}},{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Channel code\",\"x-immutable\":true},\"locales\":{\"type\":\"array\",\"description\":\"Codes of activated locales for the channel\",\"items\":{\"type\":\"string\"},\"x-validation-rules\":\"- Each string of the array is an existing locale code.\\n- At least one locale in the array.\\n\"},\"currencies\":{\"type\":\"array\",\"description\":\"Codes of activated currencies for the channel\",\"items\":{\"type\":\"string\"},\"x-validation-rules\":\"- Each string of the array is an existing currency code.\\n- At least one currency in the array.\\n\"},\"category_tree\":{\"type\":\"string\",\"description\":\"Code of the category tree linked to the channel\",\"x-validation-rules\":\"It is the code of an existing category code that is a tree (a category without parent)\"},\"conversion_units\":{\"type\":\"object\",\"description\":\"Units to which the given metric attributes should be converted when exporting products\",\"properties\":{\"attributeCode\":{\"type\":\"string\",\"description\":\"Conversion unit code used to convert the values of the attribute `attributeCode` when exporting via the channel\"}},\"x-validation-rules\":\"- The `attributeCode` is the code of an existing attribute whose type is `pim_catalog_metric`.\\n- The strings are existing unit codes.\\n\"},\"labels\":{\"type\":\"object\",\"description\":\"Channel labels for each locale\",\"default\":{},\"patternProperties\":{\"^[a-zA-Z]{2,}_[a-zA-Z0-9_]{2,}$\":{\"description\":\"Channel label for the specified locale\",\"type\":[\"string\",\"null\"]}},\"x-validation-rules\":\"The `localeCode` is the code of an existing and activated locale\"}}}]}}}}}}]}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/channels - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "82de6eec-98ae-4561-a24b-d81375992e57", "name": "Create a new channel", "request": { "name": "Create a new channel", "description": { "content": "This endpoint allows you to create a new channel.", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "channels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"ecommerce\",\n \"currencies\": [\n \"USD\",\n \"EUR\"\n ],\n \"locales\": [\n \"de_DE\",\n \"en_US\",\n \"fr_FR\"\n ],\n \"category_tree\": \"master\",\n \"conversion_units\": {\n \"weight\": \"KILOGRAM\"\n },\n \"labels\": {\n \"en_US\": \"Ecommerce\",\n \"de_DE\": \"Ecommerce\",\n \"fr_FR\": \"Ecommerce\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f3ec131-282f-4f40-99b5-5c315c6b2b07", "name": "Update/create several channels", "request": { "name": "Update/create several channels", "description": { "content": "This endpoint allows you to update and/or create several channels at once.", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "channels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/vnd.akeneo.collection+json" }, { "key": "Accept", "value": "application/vnd.akeneo.collection+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\"code\":\"ecommerce_fr\", \"category_tree\": \"master\", \"currencies\":[\"EUR\"], \"locales\": [\"fr_FR\"], \"labels\":{\"fr_FR\": \"Ecommerce Fr\"}}\n{\"code\":\"ecommerce_ch\", \"type\":\"bar\"}\n{\"code\":\"tablet\", \"labels\":{\"en_US\": \"Tablet\", \"fr_FR\": \"Tablette\"}}\n", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "06f9849a-31ad-41f6-80a1-3798a3b7ab84", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[PATCH]::/api/rest/v1/channels - Content-Type is application/vnd.akeneo.collection+json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/vnd.akeneo.collection+json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PATCH]::/api/rest/v1/channels - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"string\"}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/rest/v1/channels - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44cce6ce-7d23-45f2-95d1-9eeea9705064", "name": "Get a channel", "request": { "name": "Get a channel", "description": { "content": "This endpoint allows you to get the information about a given channel", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "channels", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "33d46584-8777-4f44-bb3d-c113e986de01", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/channels/:code - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/channels/:code - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Channel code\",\"x-immutable\":true},\"locales\":{\"type\":\"array\",\"description\":\"Codes of activated locales for the channel\",\"items\":{\"type\":\"string\"},\"x-validation-rules\":\"- Each string of the array is an existing locale code.\\n- At least one locale in the array.\\n\"},\"currencies\":{\"type\":\"array\",\"description\":\"Codes of activated currencies for the channel\",\"items\":{\"type\":\"string\"},\"x-validation-rules\":\"- Each string of the array is an existing currency code.\\n- At least one currency in the array.\\n\"},\"category_tree\":{\"type\":\"string\",\"description\":\"Code of the category tree linked to the channel\",\"x-validation-rules\":\"It is the code of an existing category code that is a tree (a category without parent)\"},\"conversion_units\":{\"type\":\"object\",\"description\":\"Units to which the given metric attributes should be converted when exporting products\",\"properties\":{\"attributeCode\":{\"type\":\"string\",\"description\":\"Conversion unit code used to convert the values of the attribute `attributeCode` when exporting via the channel\"}},\"x-validation-rules\":\"- The `attributeCode` is the code of an existing attribute whose type is `pim_catalog_metric`.\\n- The strings are existing unit codes.\\n\"},\"labels\":{\"type\":\"object\",\"description\":\"Channel labels for each locale\",\"default\":{},\"patternProperties\":{\"^[a-zA-Z]{2,}_[a-zA-Z0-9_]{2,}$\":{\"description\":\"Channel label for the specified locale\",\"type\":[\"string\",\"null\"]}},\"x-validation-rules\":\"The `localeCode` is the code of an existing and activated locale\"}},\"example\":{\"code\":\"ecommerce\",\"currencies\":[\"USD\",\"EUR\"],\"locales\":[\"de_DE\",\"en_US\",\"fr_FR\"],\"category_tree\":\"master\",\"conversion_units\":{\"weight\":\"KILOGRAM\"},\"labels\":{\"en_US\":\"Ecommerce\",\"de_DE\":\"Ecommerce\",\"fr_FR\":\"Ecommerce\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/channels/:code - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bf57a0fd-3c32-404d-8b48-f2158ad5e480", "name": "Update/create a channel", "request": { "name": "Update/create a channel", "description": { "content": "This endpoint allows you to update a given channel.\nKnow more about https://api.akeneo.com/documentation/update.html#update-behavior.\nNote that if no channel exists for the given code, it creates it.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "channels", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"ecommerce\",\n \"currencies\": [\n \"USD\",\n \"EUR\"\n ],\n \"locales\": [\n \"de_DE\",\n \"en_US\",\n \"fr_FR\"\n ],\n \"category_tree\": \"master\",\n \"conversion_units\": {\n \"weight\": \"KILOGRAM\"\n },\n \"labels\": {\n \"en_US\": \"Ecommerce\",\n \"de_DE\": \"Ecommerce\",\n \"fr_FR\": \"Ecommerce\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9576a61b-9acb-49a4-a571-4f7753180856", "name": "Locale", "description": { "content": "A locale is a combination of a language (English, German, French...) and a country (United States, United Kingdom, France...).\nExamples: English UK (en_GB), English US (en_US), English AU (en_AU).\nYou can have one or more locales activated in your PIM.\n", "type": "text/plain" }, "item": [ { "id": "b3fc9d8d-91e7-4a25-95ca-eaa67494d738", "name": "Get a list of locales", "request": { "name": "Get a list of locales", "description": { "content": "This endpoint allows you to retrieve a list of locales available in the\nsystem. Locales are paginated and can be filtered using the search query\nparameter. The response includes the locale code and whether it is enabled.\nYou can also specify pagination parameters such as page, limit, and with_count.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "locales" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Specify the maximum number of results to return per page.", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": true, "description": { "content": "Specify which page of results to retrieve when using pagination.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": true, "description": { "content": "The search query parameter allows you to filter locales based on specific criteria.", "type": "text/plain" }, "key": "search", "value": "{\"enabled\":[{\"operator\":\"=\",\"value\":true}]}" }, { "disabled": true, "description": { "content": "Return the count of items in the response.", "type": "text/plain" }, "key": "with_count", "value": "true" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "f0fffb8c-50f2-48c9-b424-ca91fb1db7a5", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/locales - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/locales - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"title\":\"Locales\",\"type\":\"object\",\"allOf\":[{\"type\":\"object\",\"properties\":{\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the current page of resources\"}}},\"first\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the first page of resources\"}}},\"previous\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the previous page of resources\"}}},\"next\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the next page of resources\"}}}}}}},{\"type\":\"object\",\"properties\":{\"current_page\":{\"type\":\"integer\",\"description\":\"Current page number\"},\"items_count\":{\"type\":\"integer\",\"description\":\"Total number of items (only if `with_count` parameter is set to true)\"},\"_embedded\":{\"type\":\"object\",\"properties\":{\"items\":{\"type\":\"array\",\"items\":{\"allOf\":[{\"type\":\"object\",\"properties\":{\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the resource\"}}}}}}},{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Locale code\",\"x-immutable\":true},\"enabled\":{\"type\":\"boolean\",\"description\":\"Whether the locale is enabled\",\"default\":false}}}]}}}}}}]}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/locales - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "32ca8f0a-38af-4733-871d-bf48461f2cd8", "name": "Get a locale", "request": { "name": "Get a locale", "description": { "content": "This endpoint allows you to get the information about a given locale.\nYou can retrieve details such as the locale code and whether it is enabled.\nThe response will be in JSON format.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "locales", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "fa387968-acb3-4d2a-a7a9-2efaafee6894", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/locales/:code - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/locales/:code - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Locale code\",\"x-immutable\":true},\"enabled\":{\"type\":\"boolean\",\"description\":\"Whether the locale is enabled\",\"default\":false}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/locales/:code - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6210acf7-16ae-4dcb-8152-5059deaa3f03", "name": "Currency", "description": { "content": "A currency is a unit of exchange that is used to price products.\nCurrencies are used in the PIM to define the prices of products in different markets.\n", "type": "text/plain" }, "item": [ { "id": "26d80d63-b6fd-40f9-8d7d-5b1107129280", "name": "Get a list of currencies", "request": { "name": "Get a list of currencies", "description": { "content": "This endpoint allows you to retrieve a list of currencies available in the system. Currencies are paginated and can be filtered using the search query parameter. The response includes the currency code, whether it is enabled, and its label. You can also specify pagination parameters such as page, limit, and with_count.", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "currencies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Specify the maximum number of results to return per page.", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": true, "description": { "content": "Specify which page of results to retrieve when using pagination.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": true, "description": { "content": "The search query parameter allows you to filter currencies based on specific criteria.", "type": "text/plain" }, "key": "search", "value": "{\"enabled\":[{\"operator\":\"=\",\"value\":true}]}" }, { "disabled": true, "description": { "content": "Return the count of items in the response.", "type": "text/plain" }, "key": "with_count", "value": "true" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "c2b67e11-69b8-4b46-8e84-23470cfbba53", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/currencies - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/currencies - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"title\":\"Currencies\",\"type\":\"object\",\"allOf\":[{\"type\":\"object\",\"properties\":{\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the current page of resources\"}}},\"first\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the first page of resources\"}}},\"previous\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the previous page of resources\"}}},\"next\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the next page of resources\"}}}}}}},{\"type\":\"object\",\"properties\":{\"current_page\":{\"type\":\"integer\",\"description\":\"Current page number\"},\"items_count\":{\"type\":\"integer\",\"description\":\"Total number of items (only if `with_count` parameter is set to true)\"},\"_embedded\":{\"type\":\"object\",\"properties\":{\"items\":{\"type\":\"array\",\"items\":{\"allOf\":[{\"type\":\"object\",\"properties\":{\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the resource\"}}}}}}},{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Currency code\",\"x-immutable\":true},\"enabled\":{\"type\":\"boolean\",\"description\":\"Whether the currency is enabled\"},\"label\":{\"type\":\"string\",\"description\":\"Currency label\"}}}]}}}}}}]}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/currencies - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d16f341-a904-40b3-b1c7-8d9f7afdb81b", "name": "Get a currency", "request": { "name": "Get a currency", "description": { "content": "This endpoint allows you to get the information about a given currency.\nYou can retrieve details such as the currency code, whether it is enabled, and its label.\nThe response will be in JSON format.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "currencies", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "3c4f52a8-74b3-4a21-9f12-079f4ddb6e74", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/currencies/:code - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/currencies/:code - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Currency code\",\"x-immutable\":true},\"enabled\":{\"type\":\"boolean\",\"description\":\"Whether the currency is enabled\"},\"label\":{\"type\":\"string\",\"description\":\"Currency label\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/currencies/:code - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3758c0aa-1edf-48bb-8e9c-831f9dd47156", "name": "Measurement family", "description": { "content": "A measurement family is a set of comparable units used to measure a specific physical quantity, such as Area, Weight, or Power.\nFor example, the \"Weight\" measurement family can group units like \"Kilogram\" and \"Pound\" together.\nEach family has a standard unit for conversions (e.g., \"Kilogram\"), and all other units within that family include their conversion formulas.\nThese families are used for metric attributes, allowing product data to be entered in one unit and automatically converted for different channels or locales.\n", "type": "text/plain" }, "item": [ { "id": "0a44941a-1f8c-4cde-a511-395f8b451356", "name": "Get list of measurement families", "request": { "name": "Get list of measurement families", "description": { "content": "This endpoint allows you to get a list of measurement families", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "measurement-families" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "14796f4f-6f48-46fd-9dea-132055c114bf", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/measurement-families - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/measurement-families - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"code\",\"standard_unit_code\",\"units\"],\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Measurement family code\"},\"labels\":{\"type\":\"object\",\"description\":\"Measurement family labels for each locale\",\"default\":{},\"patternProperties\":{\"^[a-zA-Z]{2,}_[a-zA-Z0-9_]{2,}$\":{\"description\":\"Measurement family label for the specified locale\",\"type\":[\"string\",\"null\"]}},\"x-validation-rules\":\"The `localeCode` is the code of an existing and activated locale\"},\"standard_unit_code\":{\"type\":\"string\",\"description\":\"Unit code used as the standard unit for this measurement family\",\"x-validation-rules\":\"The unit code exists in the list of the property `units`\"},\"units\":{\"type\":\"object\",\"description\":\"Measurement units for this family with their conversion operations.\\nMore details [here](https://api.akeneo.com/concepts/target-market-settings.html#focus-on-the-units)\\n\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Measurement unit code\"},\"labels\":{\"type\":\"object\",\"description\":\"Unit labels for each locale\",\"default\":{},\"patternProperties\":{\"^[a-zA-Z]{2,}_[a-zA-Z0-9_]{2,}$\":{\"description\":\"Unit label for the specified locale\",\"type\":[\"string\",\"null\"]}},\"x-validation-rules\":\"The `localeCode` is the code of an existing and activated locale\"},\"convert_from_standard\":{\"type\":\"array\",\"description\":\"Calculation to convert the unit from the standard unit.\\nMore details [here](https://api.akeneo.com/concepts/target-market-settings.html#focus-on-the-units)\\n\",\"items\":{\"type\":\"object\",\"properties\":{\"operator\":{\"type\":\"string\",\"description\":\"Operator for the conversion operation\",\"enum\":[\"mul\",\"div\",\"add\",\"sub\"],\"x-validation-rules\":\"The operator is one of the following values\"},\"value\":{\"type\":\"string\",\"description\":\"Value for the conversion operation.\"}}},\"x-validation-rules\":\"- The conversion operations can't be updated when a product attribute is linked to this measurement family.\\n- At least one conversion operation per unit is required.\\n\"},\"symbol\":{\"type\":\"string\",\"description\":\"Measurement unit symbol.\"}}},\"x-validation-rules\":\"A unit can't be added when a product attribute is linked to this measurement family\"}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/measurement-families - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ecef296-1cfb-4ddc-ad56-781ba024a2a0", "name": "Update/create several measurement families", "request": { "name": "Update/create several measurement families", "description": { "content": "This endpoint allows you to update and/or create several measurement families at once", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "measurement-families" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"AREA\",\n \"labels\": {\n \"en_US\": \"Area\",\n \"fr_FR\": \"Surface\"\n },\n \"standard_unit_code\": \"SQUARE_METER\",\n \"units\": {\n \"SQUARE_MILLIMETER\": {\n \"code\": \"SQUARE_MILLIMETER\",\n \"labels\": {\n \"en_US\": \"Square millimeter\",\n \"fr_FR\": \"Millimètre carré\"\n },\n \"convert_from_standard\": [\n {\n \"operator\": \"mul\",\n \"value\": \"0.000001\"\n }\n ],\n \"symbol\": \"mm²\"\n },\n \"SQUARE_CENTIMETER\": {\n \"code\": \"SQUARE_CENTIMETER\",\n \"labels\": {\n \"en_US\": \"Square centimeter\",\n \"fr_FR\": \"Centimètre carré\"\n },\n \"convert_from_standard\": [\n {\n \"operator\": \"mul\",\n \"value\": \"0.0001\"\n }\n ],\n \"symbol\": \"cm²\"\n },\n \"SQUARE_METER\": {\n \"code\": \"SQUARE_METER\",\n \"labels\": {\n \"en_US\": \"Square meter\",\n \"fr_FR\": \"Mètre carré\"\n },\n \"convert_from_standard\": [\n {\n \"operator\": \"mul\",\n \"value\": \"1\"\n }\n ],\n \"symbol\": \"m²\"\n }\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "8437279c-33c5-4b02-9a1a-cf75562a13db", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[PATCH]::/api/rest/v1/measurement-families - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PATCH]::/api/rest/v1/measurement-families - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Resource code\"},\"status_code\":{\"type\":\"integer\",\"description\":\"HTTP status code. See the documentation for client errors to understand the meaning of each code\"},\"message\":{\"type\":\"string\",\"description\":\"Message explaining the error, if any\"},\"errors\":{\"type\":\"array\",\"description\":\"List of errors for a given resource\",\"items\":{\"type\":\"object\",\"properties\":{\"property\":{\"type\":\"string\"},\"message\":{\"type\":\"string\"}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/rest/v1/measurement-families - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "db6ce8ef-2102-49fd-9bf9-9e8cc7cc7d10", "name": "Reference entity", "description": { "content": "A reference entity is a custom entity that can be used to store additional information about products or product models.\nIt allows you to create your own entities with their own attributes and values, which can be linked to products or product models.\nReference entities are useful for managing complex data structures or for integrating with external systems.\n", "type": "text/plain" }, "item": [ { "id": "724c6072-be7d-48fc-8f57-39156bcdcdc4", "name": "Get list of reference entities", "request": { "name": "Get list of reference entities", "description": { "content": "This endpoint allows you to get a list of reference entities.\nReference entities are paginated.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "reference-entities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Cursor when using the search_after pagination method type.", "type": "text/plain" }, "key": "search_after", "value": "qaXbcde" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "c1ef1495-7a11-47c3-8672-da0f5402ae67", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/reference-entities - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/reference-entities - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"title\":\"Reference Entities\",\"type\":\"object\",\"allOf\":[{\"type\":\"object\",\"properties\":{\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the current page of resources\"}}},\"first\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the first page of resources\"}}},\"previous\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the previous page of resources\"}}},\"next\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the next page of resources\"}}}}}}},{\"type\":\"object\",\"properties\":{\"_embedded\":{\"type\":\"object\",\"properties\":{\"items\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"allOf\":[{\"type\":\"object\",\"properties\":{\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the resource\"}}},\"image_download\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI to download the binaries of the reference entity image file\"}}}}}}},{\"type\":\"object\",\"required\":[\"code\"],\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Reference entity code\",\"x-immutable\":true},\"labels\":{\"type\":\"object\",\"description\":\"Reference entity labels for each locale\",\"default\":{},\"patternProperties\":{\"^[a-zA-Z]{2,}_[a-zA-Z0-9_]{2,}$\":{\"description\":\"Reference entity label for the locale\",\"type\":[\"string\",\"null\"]}},\"x-validation-rules\":\"The `localeCode` is the code of an existing and activated locale\"},\"image\":{\"type\":[\"string\",\"null\"],\"description\":\"Code of the reference entity image\",\"default\":null}}}]}}}}}}]}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/reference-entities - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "96f73fc0-4e1d-4f9e-8391-4df290e4445b", "name": "Get a reference entity", "request": { "name": "Get a reference entity", "description": { "content": "This endpoint allows you to get the information about a given reference entity", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "reference-entities", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "41cbde35-bce0-4e4f-aea0-ed224c1cae18", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/reference-entities/:code - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/reference-entities/:code - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"object\",\"allOf\":[{\"type\":\"object\",\"properties\":{\"_links\":{\"type\":\"object\",\"properties\":{\"image_download\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI to download the binaries of the reference entity image file\"}}}}}}},{\"type\":\"object\",\"required\":[\"code\"],\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Reference entity code\",\"x-immutable\":true},\"labels\":{\"type\":\"object\",\"description\":\"Reference entity labels for each locale\",\"default\":{},\"patternProperties\":{\"^[a-zA-Z]{2,}_[a-zA-Z0-9_]{2,}$\":{\"description\":\"Reference entity label for the locale\",\"type\":[\"string\",\"null\"]}},\"x-validation-rules\":\"The `localeCode` is the code of an existing and activated locale\"},\"image\":{\"type\":[\"string\",\"null\"],\"description\":\"Code of the reference entity image\",\"default\":null}}}]}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/reference-entities/:code - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c8c4440-1724-4608-86a5-21ccd2029205", "name": "Update/create a reference entity", "request": { "name": "Update/create a reference entity", "description": { "content": "This endpoint allows you to update a given reference entity.\nNote that if the reference entity does not already exist, it creates it.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "reference-entities", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"brands\",\n \"labels\": {\n \"en_US\": \"Brands\",\n \"fr_FR\": \"Marques\"\n },\n \"image\": \"0/2/d/6/54d81dc888ba1501a8g765f3ab5797569f3bv756c_ref_img.png\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e85989ba-8fd2-4f7b-949b-c47af68bc378", "name": "Reference entity attribute", "description": { "content": "A reference entity attribute is a piece of information that can be associated with a reference entity.\nReference entity attributes can be used to store various types of data, such as text, numbers, dates, or media files.\nThey are used to define the characteristics of reference entities and to provide additional information about them.\n", "type": "text/plain" }, "item": [ { "id": "2fb8c87a-ece7-4924-be81-4d71d2eeb88b", "name": "Get the list of attributes of a given reference entity", "request": { "name": "Get the list of attributes of a given reference entity", "description": { "content": "This endpoint allows you to get the list of attributes of a given reference entity", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "reference-entities", ":reference_entity_code", "attributes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the reference entity you want to retrieve or manipulate.\nIt is essential for identifying the specific reference entity in the API requests.\nEnsure that the reference entity code is correctly formatted and corresponds to an existing reference entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "brands", "key": "reference_entity_code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "a344e653-a515-4de5-9739-309781b2d2eb", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/attributes - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/attributes - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"code\",\"type\"],\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Attribute code\",\"x-immutable\":true},\"labels\":{\"type\":\"object\",\"description\":\"Attribute labels per locale\",\"default\":{},\"patternProperties\":{\"^[a-zA-Z]{2,}_[a-zA-Z0-9_]{2,}$\":{\"description\":\"Attribute label for the specified locale\",\"type\":[\"string\",\"null\"]}},\"x-validation-rules\":\"The `localeCode` is the code of an existing and activated locale\"},\"type\":{\"type\":\"string\",\"description\":\"Attribute type.\\nSee [type](https://api.akeneo.com/concepts/reference-entities.html#reference-entity-attribute) section for more details.\\n\",\"enum\":[\"text\",\"image\",\"number\",\"single_option\",\"multiple_options\",\"reference_entity_single_link\",\"reference_entity_multiple_links\",\"asset_collection\"],\"x-immutable\":true},\"value_per_locale\":{\"type\":\"boolean\",\"description\":\"Whether the attribute is localizable, i.e. can have one value by locale\",\"default\":false,\"x-immutable\":true},\"value_per_channel\":{\"type\":\"boolean\",\"description\":\"Whether the attribute is scopable, i.e. can have one value by channel\",\"default\":false,\"x-immutable\":true},\"is_required_for_completeness\":{\"type\":\"boolean\",\"description\":\"Whether the attribute should be part of the record's completeness calculation\",\"default\":false},\"max_characters\":{\"type\":[\"integer\",\"null\"],\"description\":\"Maximum number of characters allowed for the value of the attribute when the attribute type is `text`\",\"x-warning\":\"Only for `text` attribute type\"},\"is_textarea\":{\"type\":\"boolean\",\"description\":\"Whether the UI should display a text area instead of a simple field when the attribute type is `text`\",\"default\":false,\"x-warning\":\"Only for `text` attribute type\"},\"is_rich_text_editor\":{\"type\":\"boolean\",\"description\":\"Whether the UI should display a rich text editor instead of a simple text area when the attribute type is `text`\",\"default\":false,\"x-validation-rules\":\"Required when the property `is_textarea` is equal to `true`\",\"x-warning\":\"Only for `text` attribute type\"},\"validation_rule\":{\"type\":[\"string\",\"null\"],\"description\":\"Validation rule type used to validate the attribute value when the attribute type is `text`\",\"enum\":[\"email\",\"url\",\"regular_expression\",\"none\",null],\"default\":\"none\",\"x-validation-rules\":\"Required when the property `validation_rule` is equal to `regular_expression`\",\"x-warning\":\"Only for `text` attribute type\"},\"validation_regexp\":{\"type\":[\"string\",\"null\"],\"description\":\"Regexp expression used to validate the attribute value when the attribute type is `text`\",\"x-validation-rules\":\"Required when the property `validation_rule` is equal to `regular_expression`\",\"x-warning\":\"Only for `text` attribute type\"},\"allowed_extensions\":{\"type\":\"array\",\"description\":\"Extensions allowed when the attribute type is `image`\",\"items\":{\"type\":\"string\"},\"default\":[],\"x-warning\":\"Only for `image` attribute type\"},\"max_file_size\":{\"type\":[\"string\",\"null\"],\"description\":\"Max file size in MB when the attribute type is `image`\",\"x-warning\":\"Only for `image` attribute type\"},\"reference_entity_code\":{\"type\":[\"string\",\"null\"],\"description\":\"Code of the linked reference entity when the attribute type is `reference_entity_single_link` or `reference_entity_multiple_links`\",\"x-immutable\":true,\"x-validation-rules\":\"Required when the attribute type is either `reference_entity_single_link` or `reference_entity_multiple_links`\",\"x-warning\":\"Only for `reference_entity_single_link` and `reference_entity_multiple_links` attribute type\"},\"asset_family_identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Code of the linked asset family when the attribute type is `asset_collection`\",\"x-immutable\":true,\"x-validation-rules\":\"Required when the attribute type is `asset_collection`\",\"x-warning\":\"Only for `asset_collection` attribute type\"},\"decimals_allowed\":{\"type\":\"boolean\",\"description\":\"Whether decimals are allowed when the attribute type is `number`\",\"default\":false,\"x-warning\":\"Only for `number` attribute type\"},\"min_value\":{\"type\":[\"string\",\"null\"],\"description\":\"Minimum value allowed when the attribute type is `number`\",\"x-validation-rules\":\"The minimum value must be lower than the maximum value\",\"x-warning\":\"Only for `number` attribute type\"},\"max_value\":{\"type\":[\"string\",\"null\"],\"description\":\"Maximum value allowed when the attribute type is `number`\",\"x-validation-rules\":\"The maximum value must be greater than the minimum value\",\"x-warning\":\"Only for `number` attribute type\"}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/attributes - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71cdf622-15ea-4a5e-b8fd-e7fedcc222ce", "name": "Get an attribute of a given reference entity", "request": { "name": "Get an attribute of a given reference entity", "description": { "content": "This endpoint allows you to get the information about a given attribute for a given reference entity", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "reference-entities", ":reference_entity_code", "attributes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the reference entity you want to retrieve or manipulate.\nIt is essential for identifying the specific reference entity in the API requests.\nEnsure that the reference entity code is correctly formatted and corresponds to an existing reference entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "brands", "key": "reference_entity_code" }, { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "7fed51e8-2e90-48c5-a3fe-51a17f0a3020", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/attributes/:code - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/attributes/:code - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"object\",\"required\":[\"code\",\"type\"],\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Attribute code\",\"x-immutable\":true},\"labels\":{\"type\":\"object\",\"description\":\"Attribute labels per locale\",\"default\":{},\"patternProperties\":{\"^[a-zA-Z]{2,}_[a-zA-Z0-9_]{2,}$\":{\"description\":\"Attribute label for the specified locale\",\"type\":[\"string\",\"null\"]}},\"x-validation-rules\":\"The `localeCode` is the code of an existing and activated locale\"},\"type\":{\"type\":\"string\",\"description\":\"Attribute type.\\nSee [type](https://api.akeneo.com/concepts/reference-entities.html#reference-entity-attribute) section for more details.\\n\",\"enum\":[\"text\",\"image\",\"number\",\"single_option\",\"multiple_options\",\"reference_entity_single_link\",\"reference_entity_multiple_links\",\"asset_collection\"],\"x-immutable\":true},\"value_per_locale\":{\"type\":\"boolean\",\"description\":\"Whether the attribute is localizable, i.e. can have one value by locale\",\"default\":false,\"x-immutable\":true},\"value_per_channel\":{\"type\":\"boolean\",\"description\":\"Whether the attribute is scopable, i.e. can have one value by channel\",\"default\":false,\"x-immutable\":true},\"is_required_for_completeness\":{\"type\":\"boolean\",\"description\":\"Whether the attribute should be part of the record's completeness calculation\",\"default\":false},\"max_characters\":{\"type\":[\"integer\",\"null\"],\"description\":\"Maximum number of characters allowed for the value of the attribute when the attribute type is `text`\",\"x-warning\":\"Only for `text` attribute type\"},\"is_textarea\":{\"type\":\"boolean\",\"description\":\"Whether the UI should display a text area instead of a simple field when the attribute type is `text`\",\"default\":false,\"x-warning\":\"Only for `text` attribute type\"},\"is_rich_text_editor\":{\"type\":\"boolean\",\"description\":\"Whether the UI should display a rich text editor instead of a simple text area when the attribute type is `text`\",\"default\":false,\"x-validation-rules\":\"Required when the property `is_textarea` is equal to `true`\",\"x-warning\":\"Only for `text` attribute type\"},\"validation_rule\":{\"type\":[\"string\",\"null\"],\"description\":\"Validation rule type used to validate the attribute value when the attribute type is `text`\",\"enum\":[\"email\",\"url\",\"regular_expression\",\"none\",null],\"default\":\"none\",\"x-validation-rules\":\"Required when the property `validation_rule` is equal to `regular_expression`\",\"x-warning\":\"Only for `text` attribute type\"},\"validation_regexp\":{\"type\":[\"string\",\"null\"],\"description\":\"Regexp expression used to validate the attribute value when the attribute type is `text`\",\"x-validation-rules\":\"Required when the property `validation_rule` is equal to `regular_expression`\",\"x-warning\":\"Only for `text` attribute type\"},\"allowed_extensions\":{\"type\":\"array\",\"description\":\"Extensions allowed when the attribute type is `image`\",\"items\":{\"type\":\"string\"},\"default\":[],\"x-warning\":\"Only for `image` attribute type\"},\"max_file_size\":{\"type\":[\"string\",\"null\"],\"description\":\"Max file size in MB when the attribute type is `image`\",\"x-warning\":\"Only for `image` attribute type\"},\"reference_entity_code\":{\"type\":[\"string\",\"null\"],\"description\":\"Code of the linked reference entity when the attribute type is `reference_entity_single_link` or `reference_entity_multiple_links`\",\"x-immutable\":true,\"x-validation-rules\":\"Required when the attribute type is either `reference_entity_single_link` or `reference_entity_multiple_links`\",\"x-warning\":\"Only for `reference_entity_single_link` and `reference_entity_multiple_links` attribute type\"},\"asset_family_identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Code of the linked asset family when the attribute type is `asset_collection`\",\"x-immutable\":true,\"x-validation-rules\":\"Required when the attribute type is `asset_collection`\",\"x-warning\":\"Only for `asset_collection` attribute type\"},\"decimals_allowed\":{\"type\":\"boolean\",\"description\":\"Whether decimals are allowed when the attribute type is `number`\",\"default\":false,\"x-warning\":\"Only for `number` attribute type\"},\"min_value\":{\"type\":[\"string\",\"null\"],\"description\":\"Minimum value allowed when the attribute type is `number`\",\"x-validation-rules\":\"The minimum value must be lower than the maximum value\",\"x-warning\":\"Only for `number` attribute type\"},\"max_value\":{\"type\":[\"string\",\"null\"],\"description\":\"Maximum value allowed when the attribute type is `number`\",\"x-validation-rules\":\"The maximum value must be greater than the minimum value\",\"x-warning\":\"Only for `number` attribute type\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/attributes/:code - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2697e98-5589-45dc-95eb-be2cf887a742", "name": "Update/create an attribute of a given reference entity", "request": { "name": "Update/create an attribute of a given reference entity", "description": { "content": "This endpoint allows you to update a given attribute for a given reference entity.\nNote that if the attribute does not already exist for the given reference entity, it creates it.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "reference-entities", ":reference_entity_code", "attributes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the reference entity you want to retrieve or manipulate.\nIt is essential for identifying the specific reference entity in the API requests.\nEnsure that the reference entity code is correctly formatted and corresponds to an existing reference entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "brands", "key": "reference_entity_code" }, { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"description\",\n \"labels\": {\n \"en_US\": \"Description\",\n \"fr_FR\": \"Description\"\n },\n \"type\": \"text\",\n \"value_per_locale\": true,\n \"value_per_channel\": false,\n \"is_required_for_completeness\": true,\n \"is_textarea\": true,\n \"is_rich_text_editor\": true,\n \"validation_rule\": \"none\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a184e749-f3cb-49ae-8584-51dd1c1a0467", "name": "Reference entity attribute option", "description": { "content": "A reference entity attribute option is a value that can be associated with a reference entity attribute.\nFor example, if you have a reference entity attribute called \"Category\", the options could be \"Electronics\", \"Clothing\", \"Books\", etc.\nOptions are used to provide predefined values for reference entity attributes, making it easier to manage and maintain reference entity data.\n", "type": "text/plain" }, "item": [ { "id": "7bfe6b31-6f51-4a9b-941c-d764879b00a0", "name": "Get a list of attribute options of a given attribute for a given reference entity", "request": { "name": "Get a list of attribute options of a given attribute for a given reference entity", "description": { "content": "This endpoint allows you to get a list of attribute options for a given reference entity", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "reference-entities", ":reference_entity_code", "attributes", ":attribute_code", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the reference entity you want to retrieve or manipulate.\nIt is essential for identifying the specific reference entity in the API requests.\nEnsure that the reference entity code is correctly formatted and corresponds to an existing reference entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "brands", "key": "reference_entity_code" }, { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the attribute you want to retrieve or manipulate.\nIt is essential for identifying the specific attribute in the API requests.\nEnsure that the attribute code is correctly formatted and corresponds to an existing attribute in the system.\n", "type": "text/plain" }, "type": "any", "value": "color", "key": "attribute_code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "80296635-67cf-4d8c-b5d1-2b1d2cd70d48", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/attributes/:attribute_code/options - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/attributes/:attribute_code/options - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"code\"],\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Attribute's option code\"},\"labels\":{\"type\":\"object\",\"description\":\"Attribute labels for each locale\",\"default\":{},\"patternProperties\":{\"^[a-zA-Z]{2,}_[a-zA-Z0-9_]{2,}$\":{\"description\":\"Attribute label for the specified locale\",\"type\":[\"string\",\"null\"]}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/attributes/:attribute_code/options - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6c29caf0-f4af-478c-aa1f-1125d66a4993", "name": "Get an attribute option for a given attribute of a given reference entity", "request": { "name": "Get an attribute option for a given attribute of a given reference entity", "description": { "content": "This endpoint allows you to get the information about a given attribute option", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "reference-entities", ":reference_entity_code", "attributes", ":attribute_code", "options", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the reference entity you want to retrieve or manipulate.\nIt is essential for identifying the specific reference entity in the API requests.\nEnsure that the reference entity code is correctly formatted and corresponds to an existing reference entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "brands", "key": "reference_entity_code" }, { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the attribute you want to retrieve or manipulate.\nIt is essential for identifying the specific attribute in the API requests.\nEnsure that the attribute code is correctly formatted and corresponds to an existing attribute in the system.\n", "type": "text/plain" }, "type": "any", "value": "color", "key": "attribute_code" }, { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "9db79dd2-bd39-479b-ac03-e3071f963b67", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/attributes/:attribute_code/options/:code - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/attributes/:attribute_code/options/:code - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"object\",\"required\":[\"code\"],\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Attribute's option code\"},\"labels\":{\"type\":\"object\",\"description\":\"Attribute labels for each locale\",\"default\":{},\"patternProperties\":{\"^[a-zA-Z]{2,}_[a-zA-Z0-9_]{2,}$\":{\"description\":\"Attribute label for the specified locale\",\"type\":[\"string\",\"null\"]}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/attributes/:attribute_code/options/:code - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "651d5e35-a673-403f-a5b0-903adac47e51", "name": "Update/create a reference entity attribute option", "request": { "name": "Update/create a reference entity attribute option", "description": { "content": "This endpoint allows you to update a given option for a given attribute and a given reference entity. \nLearn more about https://api.akeneo.com/documentation/update.html#update-behavior. \nNote that if the option does not already exist for the given attribute of the given reference entity, it creates it.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "reference-entities", ":reference_entity_code", "attributes", ":attribute_code", "options", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the reference entity you want to retrieve or manipulate.\nIt is essential for identifying the specific reference entity in the API requests.\nEnsure that the reference entity code is correctly formatted and corresponds to an existing reference entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "brands", "key": "reference_entity_code" }, { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the attribute you want to retrieve or manipulate.\nIt is essential for identifying the specific attribute in the API requests.\nEnsure that the attribute code is correctly formatted and corresponds to an existing attribute in the system.\n", "type": "text/plain" }, "type": "any", "value": "color", "key": "attribute_code" }, { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"global_nomad\",\n \"labels\": {\n \"en_US\": \"Global Nomad\",\n \"fr_FR\": \"Nomade du Monde\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "47713737-9b5f-4f46-b01b-6f174e420cea", "name": "Reference entity record", "description": { "content": "A reference entity record is a specific instance of a reference entity.\nIt contains the values for the attributes defined in the reference entity.\nReference entity records can be linked to products or product models, allowing you to associate additional information with them.\n", "type": "text/plain" }, "item": [ { "id": "555ce146-0fa6-4b5a-bc34-fb9f4878f4cc", "name": "Get all records across all reference entities", "request": { "name": "Get all records across all reference entities", "description": { "content": "This endpoint allows you to get a list of records across all reference entities.\nRecords are paginated and can be filtered.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "reference-entities", "records" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter record values to return scopable record attributes for the given channel as well as the non localizable/non scopable record attributes,\nfor more details see the [Filter record values by channel](https://api.", "type": "text/plain" }, "key": "channel", "value": "ecommerce" }, { "disabled": true, "description": { "content": "Filter record values to return localizable record attributes for the given locales as well as the non localizable/non scopable record attributes,\nfor more details see the [Filter record values by locale](https://api.", "type": "text/plain" }, "key": "locales", "value": "en_US,fr_FR" }, { "disabled": true, "description": { "content": "Filter records by a specific reference entity code", "type": "text/plain" }, "key": "reference_entity", "value": "consequat pariatur proident Lorem" }, { "disabled": true, "description": { "content": "Filter records,\nfor more details see the [Filters](https://api.", "type": "text/plain" }, "key": "search", "value": "{\"code\":[{\"operator\":\"IN\",\"value\":[\"code1\",\"code2\"]}]}" }, { "disabled": true, "description": { "content": "Filter the records to get only the completed ones on a given channel for given locales", "type": "text/plain" }, "key": "search", "value": "{\"complete\":{\"operator\":\"=\",\"value\":true,\"channel\":\"ecommerce\",\"locales\":[\"en_US\"]}}" }, { "disabled": true, "description": { "content": "Filter the records by their update date", "type": "text/plain" }, "key": "search", "value": "{\"updated\":[{\"operator\":\">\",\"value\":\"2018-07-04T10:00:00+00:00\"}]}" }, { "disabled": true, "description": { "content": "Filter by a text attribute value", "type": "text/plain" }, "key": "search", "value": "{\"description\":{\"operator\":\"CONTAINS\",\"value\":\"furniture\",\"locale\":\"en_US\",\"channel\":\"ecommerce\"}}" }, { "disabled": true, "description": { "content": "Filter by a number attribute value", "type": "text/plain" }, "key": "search", "value": "{\"creation_year\":{\"operator\":\">\",\"value\":\"1950\"}}" }, { "disabled": true, "description": { "content": "Filter by an option (single or multiple)", "type": "text/plain" }, "key": "search", "value": "{\"nationality\":{\"operator\":\"IN\",\"value\":[\"french\",\"italian\"]}}" }, { "disabled": true, "description": { "content": "Filter by a reference entity link (single or multiple)", "type": "text/plain" }, "key": "search", "value": "{\"designers\":{\"operator\":\"IN\",\"value\":[\"starck\",\"dixon\"]}}" }, { "disabled": true, "description": { "content": "Cursor when using the search_after pagination method type.", "type": "text/plain" }, "key": "search_after", "value": "qaXbcde" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "d37383d4-fc60-4506-bd95-323419e7378b", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/reference-entities/records - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/reference-entities/records - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"object\",\"allOf\":[{\"type\":\"object\",\"properties\":{\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the current page of resources\"}}},\"first\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the first page of resources\"}}},\"previous\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the previous page of resources\"}}},\"next\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the next page of resources\"}}}}}}},{\"type\":\"object\",\"properties\":{\"_embedded\":{\"type\":\"object\",\"properties\":{\"items\":{\"type\":\"array\",\"items\":{\"allOf\":[{\"type\":\"object\",\"required\":[\"code\"],\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Code of the record\"},\"values\":{\"type\":\"object\",\"description\":\"Record attribute values\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"data\"],\"properties\":{\"locale\":{\"description\":\"Locale code of the value\",\"type\":[\"string\",\"null\"]},\"channel\":{\"description\":\"Channel code of the value\",\"type\":[\"string\",\"null\"]},\"data\":{\"description\":\"Reference entity record value.\\nSee [the `data` format](https://api.akeneo.com/concepts/reference-entities.html#the-data-format) section for more details.\\n\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"object\"},{\"type\":\"null\"}]}}}},\"x-validation-rules\":\"Validation rules detailed in Reference entity record values section\"},\"created\":{\"type\":[\"string\",\"null\"],\"format\":\"date-time\"},\"updated\":{\"type\":[\"string\",\"null\"],\"format\":\"date-time\"}}},{\"type\":\"object\",\"properties\":{\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the resource\"}}}}}}}]}}}}}}]}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/reference-entities/records - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a869b68c-e6e8-405f-9701-ed4eaf36f5d5", "name": "Get the list of the records of a reference entity", "request": { "name": "Get the list of the records of a reference entity", "description": { "content": "This endpoint allows you to get a list of records of a given reference entity.\nRecords are paginated and can be filtered.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "reference-entities", ":reference_entity_code", "records" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter record values to return scopable record attributes for the given channel as well as the non localizable/non scopable record attributes,\nfor more details see the [Filter record values by channel](https://api.", "type": "text/plain" }, "key": "channel", "value": "ecommerce" }, { "disabled": true, "description": { "content": "Filter record values to return localizable record attributes for the given locales as well as the non localizable/non scopable record attributes,\nfor more details see the [Filter record values by locale](https://api.", "type": "text/plain" }, "key": "locales", "value": "en_US,fr_FR" }, { "disabled": true, "description": { "content": "Filter records of the reference entity,\nfor more details see the [Filters](https://api.", "type": "text/plain" }, "key": "search", "value": "{\"code\":[{\"operator\":\"IN\",\"value\":[\"code1\",\"code2\"]}]}" }, { "disabled": true, "description": { "content": "Filter the records to get only the completed ones on a given channel for given locales", "type": "text/plain" }, "key": "search", "value": "{\"complete\":{\"operator\":\"=\",\"value\":true,\"channel\":\"ecommerce\",\"locales\":[\"en_US\"]}}" }, { "disabled": true, "description": { "content": "Filter the records by their update date", "type": "text/plain" }, "key": "search", "value": "{\"updated\":[{\"operator\":\">\",\"value\":\"2018-07-04T10:00:00+00:00\"}]}" }, { "disabled": true, "description": { "content": "Filter by a text attribute value", "type": "text/plain" }, "key": "search", "value": "{\"description\":{\"operator\":\"CONTAINS\",\"value\":\"furniture\",\"locale\":\"en_US\",\"channel\":\"ecommerce\"}}" }, { "disabled": true, "description": { "content": "Filter by a number attribute value", "type": "text/plain" }, "key": "search", "value": "{\"creation_year\":{\"operator\":\">\",\"value\":\"1950\"}}" }, { "disabled": true, "description": { "content": "Filter by an option (single or multiple)", "type": "text/plain" }, "key": "search", "value": "{\"nationality\":{\"operator\":\"IN\",\"value\":[\"french\",\"italian\"]}}" }, { "disabled": true, "description": { "content": "Filter by a reference entity link (single or multiple)", "type": "text/plain" }, "key": "search", "value": "{\"designers\":{\"operator\":\"IN\",\"value\":[\"starck\",\"dixon\"]}}" }, { "disabled": true, "description": { "content": "Cursor when using the search_after pagination method type.", "type": "text/plain" }, "key": "search_after", "value": "qaXbcde" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the reference entity you want to retrieve or manipulate.\nIt is essential for identifying the specific reference entity in the API requests.\nEnsure that the reference entity code is correctly formatted and corresponds to an existing reference entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "brands", "key": "reference_entity_code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "642c37ae-dceb-4116-b049-fc8fde78a728", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/records - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/records - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"object\",\"allOf\":[{\"type\":\"object\",\"properties\":{\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the current page of resources\"}}},\"first\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the first page of resources\"}}},\"previous\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the previous page of resources\"}}},\"next\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the next page of resources\"}}}}}}},{\"type\":\"object\",\"properties\":{\"_embedded\":{\"type\":\"object\",\"properties\":{\"items\":{\"type\":\"array\",\"items\":{\"allOf\":[{\"type\":\"object\",\"required\":[\"code\"],\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Code of the record\"},\"values\":{\"type\":\"object\",\"description\":\"Record attribute values\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"data\"],\"properties\":{\"locale\":{\"description\":\"Locale code of the value\",\"type\":[\"string\",\"null\"]},\"channel\":{\"description\":\"Channel code of the value\",\"type\":[\"string\",\"null\"]},\"data\":{\"description\":\"Reference entity record value.\\nSee [the `data` format](https://api.akeneo.com/concepts/reference-entities.html#the-data-format) section for more details.\\n\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"object\"},{\"type\":\"null\"}]}}}},\"x-validation-rules\":\"Validation rules detailed in Reference entity record values section\"},\"created\":{\"type\":[\"string\",\"null\"],\"format\":\"date-time\"},\"updated\":{\"type\":[\"string\",\"null\"],\"format\":\"date-time\"}}},{\"type\":\"object\",\"properties\":{\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the resource\"}}}}}}}]}}}}}}]}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/records - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "29fea922-eadb-4afa-82a4-2be7e7c61b59", "name": "Update/create several reference entity records", "request": { "name": "Update/create several reference entity records", "description": { "content": "This endpoint allows you to update and/or create several records of a reference entity.\nLearn more about https://api.akeneo.com/documentation/update.html#update-behavior. \nIf a record with the specified code does not already exist, it will be created.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "reference-entities", ":reference_entity_code", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the reference entity you want to retrieve or manipulate.\nIt is essential for identifying the specific reference entity in the API requests.\nEnsure that the reference entity code is correctly formatted and corresponds to an existing reference entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "brands", "key": "reference_entity_code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"kartell\",\n \"values\": {\n \"label\": [\n {\n \"locale\": \"en_US\",\n \"channel\": null,\n \"data\": \"Kartell\"\n }\n ],\n \"image\": [\n {\n \"locale\": null,\n \"channel\": null,\n \"data\": \"0/c/b/0/0cb0c0e115dedba676f8d1ad8343ec207ab54c7b_image.jpg\"\n }\n ],\n \"description\": [\n {\n \"locale\": \"en_US\",\n \"channel\": null,\n \"data\": \"Kartell, the Italian furniture company that sells modern and remarkable pieces of furnitures.\"\n },\n {\n \"locale\": \"fr_FR\",\n \"channel\": null,\n \"data\": \"Kartell, l'éditeur de meuble italien spécialisé dans la signature de belle pièces au design contemporain.\"\n }\n ],\n \"country\": [\n {\n \"locale\": null,\n \"channel\": null,\n \"data\": \"italy\"\n }\n ],\n \"collection_overview\": [\n {\n \"locale\": null,\n \"channel\": null,\n \"data\": \"5/1/d/8/51d81dc778ba1501a8f998f3ab5797569f3b9e25_img.png\"\n }\n ],\n \"creation_year\": [\n {\n \"locale\": null,\n \"channel\": null,\n \"data\": \"1949\"\n }\n ]\n }\n },\n {\n \"code\": \"ligneroset\",\n \"values\": {\n \"label\": [\n {\n \"locale\": \"en_US\",\n \"channel\": null,\n \"data\": \"Ligne Roset\"\n }\n ],\n \"description\": [\n {\n \"locale\": \"en_US\",\n \"channel\": null,\n \"data\": \"Very well known French brand of modern and luxury furniture\"\n },\n {\n \"locale\": \"fr_FR\",\n \"channel\": null,\n \"data\": \"La marque renommée des meubles de luxe à la française\"\n }\n ],\n \"country\": [\n {\n \"locale\": null,\n \"channel\": null,\n \"data\": \"france\"\n }\n ],\n \"creation_year\": [\n {\n \"locale\": null,\n \"channel\": null,\n \"data\": \"1860\"\n }\n ]\n }\n },\n {\n \"code\": \"usm\",\n \"values\": {\n \"label\": [\n {\n \"locale\": \"en_US\",\n \"channel\": null,\n \"data\": \"USM\"\n }\n ],\n \"description\": [\n {\n \"locale\": \"en_US\",\n \"channel\": null,\n \"data\": \"Modular furniture from Switzerland for your home and office\"\n },\n {\n \"locale\": \"fr_FR\",\n \"channel\": null,\n \"data\": \"L'éditeur de meubles modulaires suisse pour votre intérieur et pour les entreprises\"\n }\n ],\n \"country\": [\n {\n \"locale\": null,\n \"channel\": null,\n \"data\": \"switzerland\"\n }\n ],\n \"creation_year\": [\n {\n \"locale\": null,\n \"channel\": null,\n \"data\": \"1885\"\n }\n ]\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "78f9b2a4-6a2f-4282-97bd-cedef8b4e202", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[PATCH]::/api/rest/v1/reference-entities/:reference_entity_code/records - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PATCH]::/api/rest/v1/reference-entities/:reference_entity_code/records - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\"},\"status_code\":{\"type\":\"integer\"},\"message\":{\"type\":\"string\"},\"errors\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"property\":{\"type\":\"string\"},\"message\":{\"type\":\"string\"}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/rest/v1/reference-entities/:reference_entity_code/records - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75d98a63-cb82-4886-9b09-28eca4e9c1d3", "name": "Get a record of a given reference entity", "request": { "name": "Get a record of a given reference entity", "description": { "content": "Retrieve a specific record of a reference entity", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "reference-entities", ":reference_entity_code", "records", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the reference entity you want to retrieve or manipulate.\nIt is essential for identifying the specific reference entity in the API requests.\nEnsure that the reference entity code is correctly formatted and corresponds to an existing reference entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "brands", "key": "reference_entity_code" }, { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "a4ad0c59-6b8e-4331-bac3-2c461ed501b7", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/records/:code - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/records/:code - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"object\",\"required\":[\"code\"],\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Code of the record\"},\"values\":{\"type\":\"object\",\"description\":\"Record attribute values\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"data\"],\"properties\":{\"locale\":{\"description\":\"Locale code of the value\",\"type\":[\"string\",\"null\"]},\"channel\":{\"description\":\"Channel code of the value\",\"type\":[\"string\",\"null\"]},\"data\":{\"description\":\"Reference entity record value.\\nSee [the `data` format](https://api.akeneo.com/concepts/reference-entities.html#the-data-format) section for more details.\\n\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"object\"},{\"type\":\"null\"}]}}}},\"x-validation-rules\":\"Validation rules detailed in Reference entity record values section\"},\"created\":{\"type\":[\"string\",\"null\"],\"format\":\"date-time\"},\"updated\":{\"type\":[\"string\",\"null\"],\"format\":\"date-time\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/reference-entities/:reference_entity_code/records/:code - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4cf8ebad-69fc-414d-a7e2-3daa16fe97c1", "name": "Update or create a record of a given reference entity", "request": { "name": "Update or create a record of a given reference entity", "description": { "content": "This endpoint allows you to update a given record of a given reference entity.\nLearn more about https://api.akeneo.com/documentation/update.html#patch-reference-entity-record-values.\nNote that if the record does not already exist for the given reference entity, it creates it.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "reference-entities", ":reference_entity_code", "records", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the reference entity you want to retrieve or manipulate.\nIt is essential for identifying the specific reference entity in the API requests.\nEnsure that the reference entity code is correctly formatted and corresponds to an existing reference entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "brands", "key": "reference_entity_code" }, { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"kartell\",\n \"values\": {\n \"label\": [\n {\n \"locale\": \"en_US\",\n \"channel\": null,\n \"data\": \"Kartell\"\n }\n ],\n \"image\": [\n {\n \"locale\": null,\n \"channel\": null,\n \"data\": \"0/c/b/0/0cb0c0e115dedba676f8d1ad8343ec207ab54c7b_image.jpg\"\n }\n ],\n \"description\": [\n {\n \"locale\": \"en_US\",\n \"channel\": null,\n \"data\": \"Kartell, the Italian furniture company that sells modern and remarkable pieces of furniture.\"\n },\n {\n \"locale\": \"fr_FR\",\n \"channel\": null,\n \"data\": \"Kartell, l'éditeur de meuble italien spécialisé dans la signature de belles pièces au design contemporain.\"\n }\n ],\n \"country\": [\n {\n \"locale\": null,\n \"channel\": null,\n \"data\": \"italy\"\n }\n ],\n \"collection_overview\": [\n {\n \"locale\": null,\n \"channel\": null,\n \"data\": \"5/1/d/8/51d81dc778ba1501a8f998f3ab5797569f3b9e25_img.png\"\n }\n ],\n \"creation_year\": [\n {\n \"locale\": null,\n \"channel\": null,\n \"data\": \"1949\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e4f5a65e-3ac1-4fbe-9f36-af17c4332017", "name": "Reference entity media file", "description": { "content": "A reference entity media file is a file that can be attached to a reference entity record.\nIt can be an image, a video, a PDF, or any other type of file.\nReference entity media files are used to enrich the reference entity information and provide additional context to the reference entities.\n", "type": "text/plain" }, "item": [ { "id": "095bf8fb-2eb0-48d3-9764-377300ccd72b", "name": "Create a new media file for a reference entity or a record", "request": { "name": "Create a new media file for a reference entity or a record", "description": { "content": "This endpoint allows you to create a new media file and associate it to the image of a reference entity,\nor to the main image or to an attribute value of a record\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "reference-entities-media-files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Equal to 'multipart/form-data' (with [boundary value](https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.2)), no other value allowed.\n", "type": "text/plain" }, "key": "Content-Type", "value": "multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The media file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "087eeb5a-d253-4f87-b109-5c1492ddfe95", "name": "Download the media file associated to a reference entity or a record", "request": { "name": "Download the media file associated to a reference entity or a record", "description": { "content": "This endpoint allows you to download a given media file that is associated with a reference entity or a record", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "reference-entities-media-files", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "image/png" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "0fbf527d-525a-4707-9460-18b8cbbf552a", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/reference-entities-media-files/:code - Content-Type is image/png\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"image/png\");\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "61c14138-0ca5-45d1-ad6f-21bb760369fd", "name": "Asset family", "description": { "content": "An asset family is a set of attributes that are shared by assets belonging to this family.\nIn other words, an asset family can be considered as a template for assets.\n", "type": "text/plain" }, "item": [ { "id": "f40ec33c-1fb5-48b8-aa97-703e91fa823c", "name": "Get list of asset families", "request": { "name": "Get list of asset families", "description": { "content": "This endpoint allows you to get a list of asset families.\nAsset families are paginated.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "asset-families" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Cursor when using the search_after pagination method type.", "type": "text/plain" }, "key": "search_after", "value": "qaXbcde" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "2666d993-0e88-4301-b7fa-e3d9a501ec38", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/asset-families - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/asset-families - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"title\":\"Asset families\",\"type\":\"object\",\"allOf\":[{\"type\":\"object\",\"properties\":{\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the current page of resources\"}}},\"first\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the first page of resources\"}}},\"previous\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the previous page of resources\"}}},\"next\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the next page of resources\"}}}}}}},{\"type\":\"object\",\"properties\":{\"_embedded\":{\"type\":\"object\",\"properties\":{\"items\":{\"type\":\"array\",\"items\":{\"allOf\":[{\"type\":\"object\",\"properties\":{\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"URI of the resource\"}}}}}}},{\"type\":\"object\",\"required\":[\"code\"],\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Asset family code\",\"x-immutable\":true},\"labels\":{\"type\":\"object\",\"description\":\"Asset family labels for each locale.\\nThe `localeCode` must be the code of an existing and activated locale.\\n\",\"default\":{},\"patternProperties\":{\"^[a-zA-Z]{2,}_[a-zA-Z0-9_]{2,}$\":{\"description\":\"Asset family label for the specified locale\",\"type\":[\"string\",\"null\"]}},\"x-validation-rules\":\"The `localeCode` is the code of an existing and activated locale\"},\"attribute_as_main_media\":{\"type\":[\"string\",\"null\"],\"description\":\"Attribute code that is used as the main media of the asset family\",\"default\":\"First media file or media link attribute that was created\",\"x-validation-rules\":\"It should be the code of an attribute that belongs to this family, and it must be a media file or a media link attribute type\"},\"naming_convention\":{\"type\":\"object\",\"description\":\"The naming convention run over the asset code or the main media filename upon each asset creation, in order to automatically set several values in asset attributes.\\nTo learn more and see the format of this property, take a look at [here](https://api.akeneo.com/concepts/asset-manager.html#focus-on-the-naming-convention).\\n\",\"default\":{},\"properties\":{\"source\":{\"type\":\"object\",\"description\":\"The string on which the naming convention should be applied.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#the-source-string).\\n\"},\"pattern\":{\"type\":\"string\",\"description\":\"The regular expression that should be applied on the source.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#the-split-pattern).\\n\"},\"abort_asset_creation_on_error\":{\"type\":\"boolean\",\"description\":\"Whether the asset should be created if the naming convention failed to apply.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#abortion-on-error).\\n\"}},\"x-validation-rules\":\"To know more about the validation of this property, take a look at our naming convention format\"},\"product_link_rules\":{\"type\":\"array\",\"description\":\"The rules that will be run after the asset creation, in order to automatically link the assets of this family to a set of products.\\nTo understand the format of this property, see [here](https://api.akeneo.com/concepts/asset-manager.html#focus-on-the-product-link-rule).\\n\",\"default\":[],\"items\":{\"type\":\"object\",\"properties\":{\"product_selections\":{\"type\":\"array\",\"description\":\"The product selection to which the assets of the asset family to be automatically linked.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#product-selection).\\n\",\"items\":{\"type\":\"object\",\"required\":[\"field\",\"operator\",\"value\"],\"properties\":{\"field\":{\"type\":\"string\"},\"operator\":{\"type\":\"string\"},\"value\":{\"type\":[\"string\",\"array\",\"boolean\"]},\"locale\":{\"type\":[\"string\",\"null\"],\"description\":\"The locale code. Can be null if not applicable\"},\"channel\":{\"type\":[\"string\",\"null\"],\"description\":\"The channel code. Can be null if not applicable\"}}}},\"assign_assets_to\":{\"type\":\"array\",\"description\":\"The product value in which your assets will be assigned.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#product-value-assignment).\\n\",\"items\":{\"type\":\"object\",\"required\":[\"attribute\",\"mode\"],\"properties\":{\"attribute\":{\"type\":\"string\"},\"locale\":{\"type\":[\"string\",\"null\"],\"description\":\"The locale code. Can be null if not applicable\"},\"channel\":{\"type\":[\"string\",\"null\"],\"description\":\"The channel code. Can be null if not applicable\"},\"mode\":{\"type\":\"string\"}}}}}},\"x-validation-rules\":\"To know more about the validation of this property, take a look at our product link rule format\"},\"transformations\":{\"type\":\"array\",\"description\":\"The transformations to perform on source files in order to generate new files into your asset attributes.\\nTo understand the format of this property, see [here](https://api.akeneo.com/concepts/asset-manager.html#focus-on-the-transformations).\\n\",\"default\":[],\"items\":{\"type\":\"object\",\"required\":[\"label\",\"target\",\"source\",\"operations\"],\"properties\":{\"label\":{\"type\":\"string\",\"description\":\"The name of the transformation\"},\"filename_suffix\":{\"type\":\"string\",\"description\":\"The suffix that will be appended to the source filename to generate the target filename.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#target-filename).\\n\"},\"filename_prefix\":{\"type\":\"string\",\"description\":\"The prefix that will be prepended to the source filename to generate the target filename.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#target-filename).\\n\"},\"source\":{\"type\":\"object\",\"required\":[\"attribute\",\"channel\",\"locale\"],\"description\":\"The attribute value in which is stored the media file you want to use as the source file for your transformation.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#source-file).\\n\",\"properties\":{\"attribute\":{\"type\":\"string\"},\"locale\":{\"type\":[\"string\",\"null\"],\"description\":\"The locale code. Can be null if not applicable\"},\"channel\":{\"type\":[\"string\",\"null\"],\"description\":\"The channel code. Can be null if not applicable\"}}},\"target\":{\"type\":\"object\",\"required\":[\"attribute\",\"channel\",\"locale\"],\"description\":\"The attribute value in which the PIM will generate the new transformed file, aka the target file.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#target-file).\\n\",\"properties\":{\"attribute\":{\"type\":\"string\"},\"locale\":{\"type\":[\"string\",\"null\"],\"description\":\"The locale code. Can be null if not applicable\"},\"channel\":{\"type\":[\"string\",\"null\"],\"description\":\"The channel code. Can be null if not applicable\"}}},\"operations\":{\"type\":\"array\",\"description\":\"The transformations that should be applied to your source file to generate the target file.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#transformation-operations).\\n\",\"items\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\"},\"parameters\":{\"type\":\"object\",\"properties\":{\"colorspace\":{\"type\":\"string\"},\"width\":{\"type\":\"integer\"},\"height\":{\"type\":\"integer\"},\"ratio\":{\"type\":\"integer\"},\"resolution-unit\":{\"type\":\"string\"},\"resolution-x\":{\"type\":\"integer\"},\"resolution-y\":{\"type\":\"integer\"},\"quality\":{\"type\":\"integer\"}}}}},\"x-validation-rules\":\"Should contain at least one operation\"}}},\"x-validation-rules\":\"To know more about the validation of this property, take a look at our transformation format\"},\"sharing_enabled\":{\"type\":\"boolean\",\"description\":\"Share links are available/unavailable for media file attributes of all the assets in this family\"},\"auto_tagging_enabled\":{\"type\":\"boolean\",\"description\":\"Auto-tagging is enabled/disabled for all the assets in this family\"}}}]}}}}}}]}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/asset-families - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e804fee-3476-480d-9640-e0ce9ce8ebaf", "name": "Get an asset family", "request": { "name": "Get an asset family", "description": { "content": "This endpoint allows you to get the information about a given asset family", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "asset-families", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "id": "107b7511-6ea4-4992-b3ae-4802632e20af", "type": "text/javascript", "exec": [ "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rest/v1/asset-families/:code - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rest/v1/asset-families/:code - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", "// Response Validation\nconst schema = {\"type\":\"object\",\"required\":[\"code\"],\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Asset family code\",\"x-immutable\":true},\"labels\":{\"type\":\"object\",\"description\":\"Asset family labels for each locale.\\nThe `localeCode` must be the code of an existing and activated locale.\\n\",\"default\":{},\"patternProperties\":{\"^[a-zA-Z]{2,}_[a-zA-Z0-9_]{2,}$\":{\"description\":\"Asset family label for the specified locale\",\"type\":[\"string\",\"null\"]}},\"x-validation-rules\":\"The `localeCode` is the code of an existing and activated locale\"},\"attribute_as_main_media\":{\"type\":[\"string\",\"null\"],\"description\":\"Attribute code that is used as the main media of the asset family\",\"default\":\"First media file or media link attribute that was created\",\"x-validation-rules\":\"It should be the code of an attribute that belongs to this family, and it must be a media file or a media link attribute type\"},\"naming_convention\":{\"type\":\"object\",\"description\":\"The naming convention run over the asset code or the main media filename upon each asset creation, in order to automatically set several values in asset attributes.\\nTo learn more and see the format of this property, take a look at [here](https://api.akeneo.com/concepts/asset-manager.html#focus-on-the-naming-convention).\\n\",\"default\":{},\"properties\":{\"source\":{\"type\":\"object\",\"description\":\"The string on which the naming convention should be applied.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#the-source-string).\\n\"},\"pattern\":{\"type\":\"string\",\"description\":\"The regular expression that should be applied on the source.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#the-split-pattern).\\n\"},\"abort_asset_creation_on_error\":{\"type\":\"boolean\",\"description\":\"Whether the asset should be created if the naming convention failed to apply.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#abortion-on-error).\\n\"}},\"x-validation-rules\":\"To know more about the validation of this property, take a look at our naming convention format\"},\"product_link_rules\":{\"type\":\"array\",\"description\":\"The rules that will be run after the asset creation, in order to automatically link the assets of this family to a set of products.\\nTo understand the format of this property, see [here](https://api.akeneo.com/concepts/asset-manager.html#focus-on-the-product-link-rule).\\n\",\"default\":[],\"items\":{\"type\":\"object\",\"properties\":{\"product_selections\":{\"type\":\"array\",\"description\":\"The product selection to which the assets of the asset family to be automatically linked.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#product-selection).\\n\",\"items\":{\"type\":\"object\",\"required\":[\"field\",\"operator\",\"value\"],\"properties\":{\"field\":{\"type\":\"string\"},\"operator\":{\"type\":\"string\"},\"value\":{\"type\":[\"string\",\"array\",\"boolean\"]},\"locale\":{\"type\":[\"string\",\"null\"],\"description\":\"The locale code. Can be null if not applicable\"},\"channel\":{\"type\":[\"string\",\"null\"],\"description\":\"The channel code. Can be null if not applicable\"}}}},\"assign_assets_to\":{\"type\":\"array\",\"description\":\"The product value in which your assets will be assigned.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#product-value-assignment).\\n\",\"items\":{\"type\":\"object\",\"required\":[\"attribute\",\"mode\"],\"properties\":{\"attribute\":{\"type\":\"string\"},\"locale\":{\"type\":[\"string\",\"null\"],\"description\":\"The locale code. Can be null if not applicable\"},\"channel\":{\"type\":[\"string\",\"null\"],\"description\":\"The channel code. Can be null if not applicable\"},\"mode\":{\"type\":\"string\"}}}}}},\"x-validation-rules\":\"To know more about the validation of this property, take a look at our product link rule format\"},\"transformations\":{\"type\":\"array\",\"description\":\"The transformations to perform on source files in order to generate new files into your asset attributes.\\nTo understand the format of this property, see [here](https://api.akeneo.com/concepts/asset-manager.html#focus-on-the-transformations).\\n\",\"default\":[],\"items\":{\"type\":\"object\",\"required\":[\"label\",\"target\",\"source\",\"operations\"],\"properties\":{\"label\":{\"type\":\"string\",\"description\":\"The name of the transformation\"},\"filename_suffix\":{\"type\":\"string\",\"description\":\"The suffix that will be appended to the source filename to generate the target filename.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#target-filename).\\n\"},\"filename_prefix\":{\"type\":\"string\",\"description\":\"The prefix that will be prepended to the source filename to generate the target filename.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#target-filename).\\n\"},\"source\":{\"type\":\"object\",\"required\":[\"attribute\",\"channel\",\"locale\"],\"description\":\"The attribute value in which is stored the media file you want to use as the source file for your transformation.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#source-file).\\n\",\"properties\":{\"attribute\":{\"type\":\"string\"},\"locale\":{\"type\":[\"string\",\"null\"],\"description\":\"The locale code. Can be null if not applicable\"},\"channel\":{\"type\":[\"string\",\"null\"],\"description\":\"The channel code. Can be null if not applicable\"}}},\"target\":{\"type\":\"object\",\"required\":[\"attribute\",\"channel\",\"locale\"],\"description\":\"The attribute value in which the PIM will generate the new transformed file, aka the target file.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#target-file).\\n\",\"properties\":{\"attribute\":{\"type\":\"string\"},\"locale\":{\"type\":[\"string\",\"null\"],\"description\":\"The locale code. Can be null if not applicable\"},\"channel\":{\"type\":[\"string\",\"null\"],\"description\":\"The channel code. Can be null if not applicable\"}}},\"operations\":{\"type\":\"array\",\"description\":\"The transformations that should be applied to your source file to generate the target file.\\nMore details [here](https://api.akeneo.com/concepts/asset-manager.html#transformation-operations).\\n\",\"items\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\"},\"parameters\":{\"type\":\"object\",\"properties\":{\"colorspace\":{\"type\":\"string\"},\"width\":{\"type\":\"integer\"},\"height\":{\"type\":\"integer\"},\"ratio\":{\"type\":\"integer\"},\"resolution-unit\":{\"type\":\"string\"},\"resolution-x\":{\"type\":\"integer\"},\"resolution-y\":{\"type\":\"integer\"},\"quality\":{\"type\":\"integer\"}}}}},\"x-validation-rules\":\"Should contain at least one operation\"}}},\"x-validation-rules\":\"To know more about the validation of this property, take a look at our transformation format\"},\"sharing_enabled\":{\"type\":\"boolean\",\"description\":\"Share links are available/unavailable for media file attributes of all the assets in this family\"},\"auto_tagging_enabled\":{\"type\":\"boolean\",\"description\":\"Auto-tagging is enabled/disabled for all the assets in this family\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rest/v1/asset-families/:code - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2b5292f-db9b-4129-a58c-b77af3f76548", "name": "Update/create an asset family", "request": { "name": "Update/create an asset family", "description": { "content": "This endpoint allows you to update a given asset family.\nNote that if the asset family does not already exist, it creates it.\n", "type": "text/plain" }, "url": { "path": [ "api", "rest", "v1", "asset-families", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate.\nIt is essential for identifying the specific entity in the API requests.\nEnsure that the code is correctly formatted and corresponds to an existing entity in the system.\n", "type": "text/plain" }, "type": "any", "value": "my_entity_code", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"model_pictures\",\n \"labels\": {\n \"en_US\": \"Model pictures\",\n \"fr_FR\": \"Photographies en pied\"\n },\n \"attribute_as_main_media\": \"main_image\",\n \"naming_convention\": {\n \"source\": {\n \"property\": \"code\"\n },\n \"pattern\": \"/(?P