--- title: Updates the common draft catalog entry. slug: commerce-connect-15/service-api/updates-the-common-draft-catalog-entry docTags: createdAt: 2026-10-09T17:33:29.599Z --- { "id": "SYl0QHC04v_AbzhnXYKwn", "type": "api-oas-v2", "data": { "method": "PUT", "url": "/episerverapi/commerce/entries/{entryCode}/commondraft/{lang}", "servers": [], "name": "Updates the common draft catalog entry.", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "lang", "type": "string", "description": "The language code." }, { "kind": "required", "name": "entryCode", "type": "string", "description": "" } ], "headerParameters": [], "queryParameters": [ { "kind": "optional", "name": "entryCode", "type": "string", "description": "The entry code." } ], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "The draft catalog entry.", "customType": "DraftEntry", "schema": [ { "name": "code", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the Catalog Entry Code." }, { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "startDate", "kind": "optional", "type": "string", "description": "Gets or sets the start date.", "format": "date-time" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "Gets or sets the end date.", "format": "date-time" }, { "name": "metaClass", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the MetaClass." }, { "name": "catalog", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the Catalog." }, { "name": "prices", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the price values.", "modelRef": "#/components/schemas/ResourceLink", "customType": "ResourceLink[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the title." }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." }, { "name": "href", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the uri." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/NameValue", "customType": "NameValue[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." } ] } ] }, { "name": "entryType", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type of the entry." }, { "name": "childCatalogEntries", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the child catalog entries.", "modelRef": "#/components/schemas/ResourceLink", "customType": "ResourceLink[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the title." }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." }, { "name": "href", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the uri." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/NameValue", "customType": "NameValue[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." } ] } ] }, { "name": "inventoryStatus", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the flag indicating how inventory amounts are handled." }, { "name": "warehouseInventories", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the warehouse inventories.", "modelRef": "#/components/schemas/ResourceLink", "customType": "ResourceLink[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the title." }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." }, { "name": "href", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the uri." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/NameValue", "customType": "NameValue[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." } ] } ] }, { "name": "associations", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the associations.", "modelRef": "#/components/schemas/ResourceLink", "customType": "ResourceLink[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the title." }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." }, { "name": "href", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the uri." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/NameValue", "customType": "NameValue[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." } ] } ] }, { "name": "assets", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the assets.", "modelRef": "#/components/schemas/ResourceLink", "customType": "ResourceLink[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the title." }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." }, { "name": "href", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the uri." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/NameValue", "customType": "NameValue[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." } ] } ] }, { "name": "nodes", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the nodes.", "modelRef": "#/components/schemas/ResourceLink", "customType": "ResourceLink[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the title." }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." }, { "name": "href", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the uri." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/NameValue", "customType": "NameValue[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." } ] } ] }, { "name": "variation", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/VariationProperties", "customType": "VariationProperties", "schema": [ { "name": "minQuantity", "kind": "optional", "type": "number", "description": "Gets or sets the min quantity.", "format": "double" }, { "name": "maxQuantity", "kind": "optional", "type": "number", "description": "Gets or sets the max quantity.", "format": "double" }, { "name": "weight", "kind": "optional", "type": "number", "description": "Gets or sets the weight.", "format": "double" }, { "name": "taxCategory", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the tax category." } ] }, { "name": "dimension", "kind": "optional", "type": "object", "description": "

Model to indicate that an variation/package has shipment dimension properties.

", "modelRef": "#/components/schemas/DimensionProperties", "customType": "DimensionProperties", "schema": [ { "name": "length", "kind": "optional", "type": "number", "description": "Gets or sets the length.", "format": "double" }, { "name": "height", "kind": "optional", "type": "number", "description": "Gets or sets the height.", "format": "double" }, { "name": "width", "kind": "optional", "type": "number", "description": "Gets or sets the width.", "format": "double" } ] }, { "name": "metaFields", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the item attributes.", "modelRef": "#/components/schemas/DraftMetaFieldProperty", "customType": "DraftMetaFieldProperty[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." }, { "name": "data", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the data." } ] }, { "name": "seoInformation", "kind": "optional", "type": "object", "description": "The draft Seo info model.", "modelRef": "#/components/schemas/DraftSeoInfo", "customType": "DraftSeoInfo", "schema": [ { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the title." }, { "name": "uri", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the URI." }, { "name": "uriSegment", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the uri segment." }, { "name": "description", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the description." }, { "name": "keywords", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the keywords." } ] } ], "modelRef": "#/components/schemas/DraftEntry", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Success", "jsonExample": "", "isExpanded": true }, { "statusCode": "204", "description": "The common draft catalog entry is saved.", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "If the common draft catalog entry model is not valid.", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "If user does not have enough permission for this request.", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "If common draft catalog entry does not exist.", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "cl4pJKpybzJYXP7v-0eHx", "language": "curl", "label": "cURL", "code": "curl --request PUT \\\n --url /episerverapi/commerce/entries/{entryCode}/commondraft/{lang} \\\n --header 'accept: application/json'" }, { "id": "5fEinkD39MOJbAg1uSIY9", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'PUT',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"/episerverapi/commerce/entries/{entryCode}/commondraft/{lang}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "e1aDswfFqiFYI3CyqQFJ9", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/episerverapi/commerce/entries/{entryCode}/commondraft/{lang}\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Put.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "Cud97mUawRm48zkHCXaJ3", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"/episerverapi/commerce/entries/{entryCode}/commondraft/{lang}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "cl4pJKpybzJYXP7v-0eHx" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Success\n" }, { "id": "response-1-204", "language": "204", "code": "// The common draft catalog entry is saved.\n" }, { "id": "response-2-400", "language": "400", "code": "// If the common draft catalog entry model is not valid.\n" }, { "id": "response-3-401", "language": "401", "code": "// If user does not have enough permission for this request.\n" }, { "id": "response-4-404", "language": "404", "code": "// If common draft catalog entry does not exist.\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }