From dc787b5f489d826b5b66da6150317c4993a545f2 Mon Sep 17 00:00:00 2001 From: shopwareBot Date: Sat, 25 Jul 2026 10:37:08 +0000 Subject: [PATCH] [create-pull-request] automated change --- SwagCommercial-adminapi.json | 650 --------------------------- SwagCommercial-adminapi.summary.json | 6 - 2 files changed, 656 deletions(-) diff --git a/SwagCommercial-adminapi.json b/SwagCommercial-adminapi.json index ffa51fc..3474da8 100644 --- a/SwagCommercial-adminapi.json +++ b/SwagCommercial-adminapi.json @@ -39592,656 +39592,6 @@ } } }, - "/_action/order/document-v2/available-types": { - "get": { - "tags": [ - "Document Management", - "Experimental" - ], - "summary": "List supported document V2 types and formats", - "description": "Returns document types and output formats currently implemented by the Document V2 pipeline. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "documentV2AvailableTypes", - "responses": { - "200": { - "description": "Supported document types and their available formats.", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "documentTypes" - ], - "properties": { - "documentTypes": { - "description": "Map of supported document type technical names to the formats implemented for that document type. Use these values for the `documentType`, `formats`, and `format` fields of the create, preview, and upload endpoints.", - "type": "object", - "additionalProperties": { - "type": "object", - "required": [ - "formats" - ], - "properties": { - "formats": { - "description": "Supported file format technical names for this document type.", - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "example": { - "documentTypes": { - "invoice": { - "formats": [ - "html", - "pdf", - "zugferd_xml" - ] - } - } - } - } - } - } - } - } - } - }, - "/_action/order/document-v2/create": { - "post": { - "tags": [ - "Document Management", - "Experimental" - ], - "summary": "Create a document through the Document V2 pipeline", - "description": "Creates one document with one or more requested output formats using the Document V2 services. Get supported `documentType` and `formats` values from `/_action/order/document-v2/available-types`. Use the returned `documentId` and one of the returned `formats` to download the created file through `/_action/order/document-v2/{documentId}/download/{format}`. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "createDocumentV2", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "orderId", - "orderVersionId", - "documentType", - "formats" - ], - "properties": { - "orderId": { - "description": "Identifier of the order for which the document should be created.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "description": "Version identifier of the order for which the document should be created.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentType": { - "description": "Document type technical name. Must be one of the keys returned by `/_action/order/document-v2/available-types`.", - "type": "string", - "example": "invoice" - }, - "formats": { - "description": "File format technical names to generate. Must be selected from `documentTypes[documentType].formats` returned by `/_action/order/document-v2/available-types`.", - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "example": [ - "pdf", - "zugferd_xml" - ] - }, - "documentNumber": { - "description": "Optional document number. When omitted, the Document V2 service generates the next number.", - "type": "string" - }, - "documentComment": { - "description": "Optional document comment.", - "type": "string" - }, - "documentDate": { - "description": "Optional document date as an ISO 8601 date-time string.", - "type": "string", - "format": "date-time", - "example": "2026-07-13T00:00:00.000+00:00" - } - }, - "example": { - "orderId": "018f5972f9ea72a0be49f7c39f72a2a0", - "orderVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "documentType": "invoice", - "formats": [ - "pdf", - "zugferd_xml" - ], - "documentNumber": "1002", - "documentDate": "2026-07-13T00:00:00.000+00:00", - "documentComment": "Customer requested a copy." - } - } - } - } - }, - "responses": { - "200": { - "description": "Document created successfully. Use `documentId` and one of the returned `formats` to download the created file through `/_action/order/document-v2/{documentId}/download/{format}`.", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "deepLinkCode", - "documentId", - "formats" - ], - "properties": { - "deepLinkCode": { - "description": "A unique hash code which is required to download the generated document.", - "type": "string" - }, - "documentId": { - "description": "Identifier of the document.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "formats": { - "description": "The generated formats. Use one of these values as the `format` path parameter when downloading the document.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "example": { - "deepLinkCode": "COp6DlWc2JgUn3XOb7QzKXWcWIVrH8XN", - "documentId": "018f5972f9ea72a0be49f7c39f72a2a0", - "formats": [ - "pdf", - "zugferd_xml" - ] - } - } - } - } - } - } - } - }, - "/_action/order/document-v2/upload": { - "post": { - "tags": [ - "Document Management", - "Experimental" - ], - "summary": "Upload a document through the Document V2 pipeline", - "description": "Creates one static Document V2 document from either an existing media file or a raw binary file upload. Use `application/json` when the file already exists as media and pass `mediaId` in the body. Use a binary request body when uploading file bytes directly; in that case pass the document metadata as query parameters. Example binary upload: `POST /_action/order/document-v2/upload?orderId=018f5972f9ea72a0be49f7c39f72a2a0&orderVersionId=0fa91ce3e96a4bc2be4bd9ce752c3425&documentType=invoice&format=pdf&extension=pdf&fileName=invoice-1002` with header `Content-Type: application/pdf` and the PDF bytes as the request body. Get supported `documentType` and `format` values from `/_action/order/document-v2/available-types`. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "uploadDocumentV2", - "parameters": [ - { - "name": "orderId", - "in": "query", - "description": "Required for binary uploads. Identifier of the order for which the uploaded document should be created. For JSON uploads, send this field in the request body instead.", - "required": false, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "orderVersionId", - "in": "query", - "description": "Required for binary uploads. Version identifier of the order for which the uploaded document should be created. For JSON uploads, send this field in the request body instead.", - "required": false, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "documentType", - "in": "query", - "description": "Required for binary uploads. Document type technical name. Must be one of the keys returned by `/_action/order/document-v2/available-types`. For JSON uploads, send this field in the request body instead.", - "required": false, - "schema": { - "type": "string", - "example": "invoice" - } - }, - { - "name": "format", - "in": "query", - "description": "Required for binary uploads. Document file format to store. Must be selected from `documentTypes[documentType].formats` returned by `/_action/order/document-v2/available-types`. For JSON uploads, send this field in the request body instead.", - "required": false, - "schema": { - "type": "string", - "example": "pdf" - } - }, - { - "name": "extension", - "in": "query", - "description": "Required for binary uploads. File extension of the uploaded binary body, without a leading dot. Usually this is the same value as `format`.", - "required": false, - "schema": { - "type": "string", - "example": "pdf" - } - }, - { - "name": "fileName", - "in": "query", - "description": "Optional for binary uploads. Preferred stored media filename without the extension. If omitted, the document number or a generated identifier is used.", - "required": false, - "schema": { - "type": "string", - "example": "invoice-1002" - } - }, - { - "name": "referencedDocumentId", - "in": "query", - "description": "Optional for binary uploads. Identifier of the referenced document. For JSON uploads, send this field in the request body instead.", - "required": false, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "documentNumber", - "in": "query", - "description": "Optional for binary uploads. Document number stored in the document configuration. For JSON uploads, send this field in the request body instead.", - "required": false, - "schema": { - "type": "string", - "example": "1002" - } - }, - { - "name": "documentComment", - "in": "query", - "description": "Optional for binary uploads. Document comment stored in the document configuration. For JSON uploads, send this field in the request body instead.", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "documentDate", - "in": "query", - "description": "Optional for binary uploads. Document date stored in the document configuration as an ISO 8601 date-time string. For JSON uploads, send this field in the request body instead.", - "required": false, - "schema": { - "type": "string", - "format": "date-time", - "example": "2026-07-13T00:00:00.000+00:00" - } - } - ], - "requestBody": { - "description": "Use `application/json` to attach an existing media file by `mediaId`. Use a binary media type, for example `application/pdf`, to upload file bytes directly and provide the document metadata through query parameters. For binary uploads, the body is the raw file content, not JSON.", - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "orderId", - "orderVersionId", - "documentType", - "format", - "mediaId" - ], - "properties": { - "orderId": { - "description": "Identifier of the order for which the uploaded document should be created.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "description": "Version identifier of the order for which the uploaded document should be created.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentType": { - "description": "Document type technical name. Must be one of the keys returned by `/_action/order/document-v2/available-types`.", - "type": "string", - "example": "invoice" - }, - "format": { - "description": "File format technical name. Must be selected from `documentTypes[documentType].formats` returned by `/_action/order/document-v2/available-types`.", - "type": "string", - "example": "pdf" - }, - "mediaId": { - "description": "Identifier of an existing media file to attach to the document. Required for JSON uploads.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "referencedDocumentId": { - "description": "Optional identifier of the referenced document.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentNumber": { - "description": "Optional document number.", - "type": "string" - }, - "documentComment": { - "description": "Optional document comment.", - "type": "string" - }, - "documentDate": { - "description": "Optional document date as an ISO 8601 date-time string.", - "type": "string", - "format": "date-time", - "example": "2026-07-13T00:00:00.000+00:00" - } - }, - "example": { - "orderId": "018f5972f9ea72a0be49f7c39f72a2a0", - "orderVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "documentType": "invoice", - "format": "pdf", - "mediaId": "018f5972fa0773c793fb88af536e34f6", - "documentNumber": "1002", - "documentDate": "2026-07-13T00:00:00.000+00:00" - } - } - }, - "application/pdf": { - "schema": { - "description": "Raw file bytes. For binary uploads, send the required document metadata as query parameters.", - "type": "string", - "format": "binary" - }, - "example": "%PDF-1.7 ..." - }, - "application/octet-stream": { - "schema": { - "description": "Raw file bytes. For binary uploads, send the required document metadata as query parameters.", - "type": "string", - "format": "binary" - } - } - } - }, - "responses": { - "200": { - "description": "Document uploaded successfully. Use `documentId` and one of the returned `formats` to download the uploaded file through `/_action/order/document-v2/{documentId}/download/{format}`.", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "deepLinkCode", - "documentId", - "formats" - ], - "properties": { - "deepLinkCode": { - "description": "A unique hash code which is required to download the uploaded document.", - "type": "string" - }, - "documentId": { - "description": "Identifier of the document.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "formats": { - "description": "The uploaded format. Use one of these values as the `format` path parameter when downloading the document.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "example": { - "deepLinkCode": "COp6DlWc2JgUn3XOb7QzKXWcWIVrH8XN", - "documentId": "018f5972f9ea72a0be49f7c39f72a2a0", - "formats": [ - "pdf" - ] - } - } - } - } - } - } - } - }, - "/_action/order/document-v2/{documentId}/download/{format}": { - "get": { - "tags": [ - "Document Management", - "Experimental" - ], - "summary": "Download a Document V2 file", - "description": "Downloads one persisted format for a Document V2 document. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "downloadDocumentV2", - "parameters": [ - { - "name": "documentId", - "in": "path", - "description": "Identifier of the document.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "format", - "in": "path", - "description": "Persisted document format to download.", - "required": true, - "schema": { - "type": "string", - "example": "pdf" - } - } - ], - "responses": { - "200": { - "description": "The requested document file.", - "headers": { - "Content-Disposition": { - "description": "Contains the attachment filename.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/pdf": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "text/html": { - "schema": { - "type": "string" - } - }, - "application/xml": { - "schema": { - "type": "string" - } - }, - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - } - } - } - }, - "/_action/order/document-v2/{documentId}/download-archive": { - "get": { - "tags": [ - "Document Management", - "Experimental" - ], - "summary": "Download all Document V2 files as ZIP", - "description": "Downloads all persisted formats for a Document V2 document as one ZIP archive. The archive contains one file per persisted format. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "downloadDocumentV2Archive", - "parameters": [ - { - "name": "documentId", - "in": "path", - "description": "Identifier of the document.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "A ZIP archive containing all persisted files for the document.", - "headers": { - "Content-Disposition": { - "description": "Contains the attachment filename.", - "schema": { - "type": "string", - "example": "attachment; filename=1000.zip" - } - } - }, - "content": { - "application/zip": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - } - } - } - }, - "/_action/order/document-v2/preview": { - "post": { - "tags": [ - "Document Management", - "Experimental" - ], - "summary": "Preview a document through the Document V2 pipeline", - "description": "Renders one requested output format through the Document V2 services without persisting the document. Get supported `documentType` and `format` values from `/_action/order/document-v2/available-types`. The response `Content-Type` depends on the requested format. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "previewDocumentV2", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "orderId", - "orderVersionId", - "documentType", - "format" - ], - "properties": { - "orderId": { - "description": "Identifier of the order for which the document should be previewed.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "description": "Version identifier of the order for which the document should be previewed.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentType": { - "description": "Document type technical name. Must be one of the keys returned by `/_action/order/document-v2/available-types`.", - "type": "string", - "example": "invoice" - }, - "format": { - "description": "File format technical name to preview. Must be selected from `documentTypes[documentType].formats` returned by `/_action/order/document-v2/available-types`.", - "type": "string", - "example": "html" - }, - "documentNumber": { - "description": "Optional document number to render in the preview.", - "type": "string" - }, - "documentComment": { - "description": "Optional document comment to render in the preview.", - "type": "string" - }, - "documentDate": { - "description": "Optional document date as an ISO 8601 date-time string.", - "type": "string", - "format": "date-time", - "example": "2026-07-13T00:00:00.000+00:00" - } - }, - "example": { - "orderId": "018f5972f9ea72a0be49f7c39f72a2a0", - "orderVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "documentType": "invoice", - "format": "html", - "documentNumber": "1002", - "documentDate": "2026-07-13T00:00:00.000+00:00", - "documentComment": "Preview comment." - } - } - } - } - }, - "responses": { - "200": { - "description": "The previewed document.", - "headers": { - "Content-Disposition": { - "description": "Contains the inline document filename.", - "schema": { - "type": "string" - } - } - }, - "content": { - "text/html": { - "schema": { - "type": "string" - } - }, - "application/pdf": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/xml": { - "schema": { - "type": "string" - } - }, - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - } - } - } - }, "/api/_admin/licensing/features/{type}": { "get": { "tags": [ diff --git a/SwagCommercial-adminapi.summary.json b/SwagCommercial-adminapi.summary.json index a0cbf94..a5c6b76 100644 --- a/SwagCommercial-adminapi.summary.json +++ b/SwagCommercial-adminapi.summary.json @@ -3,12 +3,6 @@ "/_action/create-employee", "/_action/custom-price", "/_action/invite-employee", - "/_action/order/document-v2/available-types", - "/_action/order/document-v2/create", - "/_action/order/document-v2/preview", - "/_action/order/document-v2/upload", - "/_action/order/document-v2/{documentId}/download-archive", - "/_action/order/document-v2/{documentId}/download/{format}", "/_action/organization-unit/assign-company-employees", "/_action/organization-unit/assign-employees", "/_action/organization-unit/assign-organization-units",