Create Document

Create a new document in catalog management.

POST/v1/catalog/products/{productId}/documents

Path parameters

productId*string

Body

multipart/form-data

documentobject

Json representation of the document

filestring (binary)

Response

201400

Created

Body

application/json

domainEventsarray of DomainEvent (object)

markedForDeleteboolean

markedForUpdateboolean

documentIdDocumentId (object)

fileIdFileId (object)

urlstring

languagestring

statusState (enum)

DraftPendingPublishedUnpublished

isDeletedboolean

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v1/catalog/products/{productId}/documents', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400

{
  "domainEvents": [
    {
      "timeStamp": "2025-01-23T21:12:21.215Z"
    }
  ],
  "markedForDelete": false,
  "markedForUpdate": false,
  "documentId": {
    "value": "text",
    "postfixNumber": 0
  },
  "fileId": {
    "value": "text"
  },
  "url": "text",
  "language": "text",
  "status": "Draft",
  "isDeleted": false
}