kinlane
8/17/2018 - 1:25 AM
Akeneo-PIM-OpenAPI
Akeneo-PIM-OpenAPI
{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "Official Akeneo PIM API",
"description": "The Akeneo API brought to you!\n\nFind out how this Postman collection works by visiting http://api.akeneo.com"
},
"host": "example.com",
"basePath": "/api",
"securityDefinitions": {
"auth": {
"type": "oauth2",
"flow": "implicit",
"authorizationUrl": "http://example.com/api",
"scopes": {},
"x-skip-client-authentication": false
}
},
"schemes": [
"http"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/rest/v1/assets/paint": {
"get": {
"description": "Assuming that the given code is the code of an existing asset",
"summary": "asset (2.1 only)",
"tags": [
"Asset (since 2.1)"
],
"operationId": "RestV1AssetsPaintGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/assets/paint"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "asset (2.1 only)",
"x-testDescription": "Assuming that the given code is the code of an existing asset"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "",
"summary": "asset (2.1 only)",
"tags": [
"Asset (since 2.1)"
],
"operationId": "RestV1AssetsPaintPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Asset(2.1Only)request"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/assets/paint",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"paint\",\"localizable\":false,\"description\":\"Photo of a paint.\",\"end_of_use\":\"2006-05-11T22:00:00+00:00\",\"tags\":[],\"categories\":[\"images\"]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "asset (2.1 only)2",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/assets": {
"get": {
"description": "",
"summary": "assets (2.1 only)",
"tags": [
"Asset (since 2.1)"
],
"operationId": "RestV1AssetsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "limit",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "with_count",
"in": "query",
"required": true,
"type": "boolean",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/assets?limit=10&with_count=false"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "assets (2.1 only)",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Assuming that there is no \"new_asset\" already existing",
"summary": "asset (2.1 only)",
"tags": [
"Asset (since 2.1)"
],
"operationId": "RestV1AssetsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Asset(2.1Only)request"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/rest/v1/assets",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"new_asset\",\"localizable\":false,\"description\":\"An amazing asset\",\"end_of_use\":\"2018-05-11T22:00:00+00:00\",\"tags\":[\"colored\"],\"categories\":[\"images\"]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "asset (2.1 only)1",
"x-testDescription": "Assuming that there is no \"new_asset\" already existing"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "\n",
"summary": "assets (2.1 only)",
"tags": [
"Asset (since 2.1)"
],
"operationId": "RestV1AssetsPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/assets",
"headers": {
"Content-Type": "application/vnd.akeneo.collection+json"
},
"body": "{\"code\": \"new_asset\", \"categories\": [\"images\"]}\n{\"code\": \"new_asset_2\"}\n{\"code\": \"paint\", \"description\": \"Update the description here\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "assets (2.1 only)1",
"x-testDescription": "\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/assets/paint/reference-files/no-locale": {
"get": {
"description": "Assuming that the given codes are respectively the code of an existing asset and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)",
"summary": "asset reference file (2.1 only)",
"tags": [
"Asset (since 2.1)"
],
"operationId": "RestV1AssetsPaintReferenceFilesNoLocaleGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/assets/paint/reference-files/no-locale"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "asset reference file (2.1 only)",
"x-testDescription": "Assuming that the given codes are respectively the code of an existing asset and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Assuming that the given codes are respectively the code of an existing asset and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)",
"summary": "asset reference file (2.1 only)",
"tags": [
"Asset (since 2.1)"
],
"operationId": "RestV1AssetsPaintReferenceFilesNoLocalePost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "file",
"in": "formData",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/rest/v1/assets/paint/reference-files/no-locale",
"headers": {
"Content-Type": "multipart/form-data"
},
"body": "file="
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "asset reference file (2.1 only)1",
"x-testDescription": "Assuming that the given codes are respectively the code of an existing asset and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/assets/paint/reference-files/no-locale/download": {
"get": {
"description": "Assuming that the given codes are respectively the code of an existing asset and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)",
"summary": "download asset reference file (2.1 only)",
"tags": [
"Asset (since 2.1)"
],
"operationId": "RestV1AssetsPaintReferenceFilesNoLocaleDownloadGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/assets/paint/reference-files/no-locale/download"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "download asset reference file (2.1 only)",
"x-testDescription": "Assuming that the given codes are respectively the code of an existing asset and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/assets/paint/variation-files/ecommerce/no-locale": {
"get": {
"description": "Assuming that the given codes are respectively the code of an existing asset, an existing channel and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)",
"summary": "asset variation file (2.1 only)",
"tags": [
"Asset (since 2.1)"
],
"operationId": "RestV1AssetsPaintVariationFilesEcommerceNoLocaleGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/assets/paint/variation-files/ecommerce/no-locale"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "asset variation file (2.1 only)",
"x-testDescription": "Assuming that the given codes are respectively the code of an existing asset, an existing channel and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Assuming that the given codes are respectively the code of an existing asset, an existing channel and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)",
"summary": "asset variation file (2.1 only)",
"tags": [
"Asset (since 2.1)"
],
"operationId": "RestV1AssetsPaintVariationFilesEcommerceNoLocalePost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "file",
"in": "formData",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/rest/v1/assets/paint/variation-files/ecommerce/no-locale",
"headers": {
"Content-Type": "multipart/form-data"
},
"body": "file="
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "asset variation file (2.1 only)1",
"x-testDescription": "Assuming that the given codes are respectively the code of an existing asset, an existing channel and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/assets/paint/variation-files/ecommerce/no-locale/download": {
"get": {
"description": "Assuming that the given codes are respectively the code of an existing asset, an existing channel and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)",
"summary": "download asset variation file (2.1 only)",
"tags": [
"Asset (since 2.1)"
],
"operationId": "RestV1AssetsPaintVariationFilesEcommerceNoLocaleDownloadGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/assets/paint/variation-files/ecommerce/no-locale/download"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "download asset variation file (2.1 only)",
"x-testDescription": "Assuming that the given codes are respectively the code of an existing asset, an existing channel and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/asset-categories/asset_main_catalog": {
"get": {
"description": "Assuming that the given code is the code of an existing asset category",
"summary": "asset category (2.1 only)",
"tags": [
"Asset category (since 2.1)"
],
"operationId": "RestV1AssetCategoriesAssetMainCatalogGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/asset-categories/asset_main_catalog"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "asset category (2.1 only)",
"x-testDescription": "Assuming that the given code is the code of an existing asset category"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/asset-categories": {
"get": {
"description": "",
"summary": "asset categories (2.1 only)",
"tags": [
"Asset category (since 2.1)"
],
"operationId": "RestV1AssetCategoriesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "limit",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "with_count",
"in": "query",
"required": true,
"type": "boolean",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/asset-categories?limit=10&with_count=false"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "asset categories (2.1 only)",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Assuming that there is no \"new_asset_category\" already existing",
"summary": "asset category (2.1 only)",
"tags": [
"Asset category (since 2.1)"
],
"operationId": "RestV1AssetCategoriesPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AssetCategory(2.1Only)request"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/rest/v1/asset-categories",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"new_asset_category\",\"parent\":\"asset_main_catalog\",\"labels\":{\"de_DE\":\"new asset category label DE\",\"en_US\":\"new asset category label US\",\"fr_FR\":\"new asset category label FR\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "asset category (2.1 only)1",
"x-testDescription": "Assuming that there is no \"new_asset_category\" already existing"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "\n",
"summary": "asset categories (2.1 only)",
"tags": [
"Asset category (since 2.1)"
],
"operationId": "RestV1AssetCategoriesPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/asset-categories",
"headers": {
"Content-Type": "application/vnd.akeneo.collection+json"
},
"body": "{\"code\": \"new_asset_category\", \"parent\": \"asset_main_catalog\"}\n{\"code\": \"new_asset_category_tree\"}\n{\"code\": \"images\", \"labels\":{\"fr_FR\":\"Images\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "asset categories (2.1 only)1",
"x-testDescription": "\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/asset-categories/new_asset_category": {
"patch": {
"description": "",
"summary": "asset category (2.1 only)",
"tags": [
"Asset category (since 2.1)"
],
"operationId": "RestV1AssetCategoriesNewAssetCategoryPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AssetCategory(2.1Only)request"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/asset-categories/new_asset_category",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"new_asset_category\",\"parent\":\"asset_main_catalog\",\"labels\":{\"de_DE\":\"new asset category label DE\",\"en_US\":\"new asset category label US\",\"fr_FR\":\"new asset category label FR\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "asset category (2.1 only)2",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/asset-tags/colored": {
"get": {
"description": "Assuming that the given code is the code of an existing asset tag",
"summary": "asset tag (2.1 only)",
"tags": [
"Asset tag (since 2.1)"
],
"operationId": "RestV1AssetTagsColoredGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/asset-tags/colored"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "asset tag (2.1 only)",
"x-testDescription": "Assuming that the given code is the code of an existing asset tag"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "",
"summary": "asset tag (2.1 only)",
"tags": [
"Asset tag (since 2.1)"
],
"operationId": "RestV1AssetTagsColoredPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AssetTag(2.1Only)request"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/asset-tags/colored",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"colored\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "asset tag (2.1 only)1",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/asset-tags": {
"get": {
"description": "",
"summary": "asset tags (2.1 only)",
"tags": [
"Asset tag (since 2.1)"
],
"operationId": "RestV1AssetTagsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "limit",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "with_count",
"in": "query",
"required": true,
"type": "boolean",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/asset-tags?limit=10&with_count=false"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "asset tags (2.1 only)",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/association-types/upsell": {
"get": {
"description": "Assuming that the given code is the code of an existing association type",
"summary": "association type (2.x only)",
"tags": [
"Association type (2.x only)"
],
"operationId": "RestV1AssociationTypesUpsellGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/association-types/upsell"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "association type (2.x only)",
"x-testDescription": "Assuming that the given code is the code of an existing association type"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "",
"summary": "association type (2.x only)",
"tags": [
"Association type (2.x only)"
],
"operationId": "RestV1AssociationTypesUpsellPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AssociationType(2.xOnly)request9"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/association-types/upsell",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"UPSELL\",\"labels\":{\"en_US\":\"Upsell\",\"fr_FR\":\"Vente incitative\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "association type (2.x only)2",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/association-types": {
"get": {
"description": "",
"summary": "association types (2.x only)",
"tags": [
"Association type (2.x only)"
],
"operationId": "RestV1AssociationTypesGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/association-types"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "association types (2.x only)",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Assuming that there is no \"new_association_type\" already existing",
"summary": "association type (2.x only)",
"tags": [
"Association type (2.x only)"
],
"operationId": "RestV1AssociationTypesPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AssociationType(2.xOnly)request"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/rest/v1/association-types",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"new_association_type\",\"labels\":{\"de_DE\":\"new association type label DE\",\"en_US\":\"new association type label US\",\"fr_FR\":\"new association type label FR\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "association type (2.x only)1",
"x-testDescription": "Assuming that there is no \"new_association_type\" already existing"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "\n",
"summary": "association types (2.x only)",
"tags": [
"Association type (2.x only)"
],
"operationId": "RestV1AssociationTypesPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/association-types",
"headers": {
"Content-Type": "application/vnd.akeneo.collection+json"
},
"body": "{\"code\": \"new_association_type\"}\n{\"code\": \"upsell\", \"labels\":{\"en_US\":\"new association type US label\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "association types (2.x only)1",
"x-testDescription": "\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/attributes/auto_exposure": {
"get": {
"description": "Assuming that the given code is the code of an existing attribute",
"summary": "attribute",
"tags": [
"Attribute"
],
"operationId": "RestV1AttributesAutoExposureGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/attributes/auto_exposure"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "attribute",
"x-testDescription": "Assuming that the given code is the code of an existing attribute"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "",
"summary": "attribute",
"tags": [
"Attribute"
],
"operationId": "RestV1AttributesAutoExposurePatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AttributeRequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/attributes/auto_exposure",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"auto_exposure\",\"type\":\"pim_catalog_boolean\",\"group\":\"technical\",\"unique\":false,\"useable_as_grid_filter\":true,\"allowed_extensions\":[],\"metric_family\":null,\"default_metric_unit\":null,\"reference_data_name\":null,\"available_locales\":[],\"max_characters\":null,\"validation_rule\":null,\"validation_regexp\":null,\"wysiwyg_enabled\":null,\"number_min\":null,\"number_max\":null,\"decimals_allowed\":null,\"negative_allowed\":null,\"date_min\":null,\"date_max\":null,\"max_file_size\":null,\"minimum_input_length\":null,\"sort_order\":39,\"localizable\":false,\"scopable\":false,\"labels\":{\"de_DE\":\"Auto exposure\",\"en_US\":\"Auto exposure\",\"fr_FR\":\"Auto exposure\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "attribute2",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/attributes": {
"get": {
"description": "",
"summary": "attributes",
"tags": [
"Attribute"
],
"operationId": "RestV1AttributesGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/attributes"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "attributes",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Assuming that there is no \"new_attribute\" already existing",
"summary": "attribute",
"tags": [
"Attribute"
],
"operationId": "RestV1AttributesPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AttributeRequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/rest/v1/attributes",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"new_attribute\",\"type\":\"pim_catalog_boolean\",\"group\":\"technical\",\"unique\":false,\"useable_as_grid_filter\":true,\"allowed_extensions\":[],\"metric_family\":null,\"default_metric_unit\":null,\"reference_data_name\":null,\"available_locales\":[],\"max_characters\":null,\"validation_rule\":null,\"validation_regexp\":null,\"wysiwyg_enabled\":null,\"number_min\":null,\"number_max\":null,\"decimals_allowed\":null,\"negative_allowed\":null,\"date_min\":null,\"date_max\":null,\"max_file_size\":null,\"minimum_input_length\":null,\"sort_order\":39,\"localizable\":false,\"scopable\":false,\"labels\":{\"de_DE\":\"new attribute label DE\",\"en_US\":\"new attribute label US\",\"fr_FR\":\"new attribute label FR\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "attribute1",
"x-testDescription": "Assuming that there is no \"new_attribute\" already existing"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "\n",
"summary": "attributes",
"tags": [
"Attribute"
],
"operationId": "RestV1AttributesPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/attributes",
"headers": {
"Content-Type": "application/vnd.akeneo.collection+json"
},
"body": "{\"code\": \"new_attribute\", \"type\":\"pim_catalog_boolean\", \"group\":\"other\"}\n{\"code\": \"auto_exposure\", \"labels\":{\"en_US\":\"Auto exposure\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "attributes1",
"x-testDescription": "\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/attributes/main_color/options/white": {
"get": {
"description": "Assuming that the given codes are respectively the code of an existing attribute and an existing option of this attribute",
"summary": "attribute option",
"tags": [
"Attribute option"
],
"operationId": "RestV1AttributesMainColorOptionsWhiteGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/attributes/main_color/options/white"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "attribute option",
"x-testDescription": "Assuming that the given codes are respectively the code of an existing attribute and an existing option of this attribute"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "Assuming that the given code is the code of an existing attribute",
"summary": "attribute option",
"tags": [
"Attribute option"
],
"operationId": "RestV1AttributesMainColorOptionsWhitePatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AttributeOptionrequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/attributes/main_color/options/white",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"white\",\"attribute\":\"main_color\",\"sort_order\":1,\"labels\":{\"de_DE\":\"Weiß\",\"en_US\":\"White\",\"fr_FR\":\"Blanc\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "attribute option2",
"x-testDescription": "Assuming that the given code is the code of an existing attribute"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/attributes/main_color/options": {
"get": {
"description": "",
"summary": "attribute options",
"tags": [
"Attribute option"
],
"operationId": "RestV1AttributesMainColorOptionsGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/attributes/main_color/options"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "attribute options",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Assuming that there is no \"yellow\" option already existing for the given attribute",
"summary": "attribute option",
"tags": [
"Attribute option"
],
"operationId": "RestV1AttributesMainColorOptionsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AttributeOptionrequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/rest/v1/attributes/main_color/options",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"yellow\",\"attribute\":\"main_color\",\"sort_order\":10,\"labels\":{\"de_DE\":\"Gelb\",\"en_US\":\"Yellow\",\"fr_FR\":\"Jaune\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "attribute option1",
"x-testDescription": "Assuming that there is no \"yellow\" option already existing for the given attribute"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "Assuming that the given code is the code of an existing attribute",
"summary": "attribute options (2.1 only)",
"tags": [
"Attribute option"
],
"operationId": "RestV1AttributesMainColorOptionsPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/attributes/main_color/options",
"headers": {
"Content-Type": "application/vnd.akeneo.collection+json"
},
"body": "{\"code\": \"new_attribute_option\", \"attribute\":\"main_color\", \"labels\": { \"de_DE\": \"new attribute option label DE\"}}\n{\"code\": \"red\", \"labels\": { \"fr_FR\": \"Rouge\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "attribute options (2.1 only)",
"x-testDescription": "Assuming that the given code is the code of an existing attribute"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/attribute-groups/technical": {
"get": {
"description": "Assuming that the given code is the code of an existing attribute group",
"summary": "attribute group (2.x only)",
"tags": [
"Attribute groups (2.x only)"
],
"operationId": "RestV1AttributeGroupsTechnicalGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/attribute-groups/technical"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "attribute group (2.x only)",
"x-testDescription": "Assuming that the given code is the code of an existing attribute group"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "",
"summary": "attribute group (2.x only)",
"tags": [
"Attribute groups (2.x only)"
],
"operationId": "RestV1AttributeGroupsTechnicalPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AttributeGroup(2.xOnly)request"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/attribute-groups/technical",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"technical\",\"sort_order\":2,\"attributes\":[\"weight\",\"maximum_scan_size\",\"color_scanning\",\"power_requirements\",\"maximum_print_size\",\"sensor_type\",\"total_megapixels\",\"optical_zoom\",\"image_stabilizer\",\"camera_type\",\"thd\",\"snr\",\"headphone_connectivity\",\"maximum_video_resolution\",\"maximum_frame_rate\",\"multifunctional_functions\",\"display_srgb\",\"display_color\",\"display_diagonal\",\"viewing_area\",\"camera_brand\",\"camera_model_name\",\"short_description\",\"max_image_resolution\",\"image_resolutions\",\"supported_aspect_ratios\",\"supported_image_format\",\"lens_mount_interface\",\"focus\",\"focus_adjustement\",\"auto_focus_modes\",\"auto_focus_points\",\"auto_focus_lock\",\"auto_focus_assist_beam\",\"iso_sensitivity\",\"light_exposure_modes\",\"light_exposure_corrections\",\"light_metering\",\"auto_exposure\",\"iso_sensitivity_max\",\"iso_sensitivity_min\"],\"labels\":{\"en_US\":\"Technical\",\"fr_FR\":\"Technique\",\"de_DE\":\"Technische\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "attribute group (2.x only)2",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/attribute-groups": {
"get": {
"description": "",
"summary": "attribute groups (2.x only)",
"tags": [
"Attribute groups (2.x only)"
],
"operationId": "RestV1AttributeGroupsGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/attribute-groups"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "attribute groups (2.x only)",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Assuming that there is no \"new_attribute_group\" already existing",
"summary": "attribute group (2.x only)",
"tags": [
"Attribute groups (2.x only)"
],
"operationId": "RestV1AttributeGroupsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AttributeGroup(2.xOnly)request"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/rest/v1/attribute-groups",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"new_attribute_group\",\"sort_order\":10,\"attributes\":[\"main_color\",\"secondary_color\"],\"labels\":{\"de_DE\":\"new attribute group label DE\",\"en_US\":\"new attribute group label US\",\"fr_FR\":\"new attribute group label FR\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "attribute group (2.x only)1",
"x-testDescription": "Assuming that there is no \"new_attribute_group\" already existing"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "\n",
"summary": "attribute groups (2.x only)",
"tags": [
"Attribute groups (2.x only)"
],
"operationId": "RestV1AttributeGroupsPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/attribute-groups",
"headers": {
"Content-Type": "application/vnd.akeneo.collection+json"
},
"body": "{\"code\": \"new_attribute_group\"}\n{\"code\": \"technical\", \"labels\":{\"en_US\":\"new attribute group US label\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "attribute groups (2.x only)1",
"x-testDescription": "\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/categories/master": {
"get": {
"description": "Assuming that the given code is the code of an existing category",
"summary": "category",
"tags": [
"Category"
],
"operationId": "RestV1CategoriesMasterGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/categories/master"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "category",
"x-testDescription": "Assuming that the given code is the code of an existing category"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/categories": {
"get": {
"description": "",
"summary": "categories",
"tags": [
"Category"
],
"operationId": "RestV1CategoriesGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/categories"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "categories",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Assuming that there is no \"new_category\" already existing",
"summary": "category",
"tags": [
"Category"
],
"operationId": "RestV1CategoriesPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CategoryRequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/rest/v1/categories",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"new_category\",\"parent\":\"master\",\"labels\":{\"de_DE\":\"new category label DE\",\"en_US\":\"new category label US\",\"fr_FR\":\"new category label FR\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "category1",
"x-testDescription": "Assuming that there is no \"new_category\" already existing"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "\n",
"summary": "categories",
"tags": [
"Category"
],
"operationId": "RestV1CategoriesPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/categories",
"headers": {
"Content-Type": "application/vnd.akeneo.collection+json"
},
"body": "{\"code\": \"new_category\", \"parent\": \"master\"}\n{\"code\": \"new_category_tree\"}\n{\"code\": \"master\", \"labels\":{\"en_US\":\"Main catalog\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "categories1",
"x-testDescription": "\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/categories/audio_video": {
"patch": {
"description": "",
"summary": "category",
"tags": [
"Category"
],
"operationId": "RestV1CategoriesAudioVideoPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CategoryRequest25"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/categories/audio_video",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"audio_video\",\"parent\":\"master\",\"labels\":{\"en_US\":\"new Audio and Video label\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "category2",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/channels/ecommerce": {
"get": {
"description": "Assuming that the given code is the code of an existing channel",
"summary": "channel",
"tags": [
"Channel"
],
"operationId": "RestV1ChannelsEcommerceGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/channels/ecommerce"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "channel",
"x-testDescription": "Assuming that the given code is the code of an existing channel"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/channels": {
"get": {
"description": "",
"summary": "channels",
"tags": [
"Channel"
],
"operationId": "RestV1ChannelsGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/channels"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "channels",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Assuming that there is no \"new_channel\" already existing",
"summary": "channel (2.x only)",
"tags": [
"Channel"
],
"operationId": "RestV1ChannelsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Channel(2.xOnly)request"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/rest/v1/channels",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"new_channel\",\"currencies\":[\"USD\",\"EUR\"],\"locales\":[\"de_DE\",\"en_US\",\"fr_FR\"],\"category_tree\":\"master\",\"conversion_units\":{\"weight\":\"GRAM\"},\"labels\":{\"en_US\":\"new category label US\",\"de_DE\":\"new category label DE\",\"fr_FR\":\"new category label FR\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "channel (2.x only)",
"x-testDescription": "Assuming that there is no \"new_channel\" already existing"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "\n",
"summary": "channels (2.x only)",
"tags": [
"Channel"
],
"operationId": "RestV1ChannelsPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/channels",
"headers": {
"Content-Type": "application/vnd.akeneo.collection+json"
},
"body": "{\"code\": \"new_channel\",\"category_tree\":\"master\",\"locales\":[\"de_DE\"], \"currencies\":[\"EUR\",\"USD\"], \"labels\":{\"fr_FR\": \"Mon canal\"}, \"conversion_units\":{\"weight\":\"GRAM\"}}\n{\"code\": \"new_channel_2\",\"category_tree\":\"master\",\"locales\":[\"de_DE\", \"en_US\"], \"currencies\":[\"USD\"]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "channels (2.x only)",
"x-testDescription": "\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/channels/my_new_channel_3": {
"patch": {
"description": "",
"summary": "channel (2.x only)",
"tags": [
"Channel"
],
"operationId": "RestV1ChannelsMyNewChannel3Patch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Channel(2.xOnly)request"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/channels/my_new_channel_3",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"my_new_channel_3\",\"currencies\":[\"USD\",\"EUR\"],\"locales\":[\"de_DE\",\"en_US\",\"fr_FR\"],\"category_tree\":\"master\",\"conversion_units\":{\"weight\":\"GRAM\"},\"labels\":{\"en_US\":\"new category label US\",\"de_DE\":\"new category label DE\",\"fr_FR\":\"new category label FR\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "channel (2.x only)1",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/currencies/USD": {
"get": {
"description": "Assuming that the given code is the code of an existing currency",
"summary": "currency (2.x only)",
"tags": [
"Currency (2.x only)"
],
"operationId": "RestV1CurrenciesUSDGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/currencies/USD"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "currency (2.x only)",
"x-testDescription": "Assuming that the given code is the code of an existing currency"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/currencies": {
"get": {
"description": "",
"summary": "currencies (2.x only)",
"tags": [
"Currency (2.x only)"
],
"operationId": "RestV1CurrenciesGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/currencies"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "currencies (2.x only)",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/families/camcorders": {
"get": {
"description": "Assuming that the given code is the code of an existing family",
"summary": "family",
"tags": [
"Family"
],
"operationId": "RestV1FamiliesCamcordersGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/families/camcorders"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "family",
"x-testDescription": "Assuming that the given code is the code of an existing family"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "",
"summary": "family",
"tags": [
"Family"
],
"operationId": "RestV1FamiliesCamcordersPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/FamilyRequest36"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/families/camcorders",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"camcorders\",\"attribute_as_label\":\"sku\",\"labels\":{\"en_US\":\"new Camcorders label\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "family2",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/families": {
"get": {
"description": "",
"summary": "families",
"tags": [
"Family"
],
"operationId": "RestV1FamiliesGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/families"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "families",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Assuming that there is no \"new_family\" already existing",
"summary": "family",
"tags": [
"Family"
],
"operationId": "RestV1FamiliesPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/FamilyRequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/rest/v1/families",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"new_family\",\"attributes\":[\"container_material\",\"description\",\"main_color\",\"name\",\"picture\",\"price\",\"sku\"],\"attribute_as_label\":\"name\",\"attribute_as_image\":\"picture\",\"attribute_requirements\":{\"ecommerce\":[\"container_material\",\"description\",\"main_color\",\"name\",\"price\",\"sku\"],\"mobile\":[\"description\",\"main_color\",\"name\",\"price\",\"sku\"],\"print\":[\"description\",\"name\",\"price\",\"sku\"]},\"labels\":{\"de_DE\":\"new family label DE\",\"en_US\":\"new family label US\",\"fr_FR\":\"new family label FR\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "family1",
"x-testDescription": "Assuming that there is no \"new_family\" already existing"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "\n",
"summary": "families",
"tags": [
"Family"
],
"operationId": "RestV1FamiliesPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/families",
"headers": {
"Content-Type": "application/vnd.akeneo.collection+json"
},
"body": "{\"code\": \"new_family\", \"attribute_as_label\": \"name\", \"attributes\":[\"name\",\"picture\",\"price\",\"sku\"]}\n{\"code\": \"camcorders\", \"labels\":{\"de_DE\":\"\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "families1",
"x-testDescription": "\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/families/clothing/variants/clothing_colorsize": {
"get": {
"description": "Assuming that the given codes are respectively the code of an existing family and an existing family variant",
"summary": "family variant (2.x only)",
"tags": [
"Family variant (2.x only)"
],
"operationId": "RestV1FamiliesClothingVariantsClothingColorsizeGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/families/clothing/variants/clothing_colorsize"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "family variant (2.x only)",
"x-testDescription": "Assuming that the given codes are respectively the code of an existing family and an existing family variant"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "Assuming that the given codes are respectively the code of an existing family and an existing family variant",
"summary": "family variant (2.x only)",
"tags": [
"Family variant (2.x only)"
],
"operationId": "RestV1FamiliesClothingVariantsClothingColorsizePatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/FamilyVariant(2.xOnly)request"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/families/clothing/variants/clothing_colorsize",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"clothing_colorsize\",\"labels\":{\"de_DE\":\"Kleidung nach Farbe/Größe\",\"en_US\":\"Clothing by color/size\",\"fr_FR\":\"Vêtements par couleur/taille\"},\"variant_attribute_sets\":[{\"level\":1,\"axes\":[\"color\",\"size\"],\"attributes\":[\"sku\",\"variation_name\",\"variation_image\",\"composition\",\"color\",\"size\",\"ean\"]}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "family variant (2.x only)2",
"x-testDescription": "Assuming that the given codes are respectively the code of an existing family and an existing family variant"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/families/clothing/variants": {
"get": {
"description": "",
"summary": "family variants (2.x only)",
"tags": [
"Family variant (2.x only)"
],
"operationId": "RestV1FamiliesClothingVariantsGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/families/clothing/variants"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "family variants (2.x only)",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Assuming that the given code is the code of an existing family",
"summary": "family variant (2.x only)",
"tags": [
"Family variant (2.x only)"
],
"operationId": "RestV1FamiliesClothingVariantsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/FamilyVariant(2.xOnly)request"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/rest/v1/families/clothing/variants",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"code\":\"new_family_variant\",\"labels\":{\"de_DE\":\"new family variant label DE\",\"en_US\":\"new family variant label US\",\"fr_FR\":\"new family variant label FR\"},\"variant_attribute_sets\":[{\"level\":1,\"axes\":[\"color\"],\"attributes\":[\"composition\",\"material\",\"variant_name\",\"variant_image\"]},{\"level\":2,\"axes\":[\"size\"],\"attributes\":[\"ean\",\"sku\",\"weight\"]}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "family variant (2.x only)1",
"x-testDescription": "Assuming that the given code is the code of an existing family"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "Assuming that the given code is the code of an existing family",
"summary": "family variants (2.x only)",
"tags": [
"Family variant (2.x only)"
],
"operationId": "RestV1FamiliesClothingVariantsPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/families/clothing/variants",
"headers": {
"Content-Type": "application/vnd.akeneo.collection+json"
},
"body": "{\"code\": \"new_family_variant\", \"labels\": { \"de_DE\": \"new family variant label DE\"}, \"variant_attribute_sets\": [{\"level\": 1, \"axes\": [\"color\"], \"attributes\": [\"composition\", \"material\"]}]}\n{\"code\": \"clothing_colorsize\", \"variant_attribute_sets\": [{\"level\": 1, \"axes\": [\"color\", \"size\"], \"attributes\": [\"sku\", \"composition\", \"color\", \"size\", \"ean\"]}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "family variants (2.x only)1",
"x-testDescription": "Assuming that the given code is the code of an existing family"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/locales/en_US": {
"get": {
"description": "Assuming that the given code is the code of an existing locale",
"summary": "locale",
"tags": [
"Locale"
],
"operationId": "RestV1LocalesEnUSGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/locales/en_US"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "locale",
"x-testDescription": "Assuming that the given code is the code of an existing locale"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/locales": {
"get": {
"description": "",
"summary": "locales",
"tags": [
"Locale"
],
"operationId": "RestV1LocalesGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/locales"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "locales",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/measure-families/area": {
"get": {
"description": "Assuming that the given code is the code of an existing measure family",
"summary": "measure family (2.x only)",
"tags": [
"Measure family (2.x only)"
],
"operationId": "RestV1MeasureFamiliesAreaGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/measure-families/area"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "measure family (2.x only)",
"x-testDescription": "Assuming that the given code is the code of an existing measure family"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/measure-families": {
"get": {
"description": "",
"summary": "measure families (2.x only)",
"tags": [
"Measure family (2.x only)"
],
"operationId": "RestV1MeasureFamiliesGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/measure-families"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "measure families (2.x only)",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/media-files/d/d/b/6/ddb6ad393f81503b6be7380785e3b32bbd28cd08_test.png": {
"get": {
"description": "Assuming that the given code is the code of an existing media file",
"summary": "media",
"tags": [
"Media file"
],
"operationId": "RestV1MediaFilesDDB6Ddb6ad393f81503b6be7380785e3b32bbd28cd08TestPngGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/media-files/d/d/b/6/ddb6ad393f81503b6be7380785e3b32bbd28cd08_test.png"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "media",
"x-testDescription": "Assuming that the given code is the code of an existing media file"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/media-files": {
"get": {
"description": "",
"summary": "medias",
"tags": [
"Media file"
],
"operationId": "RestV1MediaFilesGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/media-files"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "medias",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Assuming that the given identifier is the identifier of an existing product and that the given attribute code exists",
"summary": "media",
"tags": [
"Media file"
],
"operationId": "RestV1MediaFilesPost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "product",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "file",
"in": "formData",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/rest/v1/media-files",
"headers": {
"Content-Type": "multipart/form-data"
},
"body": "product={\"identifier\":\"AKNTS_BPS\",\"attribute\":\"picture\",\"scope\":null,\"locale\":null}&file="
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "media1",
"x-testDescription": "Assuming that the given identifier is the identifier of an existing product and that the given attribute code exists"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/products/AKNSTK": {
"get": {
"description": "Assuming that the given identifier is the identifier of an existing product",
"summary": "product",
"tags": [
"Product"
],
"operationId": "RestV1ProductsAKNSTKGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/products/AKNSTK"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "product",
"x-testDescription": "Assuming that the given identifier is the identifier of an existing product"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "",
"summary": "product",
"tags": [
"Product"
],
"operationId": "RestV1ProductsAKNSTKPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/ProductRequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/products": {
"get": {
"description": "\n",
"summary": "products",
"tags": [
"Product"
],
"operationId": "RestV1ProductsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Cookie",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/products",
"headers": {
"Content-Type": "application/json",
"Cookie": ""
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "products",
"x-testDescription": "\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Assuming that there is no \"new_product\" already existing",
"summary": "product",
"tags": [
"Product"
],
"operationId": "RestV1ProductsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/ProductRequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "\n",
"summary": "products",
"tags": [
"Product"
],
"operationId": "RestV1ProductsPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/products",
"headers": {
"Content-Type": "application/vnd.akeneo.collection+json"
},
"body": "{\"identifier\": \"new_product\"}\n{\"identifier\": \"AKNSTK\", \"family\": \"tshirts\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "products1",
"x-testDescription": "\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/products/AKNTS_BPXS": {
"delete": {
"description": "Assuming that the given identifier is the identifier of an existing product",
"summary": "product",
"tags": [
"Product"
],
"operationId": "RestV1ProductsAKNTSBPXSDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/rest/v1/products/AKNTS_BPXS",
"headers": {
"Content-type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "product1",
"x-testDescription": "Assuming that the given identifier is the identifier of an existing product"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/products/AKNTS_BPS/draft": {
"get": {
"description": "Assuming that there is already a draft for the given product. The draft was created by the same user that using this request.\nThe user has only an edition permission through categories on the given product.",
"summary": "draft (2.x and EE only)",
"tags": [
"Product"
],
"operationId": "RestV1ProductsAKNTSBPSDraftGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/products/AKNTS_BPS/draft"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "draft (2.x and EE only)",
"x-testDescription": "Assuming that there is already a draft for the given product. The draft was created by the same user that using this request.\nThe user has only an edition permission through categories on the given product."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/products/AKNTS_BPS/proposal": {
"post": {
"description": "Assuming that there is already a draft for the given product. The draft was created by the same user using this request.\nThe user has only an edition permission through categories on the given product.",
"summary": "proposal (2.x and EE only)",
"tags": [
"Product"
],
"operationId": "RestV1ProductsAKNTSBPSProposalPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "object"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/rest/v1/products/AKNTS_BPS/proposal",
"headers": {
"Content-Type": "application/json"
},
"body": "{}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "proposal (2.x and EE only)",
"x-testDescription": "Assuming that there is already a draft for the given product. The draft was created by the same user using this request.\nThe user has only an edition permission through categories on the given product."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/product-models/amor": {
"get": {
"description": "Assuming that the given code is the code of an existing product model",
"summary": "product model (2.x only)",
"tags": [
"Product model (2.x only)"
],
"operationId": "RestV1ProductModelsAmorGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/product-models/amor"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "product model (2.x only)",
"x-testDescription": "Assuming that the given code is the code of an existing product model"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "Assuming that the given code is the code of an existing product model",
"summary": "product model (2.x only)",
"tags": [
"Product model (2.x only)"
],
"operationId": "RestV1ProductModelsAmorPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/ProductModel(2.xOnly)request80"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/product-models": {
"get": {
"description": "\n",
"summary": "product models (2.x only)",
"tags": [
"Product model (2.x only)"
],
"operationId": "RestV1ProductModelsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/product-models",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "product models (2.x only)",
"x-testDescription": "\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "product model (2.x only)",
"tags": [
"Product model (2.x only)"
],
"operationId": "RestV1ProductModelsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/ProductModel(2.xOnly)request"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "\n",
"summary": "product models (2.x only)",
"tags": [
"Product model (2.x only)"
],
"operationId": "RestV1ProductModelsPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/rest/v1/product-models",
"headers": {
"Content-Type": "application/vnd.akeneo.collection+json"
},
"body": "{\"code\": \"new_product_model\", \"parent\":\"jack\", \"values\":{\"color\":[{\"scope\":null, \"locale\":null, \"data\":\"pink\"}]}}\n{\"code\": \"amor\", \"values\":{\"brand\":[{\"scope\":null, \"locale\":null, \"data\":\"akeneo\"}]}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "product models (2.x only)1",
"x-testDescription": "\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/product-models/amor/draft": {
"get": {
"description": "Assuming that there is already a draft for the given product model. The draft was created by the same user that is using this request.\nThe user has only an edition permission through categories on the given product model.",
"summary": "draft (2.3 and EE only)",
"tags": [
"Product model (2.x only)"
],
"operationId": "RestV1ProductModelsAmorDraftGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/product-models/amor/draft"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "draft (2.3 and EE only)",
"x-testDescription": "Assuming that there is already a draft for the given product model. The draft was created by the same user that is using this request.\nThe user has only an edition permission through categories on the given product model."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/product-models/amor/proposal": {
"post": {
"description": "Assuming that there is already a draft for the given product model. The draft was created by the same user using this request.\nThe user has only an edition permission through categories on the given product model.",
"summary": "proposal (2.3 and EE only)",
"tags": [
"Product model (2.x only)"
],
"operationId": "RestV1ProductModelsAmorProposalPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "object"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/rest/v1/product-models/amor/proposal",
"headers": {
"Content-Type": "application/json"
},
"body": "{}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "proposal (2.3 and EE only)",
"x-testDescription": "Assuming that there is already a draft for the given product model. The draft was created by the same user using this request.\nThe user has only an edition permission through categories on the given product model."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/published-products/13527420": {
"get": {
"description": "Assuming that the given identifier is the identifier of an existing product that is currently published",
"summary": "published product (2.x and EE only)",
"tags": [
"Published product (2.x and EE only)"
],
"operationId": "RestV1PublishedProducts13527420Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/published-products/13527420",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "published product (2.x and EE only)",
"x-testDescription": "Assuming that the given identifier is the identifier of an existing product that is currently published"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/rest/v1/published-products": {
"get": {
"description": "\n",
"summary": "published products (2.x and EE only)",
"tags": [
"Published product (2.x and EE only)"
],
"operationId": "RestV1PublishedProductsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/rest/v1/published-products",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "published products (2.x and EE only)",
"x-testDescription": "\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/oauth/v1/token": {
"post": {
"description": "",
"summary": "Authentification by refresh token",
"tags": [
"Misc"
],
"operationId": "OauthV1TokenPost2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AuthentificationByRefreshTokenrequest"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/oauth/v1/token",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"refresh_token\":\"{{refreshToken}}\",\"grant_type\":\"refresh_token\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Authentification by refresh token",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
}
},
"definitions": {
"Asset(2.1Only)request": {
"title": "asset (2.1 only)Request",
"example": {
"code": "new_asset",
"localizable": false,
"description": "An amazing asset",
"end_of_use": "2018-05-11T22:00:00+00:00",
"tags": [
"colored"
],
"categories": [
"images"
]
},
"type": "object",
"properties": {
"code": {
"description": "",
"example": "new_asset",
"type": "string"
},
"localizable": {
"description": "",
"example": false,
"type": "boolean"
},
"description": {
"description": "",
"example": "An amazing asset",
"type": "string"
},
"end_of_use": {
"description": "",
"example": "5/11/2018 10:00:00 PM",
"type": "string"
},
"tags": {
"description": "",
"example": [
"colored"
],
"type": "array",
"items": {
"type": "string"
}
},
"categories": {
"description": "",
"example": [
"images"
],
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"code",
"localizable",
"description",
"end_of_use",
"tags",
"categories"
]
},
"AssetCategory(2.1Only)request": {
"title": "asset category (2.1 only)Request",
"example": {
"code": "new_asset_category",
"parent": "asset_main_catalog",
"labels": {
"de_DE": "new asset category label DE",
"en_US": "new asset category label US",
"fr_FR": "new asset category label FR"
}
},
"type": "object",
"properties": {
"code": {
"description": "",
"example": "new_asset_category",
"type": "string"
},
"parent": {
"description": "",
"example": "asset_main_catalog",
"type": "string"
},
"labels": {
"$ref": "#/definitions/Labels"
}
},
"required": [
"code",
"parent",
"labels"
]
},
"Labels": {
"title": "Labels",
"example": {
"de_DE": "new asset category label DE",
"en_US": "new asset category label US",
"fr_FR": "new asset category label FR"
},
"type": "object",
"properties": {
"de_DE": {
"description": "",
"example": "new asset category label DE",
"type": "string"
},
"en_US": {
"description": "",
"example": "new asset category label US",
"type": "string"
},
"fr_FR": {
"description": "",
"example": "new asset category label FR",
"type": "string"
}
},
"required": [
"de_DE",
"en_US",
"fr_FR"
]
},
"AssetTag(2.1Only)request": {
"title": "asset tag (2.1 only)Request",
"example": {
"code": "colored"
},
"type": "object",
"properties": {
"code": {
"description": "",
"example": "colored",
"type": "string"
}
},
"required": [
"code"
]
},
"AssociationType(2.xOnly)request": {
"title": "association type (2.x only)Request",
"example": {
"code": "new_association_type",
"labels": {
"de_DE": "new association type label DE",
"en_US": "new association type label US",
"fr_FR": "new association type label FR"
}
},
"type": "object",
"properties": {
"code": {
"description": "",
"example": "new_association_type",
"type": "string"
},
"labels": {
"$ref": "#/definitions/Labels"
}
},
"required": [
"code",
"labels"
]
},
"AssociationType(2.xOnly)request9": {
"title": "association type (2.x only)Request9",
"example": {
"code": "UPSELL",
"labels": {
"en_US": "Upsell",
"fr_FR": "Vente incitative"
}
},
"type": "object",
"properties": {
"code": {
"description": "",
"example": "UPSELL",
"type": "string"
},
"labels": {
"$ref": "#/definitions/Labels10"
}
},
"required": [
"code",
"labels"
]
},
"Labels10": {
"title": "Labels10",
"example": {
"en_US": "Upsell",
"fr_FR": "Vente incitative"
},
"type": "object",
"properties": {
"en_US": {
"description": "",
"example": "Upsell",
"type": "string"
},
"fr_FR": {
"description": "",
"example": "Vente incitative",
"type": "string"
}
},
"required": [
"en_US",
"fr_FR"
]
},
"AttributeRequest": {
"title": "attributeRequest",
"example": {
"code": "new_attribute",
"type": "pim_catalog_boolean",
"group": "technical",
"unique": false,
"useable_as_grid_filter": true,
"allowed_extensions": [],
"metric_family": null,
"default_metric_unit": null,
"reference_data_name": null,
"available_locales": [],
"max_characters": null,
"validation_rule": null,
"validation_regexp": null,
"wysiwyg_enabled": null,
"number_min": null,
"number_max": null,
"decimals_allowed": null,
"negative_allowed": null,
"date_min": null,
"date_max": null,
"max_file_size": null,
"minimum_input_length": null,
"sort_order": 39,
"localizable": false,
"scopable": false,
"labels": {
"de_DE": "new attribute label DE",
"en_US": "new attribute label US",
"fr_FR": "new attribute label FR"
}
},
"type": "object",
"properties": {
"code": {
"description": "",
"example": "new_attribute",
"type": "string"
},
"type": {
"description": "",
"example": "pim_catalog_boolean",
"type": "string"
},
"group": {
"description": "",
"example": "technical",
"type": "string"
},
"unique": {
"description": "",
"example": false,
"type": "boolean"
},
"useable_as_grid_filter": {
"description": "",
"example": true,
"type": "boolean"
},
"allowed_extensions": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"metric_family": {
"description": "",
"type": "string"
},
"default_metric_unit": {
"description": "",
"type": "string"
},
"reference_data_name": {
"description": "",
"type": "string"
},
"available_locales": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"max_characters": {
"description": "",
"type": "string"
},
"validation_rule": {
"description": "",
"type": "string"
},
"validation_regexp": {
"description": "",
"type": "string"
},
"wysiwyg_enabled": {
"description": "",
"type": "string"
},
"number_min": {
"description": "",
"type": "string"
},
"number_max": {
"description": "",
"type": "string"
},
"decimals_allowed": {
"description": "",
"type": "string"
},
"negative_allowed": {
"description": "",
"type": "string"
},
"date_min": {
"description": "",
"type": "string"
},
"date_max": {
"description": "",
"type": "string"
},
"max_file_size": {
"description": "",
"type": "string"
},
"minimum_input_length": {
"description": "",
"type": "string"
},
"sort_order": {
"description": "",
"example": 39,
"type": "integer",
"format": "int32"
},
"localizable": {
"description": "",
"example": false,
"type": "boolean"
},
"scopable": {
"description": "",
"example": false,
"type": "boolean"
},
"labels": {
"$ref": "#/definitions/Labels"
}
},
"required": [
"code",
"type",
"group",
"unique",
"useable_as_grid_filter",
"allowed_extensions",
"metric_family",
"default_metric_unit",
"reference_data_name",
"available_locales",
"max_characters",
"validation_rule",
"validation_regexp",
"wysiwyg_enabled",
"number_min",
"number_max",
"decimals_allowed",
"negative_allowed",
"date_min",
"date_max",
"max_file_size",
"minimum_input_length",
"sort_order",
"localizable",
"scopable",
"labels"
]
},
"AttributeOptionrequest": {
"title": "attribute optionRequest",
"example": {
"code": "yellow",
"attribute": "main_color",
"sort_order": 10,
"labels": {
"de_DE": "Gelb",
"en_US": "Yellow",
"fr_FR": "Jaune"
}
},
"type": "object",
"properties": {
"code": {
"description": "",
"example": "yellow",
"type": "string"
},
"attribute": {
"description": "",
"example": "main_color",
"type": "string"
},
"sort_order": {
"description": "",
"example": 10,
"type": "integer",
"format": "int32"
},
"labels": {
"$ref": "#/definitions/Labels"
}
},
"required": [
"code",
"attribute",
"sort_order",
"labels"
]
},
"AttributeGroup(2.xOnly)request": {
"title": "attribute group (2.x only)Request",
"example": {
"code": "new_attribute_group",
"sort_order": 10,
"attributes": [
"main_color",
"secondary_color"
],
"labels": {
"de_DE": "new attribute group label DE",
"en_US": "new attribute group label US",
"fr_FR": "new attribute group label FR"
}
},
"type": "object",
"properties": {
"code": {
"description": "",
"example": "new_attribute_group",
"type": "string"
},
"sort_order": {
"description": "",
"example": 10,
"type": "integer",
"format": "int32"
},
"attributes": {
"description": "",
"example": [
"main_color",
"secondary_color"
],
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"$ref": "#/definitions/Labels"
}
},
"required": [
"code",
"sort_order",
"attributes",
"labels"
]
},
"CategoryRequest": {
"title": "categoryRequest",
"example": {
"code": "new_category",
"parent": "master",
"labels": {
"de_DE": "new category label DE",
"en_US": "new category label US",
"fr_FR": "new category label FR"
}
},
"type": "object",
"properties": {
"code": {
"description": "",
"example": "new_category",
"type": "string"
},
"parent": {
"description": "",
"example": "master",
"type": "string"
},
"labels": {
"$ref": "#/definitions/Labels"
}
},
"required": [
"code",
"parent",
"labels"
]
},
"CategoryRequest25": {
"title": "categoryRequest25",
"example": {
"code": "audio_video",
"parent": "master",
"labels": {
"en_US": "new Audio and Video label"
}
},
"type": "object",
"properties": {
"code": {
"description": "",
"example": "audio_video",
"type": "string"
},
"parent": {
"description": "",
"example": "master",
"type": "string"
},
"labels": {
"$ref": "#/definitions/Labels26"
}
},
"required": [
"code",
"parent",
"labels"
]
},
"Labels26": {
"title": "Labels26",
"example": {
"en_US": "new Audio and Video label"
},
"type": "object",
"properties": {
"en_US": {
"description": "",
"example": "new Audio and Video label",
"type": "string"
}
},
"required": [
"en_US"
]
},
"Channel(2.xOnly)request": {
"title": "channel (2.x only)Request",
"example": {
"code": "new_channel",
"currencies": [
"USD",
"EUR"
],
"locales": [
"de_DE",
"en_US",
"fr_FR"
],
"category_tree": "master",
"conversion_units": {
"weight": "GRAM"
},
"labels": {
"en_US": "new category label US",
"de_DE": "new category label DE",
"fr_FR": "new category label FR"
}
},
"type": "object",
"properties": {
"code": {
"description": "",
"example": "new_channel",
"type": "string"
},
"currencies": {
"description": "",
"example": [
"USD",
"EUR"
],
"type": "array",
"items": {
"type": "string"
}
},
"locales": {
"description": "",
"example": [
"de_DE",
"en_US",
"fr_FR"
],
"type": "array",
"items": {
"type": "string"
}
},
"category_tree": {
"description": "",
"example": "master",
"type": "string"
},
"conversion_units": {
"$ref": "#/definitions/ConversionUnits"
},
"labels": {
"$ref": "#/definitions/Labels"
}
},
"required": [
"code",
"currencies",
"locales",
"category_tree",
"conversion_units",
"labels"
]
},
"ConversionUnits": {
"title": "ConversionUnits",
"example": {
"weight": "GRAM"
},
"type": "object",
"properties": {
"weight": {
"description": "",
"example": "GRAM",
"type": "string"
}
},
"required": [
"weight"
]
},
"FamilyRequest": {
"title": "familyRequest",
"example": {
"code": "new_family",
"attributes": [
"container_material",
"description",
"main_color",
"name",
"picture",
"price",
"sku"
],
"attribute_as_label": "name",
"attribute_as_image": "picture",
"attribute_requirements": {
"ecommerce": [
"container_material",
"description",
"main_color",
"name",
"price",
"sku"
],
"mobile": [
"description",
"main_color",
"name",
"price",
"sku"
],
"print": [
"description",
"name",
"price",
"sku"
]
},
"labels": {
"de_DE": "new family label DE",
"en_US": "new family label US",
"fr_FR": "new family label FR"
}
},
"type": "object",
"properties": {
"code": {
"description": "",
"example": "new_family",
"type": "string"
},
"attributes": {
"description": "",
"example": [
"container_material",
"description",
"main_color",
"name",
"picture",
"price",
"sku"
],
"type": "array",
"items": {
"type": "string"
}
},
"attribute_as_label": {
"description": "",
"example": "name",
"type": "string"
},
"attribute_as_image": {
"description": "",
"example": "picture",
"type": "string"
},
"attribute_requirements": {
"$ref": "#/definitions/AttributeRequirements"
},
"labels": {
"$ref": "#/definitions/Labels"
}
},
"required": [
"code",
"attributes",
"attribute_as_label",
"attribute_as_image",
"attribute_requirements",
"labels"
]
},
"AttributeRequirements": {
"title": "AttributeRequirements",
"example": {
"ecommerce": [
"container_material",
"description",
"main_color",
"name",
"price",
"sku"
],
"mobile": [
"description",
"main_color",
"name",
"price",
"sku"
],
"print": [
"description",
"name",
"price",
"sku"
]
},
"type": "object",
"properties": {
"ecommerce": {
"description": "",
"example": [
"container_material",
"description",
"main_color",
"name",
"price",
"sku"
],
"type": "array",
"items": {
"type": "string"
}
},
"mobile": {
"description": "",
"example": [
"description",
"main_color",
"name",
"price",
"sku"
],
"type": "array",
"items": {
"type": "string"
}
},
"print": {
"description": "",
"example": [
"description",
"name",
"price",
"sku"
],
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"ecommerce",
"mobile",
"print"
]
},
"FamilyRequest36": {
"title": "familyRequest36",
"example": {
"code": "camcorders",
"attribute_as_label": "sku",
"labels": {
"en_US": "new Camcorders label"
}
},
"type": "object",
"properties": {
"code": {
"description": "",
"example": "camcorders",
"type": "string"
},
"attribute_as_label": {
"description": "",
"example": "sku",
"type": "string"
},
"labels": {
"$ref": "#/definitions/Labels26"
}
},
"required": [
"code",
"attribute_as_label",
"labels"
]
},
"FamilyVariant(2.xOnly)request": {
"title": "family variant (2.x only)Request",
"example": {
"code": "new_family_variant",
"labels": {
"de_DE": "new family variant label DE",
"en_US": "new family variant label US",
"fr_FR": "new family variant label FR"
},
"variant_attribute_sets": [
{
"level": 1,
"axes": [
"color"
],
"attributes": [
"composition",
"material",
"variant_name",
"variant_image"
]
},
{
"level": 2,
"axes": [
"size"
],
"attributes": [
"ean",
"sku",
"weight"
]
}
]
},
"type": "object",
"properties": {
"code": {
"description": "",
"example": "new_family_variant",
"type": "string"
},
"labels": {
"$ref": "#/definitions/Labels"
},
"variant_attribute_sets": {
"description": "",
"example": [
{
"level": 1,
"axes": [
"color"
],
"attributes": [
"composition",
"material",
"variant_name",
"variant_image"
]
},
{
"level": 2,
"axes": [
"size"
],
"attributes": [
"ean",
"sku",
"weight"
]
}
],
"type": "array",
"items": {
"$ref": "#/definitions/VariantAttributeSet"
}
}
},
"required": [
"code",
"labels",
"variant_attribute_sets"
]
},
"VariantAttributeSet": {
"title": "VariantAttributeSet",
"example": {
"level": 1,
"axes": [
"color"
],
"attributes": [
"composition",
"material",
"variant_name",
"variant_image"
]
},
"type": "object",
"properties": {
"level": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"axes": {
"description": "",
"example": [
"color"
],
"type": "array",
"items": {
"type": "string"
}
},
"attributes": {
"description": "",
"example": [
"composition",
"material",
"variant_name",
"variant_image"
],
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"level",
"axes",
"attributes"
]
},
"ProductRequest": {
"title": "productRequest",
"type": "object",
"properties": {
"identifier": {
"description": "",
"example": "new_product",
"type": "string"
},
"family": {
"description": "",
"example": "tshirts",
"type": "string"
},
"groups": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"parent": {
"description": "",
"type": "string"
},
"categories": {
"description": "",
"example": [
"tvs_projectors"
],
"type": "array",
"items": {
"type": "string"
}
},
"enabled": {
"description": "",
"example": true,
"type": "boolean"
},
"values": {
"$ref": "#/definitions/Values"
},
"created": {
"description": "",
"example": "3/30/2017 12:55:26 PM",
"type": "string"
},
"updated": {
"description": "",
"example": "5/4/2017 9:56:09 PM",
"type": "string"
},
"associations": {
"$ref": "#/definitions/Associations"
}
},
"required": [
"identifier",
"family",
"groups",
"parent",
"categories",
"enabled",
"values",
"created",
"updated",
"associations"
]
},
"Values": {
"title": "Values",
"type": "object",
"properties": {
"clothing_size": {
"description": "",
"example": [
{
"locale": null,
"scope": null,
"data": "s"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/ClothingSize"
}
},
"description": {
"description": "",
"example": [
{
"locale": "en_US",
"scope": "mobile",
"data": "Akeneo T-Shirt 77777"
},
{
"locale": "en_US",
"scope": "print",
"data": "Akeneo T-Shirt with short sleeve"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Description"
}
},
"main_color": {
"description": "",
"example": [
{
"locale": null,
"scope": null,
"data": "black"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/MainColor"
}
},
"name": {
"description": "",
"example": [
{
"locale": null,
"scope": null,
"data": "Akeneo T-Shirt black and purple with short sleeve"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Name"
}
},
"secondary_color": {
"description": "",
"example": [
{
"locale": null,
"scope": null,
"data": "purple"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/SecondaryColor"
}
},
"tshirt_materials": {
"description": "",
"example": [
{
"locale": null,
"scope": null,
"data": "cotton"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/TshirtMaterial"
}
},
"tshirt_style": {
"description": "",
"example": [
{
"locale": null,
"scope": null,
"data": [
"crewneck",
"short_sleeve"
]
}
],
"type": "array",
"items": {
"$ref": "#/definitions/TshirtStyle"
}
},
"price": {
"description": "",
"example": [
{
"locale": null,
"scope": null,
"data": [
{
"amount": 10,
"currency": "EUR"
},
{
"amount": 14,
"currency": "USD"
}
]
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Price"
}
}
},
"required": [
"clothing_size",
"description",
"main_color",
"name",
"secondary_color",
"tshirt_materials",
"tshirt_style",
"price"
]
},
"ClothingSize": {
"title": "ClothingSize",
"example": {
"locale": null,
"scope": null,
"data": "s"
},
"type": "object",
"properties": {
"locale": {
"description": "",
"type": "string"
},
"scope": {
"description": "",
"type": "string"
},
"data": {
"description": "",
"example": "s",
"type": "string"
}
},
"required": [
"locale",
"scope",
"data"
]
},
"Description": {
"title": "Description",
"example": {
"locale": "en_US",
"scope": "mobile",
"data": "Akeneo T-Shirt 77777"
},
"type": "object",
"properties": {
"locale": {
"description": "",
"example": "en_US",
"type": "string"
},
"scope": {
"description": "",
"example": "mobile",
"type": "string"
},
"data": {
"description": "",
"example": "Akeneo T-Shirt 77777",
"type": "string"
}
},
"required": [
"locale",
"scope",
"data"
]
},
"MainColor": {
"title": "MainColor",
"example": {
"locale": null,
"scope": null,
"data": "black"
},
"type": "object",
"properties": {
"locale": {
"description": "",
"type": "string"
},
"scope": {
"description": "",
"type": "string"
},
"data": {
"description": "",
"example": "black",
"type": "string"
}
},
"required": [
"locale",
"scope",
"data"
]
},
"Name": {
"title": "Name",
"example": {
"locale": null,
"scope": null,
"data": "Akeneo T-Shirt black and purple with short sleeve"
},
"type": "object",
"properties": {
"locale": {
"description": "",
"type": "string"
},
"scope": {
"description": "",
"type": "string"
},
"data": {
"description": "",
"example": "Akeneo T-Shirt black and purple with short sleeve",
"type": "string"
}
},
"required": [
"locale",
"scope",
"data"
]
},
"SecondaryColor": {
"title": "SecondaryColor",
"example": {
"locale": null,
"scope": null,
"data": "purple"
},
"type": "object",
"properties": {
"locale": {
"description": "",
"type": "string"
},
"scope": {
"description": "",
"type": "string"
},
"data": {
"description": "",
"example": "purple",
"type": "string"
}
},
"required": [
"locale",
"scope",
"data"
]
},
"TshirtMaterial": {
"title": "TshirtMaterial",
"example": {
"locale": null,
"scope": null,
"data": "cotton"
},
"type": "object",
"properties": {
"locale": {
"description": "",
"type": "string"
},
"scope": {
"description": "",
"type": "string"
},
"data": {
"description": "",
"example": "cotton",
"type": "string"
}
},
"required": [
"locale",
"scope",
"data"
]
},
"TshirtStyle": {
"title": "TshirtStyle",
"example": {
"locale": null,
"scope": null,
"data": [
"crewneck",
"short_sleeve"
]
},
"type": "object",
"properties": {
"locale": {
"description": "",
"type": "string"
},
"scope": {
"description": "",
"type": "string"
},
"data": {
"description": "",
"example": [
"crewneck",
"short_sleeve"
],
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"locale",
"scope",
"data"
]
},
"Price": {
"title": "Price",
"example": {
"locale": null,
"scope": null,
"data": [
{
"amount": 10,
"currency": "EUR"
},
{
"amount": 14,
"currency": "USD"
}
]
},
"type": "object",
"properties": {
"locale": {
"description": "",
"type": "string"
},
"scope": {
"description": "",
"type": "string"
},
"data": {
"description": "",
"example": [
{
"amount": 10,
"currency": "EUR"
},
{
"amount": 14,
"currency": "USD"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Datum"
}
}
},
"required": [
"locale",
"scope",
"data"
]
},
"Datum": {
"title": "Datum",
"example": {
"amount": 10,
"currency": "EUR"
},
"type": "object",
"properties": {
"amount": {
"description": "",
"example": 10,
"type": "integer",
"format": "int32"
},
"currency": {
"description": "",
"example": "EUR",
"type": "string"
}
},
"required": [
"amount",
"currency"
]
},
"Associations": {
"title": "Associations",
"example": {
"SUBSTITUTION": {
"groups": [],
"products": [
"AKNSTK"
]
}
},
"type": "object",
"properties": {
"SUBSTITUTION": {
"$ref": "#/definitions/SUBSTITUTION"
}
},
"required": [
"SUBSTITUTION"
]
},
"SUBSTITUTION": {
"title": "SUBSTITUTION",
"example": {
"groups": [],
"products": [
"AKNSTK"
]
},
"type": "object",
"properties": {
"groups": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"products": {
"description": "",
"example": [
"AKNSTK"
],
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"groups",
"products"
]
},
"ProductModel(2.xOnly)request": {
"title": "product model (2.x only)Request",
"type": "object",
"properties": {
"code": {
"description": "",
"example": "new_product_model",
"type": "string"
},
"family_variant": {
"description": "",
"example": "clothing_colorsize",
"type": "string"
},
"parent": {
"description": "",
"type": "string"
},
"categories": {
"description": "",
"example": [
"master_men_blazers",
"supplier_zaro"
],
"type": "array",
"items": {
"type": "string"
}
},
"values": {
"$ref": "#/definitions/Values71"
}
},
"required": [
"code",
"family_variant",
"parent",
"categories",
"values"
]
},
"Values71": {
"title": "Values71",
"type": "object",
"properties": {
"name": {
"description": "",
"example": [
{
"locale": null,
"scope": null,
"data": "A new product model"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Name"
}
},
"price": {
"description": "",
"example": [
{
"locale": "null",
"scope": "null",
"data": [
{
"amount": "999.00",
"currency": "EUR"
},
{
"amount": "null",
"currency": "USD"
}
]
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Price73"
}
},
"erp_name": {
"description": "",
"example": [
{
"locale": "en_US",
"scope": null,
"data": "Amor"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/ErpName"
}
},
"supplier": {
"description": "",
"example": [
{
"locale": null,
"scope": null,
"data": "zaro"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Supplier"
}
},
"collection": {
"description": "",
"example": [
{
"locale": null,
"scope": null,
"data": [
"summer_2016"
]
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Collection"
}
},
"description": {
"description": "",
"example": [
{
"locale": "en_US",
"scope": "ecommerce",
"data": "Heritage jacket navy blue tweed suit with single breasted 2 button. 53% wool, 22% polyester, 18% acrylic, 5% nylon, 1% cotton, 1% viscose. Dry Cleaning uniquement.Le mannequin measuring 1m85 and wears UK size 40, size 50 FR"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Description"
}
},
"wash_temperature": {
"description": "",
"example": [
{
"locale": null,
"scope": null,
"data": "800"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/WashTemperature"
}
}
},
"required": [
"name",
"price",
"erp_name",
"supplier",
"collection",
"description",
"wash_temperature"
]
},
"Price73": {
"title": "Price73",
"example": {
"locale": "null",
"scope": "null",
"data": [
{
"amount": "999.00",
"currency": "EUR"
},
{
"amount": "null",
"currency": "USD"
}
]
},
"type": "object",
"properties": {
"locale": {
"description": "",
"type": "string"
},
"scope": {
"description": "",
"type": "string"
},
"data": {
"description": "",
"example": [
{
"amount": "999.00",
"currency": "EUR"
},
{
"amount": "null",
"currency": "USD"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Datum74"
}
}
},
"required": [
"locale",
"scope",
"data"
]
},
"Datum74": {
"title": "Datum74",
"example": {
"amount": "999.00",
"currency": "EUR"
},
"type": "object",
"properties": {
"amount": {
"description": "",
"example": "999.00",
"type": "string"
},
"currency": {
"description": "",
"example": "EUR",
"type": "string"
}
},
"required": [
"amount",
"currency"
]
},
"ErpName": {
"title": "ErpName",
"example": {
"locale": "en_US",
"scope": null,
"data": "Amor"
},
"type": "object",
"properties": {
"locale": {
"description": "",
"example": "en_US",
"type": "string"
},
"scope": {
"description": "",
"type": "string"
},
"data": {
"description": "",
"example": "Amor",
"type": "string"
}
},
"required": [
"locale",
"scope",
"data"
]
},
"Supplier": {
"title": "Supplier",
"example": {
"locale": null,
"scope": null,
"data": "zaro"
},
"type": "object",
"properties": {
"locale": {
"description": "",
"type": "string"
},
"scope": {
"description": "",
"type": "string"
},
"data": {
"description": "",
"example": "zaro",
"type": "string"
}
},
"required": [
"locale",
"scope",
"data"
]
},
"Collection": {
"title": "Collection",
"example": {
"locale": null,
"scope": null,
"data": [
"summer_2016"
]
},
"type": "object",
"properties": {
"locale": {
"description": "",
"type": "string"
},
"scope": {
"description": "",
"type": "string"
},
"data": {
"description": "",
"example": [
"summer_2016"
],
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"locale",
"scope",
"data"
]
},
"WashTemperature": {
"title": "WashTemperature",
"example": {
"locale": null,
"scope": null,
"data": "800"
},
"type": "object",
"properties": {
"locale": {
"description": "",
"type": "string"
},
"scope": {
"description": "",
"type": "string"
},
"data": {
"description": "",
"example": "800",
"type": "string"
}
},
"required": [
"locale",
"scope",
"data"
]
},
"ProductModel(2.xOnly)request80": {
"title": "product model (2.x only)Request80",
"type": "object",
"properties": {
"code": {
"description": "",
"example": "amor",
"type": "string"
},
"family_variant": {
"description": "",
"example": "clothing_colorsize",
"type": "string"
},
"parent": {
"description": "",
"type": "string"
},
"categories": {
"description": "",
"example": [
"master_men_blazers",
"supplier_zaro"
],
"type": "array",
"items": {
"type": "string"
}
},
"values": {
"$ref": "#/definitions/Values71"
},
"created": {
"description": "",
"example": "10/19/2017 8:22:30 AM",
"type": "string"
},
"updated": {
"description": "",
"example": "10/19/2017 8:22:30 AM",
"type": "string"
}
},
"required": [
"code",
"family_variant",
"parent",
"categories",
"values",
"created",
"updated"
]
},
"AuthentificationByPasswordrequest": {
"title": "Authentification by passwordRequest",
"example": {
"username": "{{username}}",
"password": "{{password}}",
"grant_type": "password"
},
"type": "object",
"properties": {
"username": {
"description": "",
"example": "{{username}}",
"type": "string"
},
"password": {
"description": "",
"example": "{{password}}",
"type": "string"
},
"grant_type": {
"description": "",
"example": "password",
"type": "string"
}
},
"required": [
"username",
"password",
"grant_type"
]
},
"AuthentificationByRefreshTokenrequest": {
"title": "Authentification by refresh tokenRequest",
"example": {
"refresh_token": "{{refreshToken}}",
"grant_type": "refresh_token"
},
"type": "object",
"properties": {
"refresh_token": {
"description": "",
"example": "{{refreshToken}}",
"type": "string"
},
"grant_type": {
"description": "",
"example": "refresh_token",
"type": "string"
}
},
"required": [
"refresh_token",
"grant_type"
]
}
}
}