{ "x-generator": "NSwag v14.6.2.0 (NJsonSchema v11.5.2.0 (Newtonsoft.Json v13.0.0.0))", "openapi": "3.0.0", "info": { "title": "JTL-WAWI API (Cloud)", "description": "JTL-Wawi-Version: 2.1.0-beta.5276+Sha.ca198c5\r\n# Introduction\r\n\r\nWelcome to the JTL-WAWI technical API documentation. This guide is here to help developers understand how our REST API works and how it can be integrated into your existing systems. We'll delve into the details of authentication and data manipulation processes, providing clear examples along the way. Whether you're a developer or an IT professional, this documentation aims to give you a practical understanding, laying the groundwork for effectively using the JTL-WAWI API to enhance your processes.\r\n\r\n# Authentication\r\n\r\nYou register your application with the API by sending a POST request with the required information and corresponding keys. You can find the exact request details at https://developer.jtl-software.com/products/erp/swagger/appregistration. This information has to include the following:\r\n\r\n* AppId\r\n* DisplayName\r\n* Description\r\n* Version\r\n* ProviderName\r\n* ProviderWebsite\r\n* MandatoryApiScopes\r\n\r\nThis data is crucial for identifying and registering your application with the API. The API uses it to generate a temporary authentication ID that allows your application to access the necessary resources. After successful validation of this information, you will receive the API key required for future authentication and API requests.\r\n\r\nBefore you can begin the registration process, you must open JTL-Wawi (new interface) and start the registration process under 'Admin->App registration'. Only at this point are you authorised to send the first API call. This step in JTL-Wawi ensures that your application is properly registered and has permission to use the API.\r\n\r\nThe API will send you an authentication ID in the form of a token. Once you have received this token and successfully completed the registration in JTL-Wawi, you will send another request to the API by including this authentication ID in the URL path.\r\n\r\nAfter successful validation of this second request by the API and confirmation of the correct information, you will be provided with the actual API key. It is important to note that this API key will not be displayed again!\r\n\r\nThis API key will be used in the future to authenticate requests to the API. It is of utmost importance that you securely store the API key upon receipt, as it cannot be retrieved from any other location in the system.", "contact": { "name": "JTL-Software-GmbH", "url": "https://developer.jtl-software.com/", "email": "partner@jtl-software.com" }, "version": "2.0", "x-application-version": "2.1.0.0" }, "servers": [ { "url": "https://api.jtl-cloud.com/erp", "description": "Production Environment Cloud API Gateway" } ], "paths": { "/v2/accountingData": { "get": { "tags": [ "accountingData" ], "summary": "Query Accounting Data", "description": "Delivers a paginated overview of finalized accounting transactions, including invoices, credits, and their cancellations and corrections.", "operationId": "AccountingData_QueryAccountingDataAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "from", "in": "query", "description": "Filters documents starting from a specific date and time", "schema": { "type": "string", "format": "date-time" }, "x-position": 1 }, { "name": "to", "in": "query", "description": "Filters documents up to a specific date and time", "schema": { "type": "string", "format": "date-time" }, "x-position": 2 }, { "name": "companyId", "in": "query", "description": "Gets the unique identifier for the firm.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "x-position": 3 }, { "name": "type", "in": "query", "description": "Specifies the type of document. 0 = Invoice, 1 = Credit, 2 = Invoice correction, 3 = Invoice cancellation, 4 = credit cancellation, 5 = invoice correction cancellation", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.AccountingData.DocumentType" }, "x-position": 4 }, { "name": "exportCurrencyInDepartureCountry", "in": "query", "description": "If true, exports total sums in the currency of the departure country", "schema": { "type": "boolean" }, "x-position": 5 }, { "name": "pageNumber", "in": "query", "description": "Number of the page of items to fetch.", "schema": { "type": "integer", "format": "int32" }, "x-position": 6 }, { "name": "pageSize", "in": "query", "description": "Size of the page that is specified by `pageNumber`.", "schema": { "type": "integer", "format": "int32" }, "x-position": 7 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Provides a detailed overview of all non-pending sales orders, including invoices, credits, invoice corrections, invoice cancellations, credit cancellations, and invoice correction cancellations, along with their associated line items", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V2.AccountingData.AccountingData" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No registration request was found for the specified identifier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "accountings.read" ] }, { "oauth2-client-credentials": [ "accountings.read" ] } ], "x-sort": 100, "x-stability-level": "draft" } }, "/v2/authentication": { "post": { "tags": [ "appRegistration" ], "summary": "Register App", "description": "Send a registration request for an (external) application", "operationId": "Authentication_RegisterAppAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-challengecode", "in": "header", "required": true, "description": "You can enter any custom value here. The X-ChallengeCode is used during app registration and must be the same for all registration requests. The maximum length is 30 characters.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "registrationRequest", "description": "Contains the registration request's data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Authentication.CreateAppRegistrationRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Status of the registration process (including the unique identifiers for application and registration request)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Authentication.RegistrationRequestStatusInfo" } } } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "403": { "description": "There was no application service available to receive and handle the registration request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "409": { "description": "An application with the specified unique id is already registered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/authentication/{registrationId}": { "get": { "tags": [ "appRegistration" ], "summary": "Fetch Registration Status", "description": "Obtain information about a registration request", "operationId": "Authentication_FetchRegistrationStatusAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "registrationId", "in": "path", "required": true, "description": "Unique identifier of the registration request", "schema": { "type": "string" }, "x-position": 1 }, { "name": "x-challengecode", "in": "header", "required": true, "description": "You can enter any custom value here. The X-ChallengeCode is used during app registration and must be the same for all registration requests. The maximum length is 30 characters.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Registration information (containing the current status of the registration process)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Authentication.RegistrationInformation" } } } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No registration request was found for the specified identifier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "410": { "description": "The registration request for the specified identifier has already been processed and answered", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-sort": 0, "x-stability-level": "stable" }, "post": { "tags": [ "appRegistration" ], "summary": "Register Multi Instance App", "description": "Sends a registration request for another instance of the same application", "operationId": "Authentication_RegisterMultiInstanceAppAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "registrationId", "in": "path", "required": true, "description": "Unique identifier of the registration request", "schema": { "type": "string" }, "x-position": 1 }, { "name": "x-challengecode", "in": "header", "required": true, "description": "You can enter any custom value here. The X-ChallengeCode is used during app registration and must be the same for all registration requests. The maximum length is 30 characters.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Status of the registration process (including the unique identifiers of the application and registration request)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Authentication.RegistrationRequestStatusInfo" } } } }, "400": { "description": "The operation was not allowed in the given context.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "402": { "description": "No licence available or the application has not been authorised by JTL.", "content": { "application/json": {} } }, "403": { "description": "There was no application service available to receive and handle the registration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/authentication/login": { "post": { "tags": [ "login" ], "summary": "Login", "description": "Sends a request to log in the user / dynamically assign the WAWI user. Only use this request if your API uses SSL.", "operationId": "Authentication_LoginAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-challengecode", "in": "header", "required": true, "description": "You can enter any custom value here. The X-ChallengeCode is used during app registration and must be the same for all registration requests. The maximum length is 30 characters.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "loginRequest", "description": "Contains the login information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Authentication.CreateLogin" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "login success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Authentication.Login" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-sort": 0, "x-stability-level": "beta" } }, "/v2/authentication/logout": { "post": { "tags": [ "logout" ], "summary": "Logout", "description": "Sends a request to log out the user", "operationId": "Authentication_LogoutAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-challengecode", "in": "header", "required": true, "description": "You can enter any custom value here. The X-ChallengeCode is used during app registration and must be the same for all registration requests. The maximum length is 30 characters.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "logout success", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-sort": 0, "x-stability-level": "beta" } }, "/v2/availabilities": { "get": { "tags": [ "item" ], "summary": "Query Availabilities", "description": "Query all availabilites for items", "operationId": "Availability_QueryAvailabilitiesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all availabilites for items.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Availability.Availability" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "items.read" ] }, { "oauth2-client-credentials": [ "items.read" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/bill-of-materials-items/{id}": { "get": { "tags": [ "BillOfMaterialsComponentsQuery" ], "summary": "Retrieves a bill of materials item by its ID.", "operationId": "BillOfMaterialsComponents_QueryBillOfMaterialsItemById", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "id", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialComponentKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.read" ] }, { "oauth2-client-credentials": [ "pps.read" ] } ], "x-stability-level": "alpha" } }, "/v2/bill-of-materials-items/{id}/delete": { "delete": { "tags": [ "BillOfMaterialsComponentsCommand" ], "summary": "Deletes a bill of materials item from a bill of materials.", "operationId": "BillOfMaterialsComponents_DeleteBillOfMaterialsItem", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "id", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialComponentKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.BillOfMaterialsComponents.DeleteBillOfMaterialsItemCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully deleted a bill of materials item.", "content": { "application/json": {} } }, "403": { "description": "The specified bill of materials item could not be deleted.", "content": { "application/json": {} } }, "404": { "description": "The specified bill of materials item was not found.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.write" ] }, { "oauth2-client-credentials": [ "pps.write" ] } ], "x-stability-level": "alpha" } }, "/v2/bill-of-materials-operations/{billOfMaterialsOperationId}/bill-of-materials-items/create": { "post": { "tags": [ "CreateCommand" ], "summary": "Creates a new bill of materials item for a bill of materials operation.", "operationId": "Create_CreateBillOfMaterialsItem", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "billOfMaterialsOperationId", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialComponentKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateBillOfMaterialsItemCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Successfully created a bill of materials item.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.write" ] }, { "oauth2-client-credentials": [ "pps.write" ] } ], "x-stability-level": "alpha" } }, "/v2/bill-of-materials-operations/{id}": { "get": { "tags": [ "BillOfMaterialsComponentsQuery" ], "summary": "Retrieves a bill of materials operation by its ID.", "operationId": "BillOfMaterialsComponents_QueryBillOfMaterialsOperationById", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "id", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialComponentKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.read" ] }, { "oauth2-client-credentials": [ "pps.read" ] } ], "x-stability-level": "alpha" } }, "/v2/bill-of-materials-operations/{id}/delete": { "delete": { "tags": [ "BillOfMaterialsComponentsCommand" ], "summary": "Deletes a bill of materials operation from a bill of materials.", "operationId": "BillOfMaterialsComponents_DeleteBillOfMaterialsOperation", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "id", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialComponentKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.BillOfMaterialsComponents.DeleteBillOfMaterialsOperationCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully deleted a bill of materials operation.", "content": { "application/json": {} } }, "403": { "description": "The specified bill of materials operation could not be deleted.", "content": { "application/json": {} } }, "404": { "description": "The specified bill of materials operation was not found.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.write" ] }, { "oauth2-client-credentials": [ "pps.write" ] } ], "x-stability-level": "alpha" } }, "/v2/bills-of-materials/{billOfMaterialsId}/bill-of-materials-operations/create": { "post": { "tags": [ "CreateCommand" ], "summary": "Creates a new bill of materials operation for a bill of materials, including its items.", "operationId": "Create_CreateBillOfMaterialsOperation", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "billOfMaterialsId", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateBillOfMaterialsOperationCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Successfully created a bill of materials operation.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.write" ] }, { "oauth2-client-credentials": [ "pps.write" ] } ], "x-stability-level": "alpha" } }, "/v2/bills-of-materials/{id}": { "get": { "tags": [ "BillsOfMaterialsQuery" ], "summary": "Retrieves a bill of materials by its ID.", "operationId": "BillsOfMaterials_QueryBillOfMaterialsById", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "id", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.read" ] }, { "oauth2-client-credentials": [ "pps.read" ] } ], "x-stability-level": "alpha" } }, "/v2/bills-of-materials/{id}/delete": { "delete": { "tags": [ "BillsOfMaterialsCommand" ], "summary": "Deletes a bill of materials.", "operationId": "BillsOfMaterials_DeleteBillOfMaterials", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "id", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.BillsOfMaterials.DeleteBillOfMaterialsCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully deleted a bill of materials.", "content": { "application/json": {} } }, "404": { "description": "The specified bill of materials was not found.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.write" ] }, { "oauth2-client-credentials": [ "pps.write" ] } ], "x-stability-level": "alpha" } }, "/v2/cancellationReasons": { "get": { "tags": [ "cancellationreason" ], "summary": "Query Cancellation Reasons", "description": "Query all cancellation reasons for sales orders", "operationId": "CancellationReason_QueryCancellationReasonsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all cancellation reasons", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.CancellationReason.CancellationReason" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "orders.read" ] }, { "oauth2-client-credentials": [ "orders.read" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/category/{CategoryId}": { "get": { "tags": [ "CategoryQuery" ], "summary": "Delivers a single category", "operationId": "Category_GetCategoryById", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "CategoryId", "x-originalName": "categoryId", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.read" ] }, { "oauth2-client-credentials": [ "items.read" ] } ], "x-stability-level": "alpha" } }, "/v2/colorCodes": { "get": { "tags": [ "colorcodes" ], "summary": "Query Color Codes", "description": "Query all color codes for sales orders", "operationId": "ColorCode_QueryColorCodesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all color codes.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.ColorCode.ColorCode" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "orders.read" ] }, { "oauth2-client-credentials": [ "orders.read" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/companies": { "get": { "tags": [ "company" ], "summary": "Query Companies", "description": "Query all companies", "operationId": "Company_QueryCompaniesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all companies.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Company.Company" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "system.read" ] }, { "oauth2-client-credentials": [ "system.read" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/company/{CompanyId}": { "get": { "tags": [ "CompanydetailsQuery" ], "summary": "Delivers a single company", "operationId": "Companydetails_GetCompanyById", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "CompanyId", "x-originalName": "companyId", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.read" ] }, { "oauth2-client-credentials": [ "items.read" ] } ], "x-stability-level": "alpha" } }, "/v2/conditions": { "get": { "tags": [ "item" ], "summary": "Query Conditions", "description": "Query all item conditions", "operationId": "Condition_QueryConditionsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all conditions.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Condition.Condition" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "items.read" ] }, { "oauth2-client-credentials": [ "items.read" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/configuration/numberRanges": { "get": { "tags": [ "Configuration" ], "summary": "Get Number Ranges", "description": "Returns all available Number Ranges", "operationId": "NumberRanges_GetNumberRangesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The available Number Ranges", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.NumberRanges.NumberRangeItem" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "system.config.read" ] }, { "oauth2-client-credentials": [ "system.config.read" ] } ], "x-sort": 0, "x-stability-level": "draft" } }, "/v2/configuration/numberRanges/{numberRangeId}": { "get": { "tags": [ "Configuration" ], "summary": "Get Number Range", "description": "Returns the requested NumberRange", "operationId": "NumberRanges_GetNumberRangeAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "numberRangeId", "in": "path", "required": true, "description": "The uuid of the NumberRange", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested Numberrange", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.NumberRanges.NumberRangeItem" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No item with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "system.config.read" ] }, { "oauth2-client-credentials": [ "system.config.read" ] } ], "x-sort": 0, "x-stability-level": "draft" }, "post": { "tags": [ "Configuration" ], "summary": "Create Number Range", "description": "Create a new NumberRange based on the given NumberRange", "operationId": "NumberRanges_CreateNumberRangeAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "numberRangeId", "in": "path", "required": true, "description": "The id of the NumberRange on who this NumberRange is Based", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "item", "description": "The relevant Information of the NumberRange", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.NumberRanges.CreateNumberRangeItem" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The new Created NumberRange", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.NumberRanges.NumberRangeItem" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No item with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "system.config.write" ] }, { "oauth2-client-credentials": [ "system.config.write" ] } ], "x-sort": 0, "x-stability-level": "draft" }, "put": { "tags": [ "Configuration" ], "summary": "Update Number Range", "description": "Updates an Existing NumberRange", "operationId": "NumberRanges_UpdateNumberRangeAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "numberRangeId", "in": "path", "required": true, "description": "The id of the NumberRange", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "item", "description": "The relevant Information of the NumberRange", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.NumberRanges.PutNumberRangeItem" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The changed NumberRange", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.NumberRanges.NumberRangeItem" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No item with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "system.config.write" ] }, { "oauth2-client-credentials": [ "system.config.write" ] } ], "x-sort": 0, "x-stability-level": "draft" }, "delete": { "tags": [ "Configuration" ], "summary": "Delete Number Range", "description": "Delete a NumberRange, but only Deletable Numberranges", "operationId": "NumberRanges_DeleteNumberRangeAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "numberRangeId", "in": "path", "required": true, "description": "The id of the NumberRange", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The NumberRange is deleted", "content": { "application/json": {} } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No item with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "system.config.write" ] }, { "oauth2-client-credentials": [ "system.config.write" ] } ], "x-sort": 0, "x-stability-level": "draft" } }, "/v2/configuration/numberRanges/{numberRangeId}/increment": { "post": { "tags": [ "Configuration" ], "summary": "Number Range Increment", "description": "Increment and returns the Next Number for the given NumberRange", "operationId": "NumberRanges_NumberRangeIncrementAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "companyId", "in": "query", "description": "Gets the unique identifier for the firm.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "x-position": 1 }, { "name": "numberRangeId", "in": "path", "required": true, "description": "The id of the NumberRange", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "The resulting Next Number for the given Item.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.NumberRanges.NumberRangeCurrentNumberItem" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No item with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "system.config.write" ] }, { "oauth2-client-credentials": [ "system.config.write" ] } ], "x-sort": 0, "x-stability-level": "draft" } }, "/v2/configuration/numberRanges/{numberRangeId}/preview": { "get": { "tags": [ "Configuration" ], "summary": "Number Range Preview", "description": "Returns a Preview of the Next Number for the given NumberRange", "operationId": "NumberRanges_NumberRangePreviewAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "companyId", "in": "query", "description": "Gets the unique identifier for the firm.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "x-position": 1 }, { "name": "numberRangeId", "in": "path", "required": true, "description": "The id of the NumberRange", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The resulting Next Number for the given Item.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.NumberRanges.NumberRangeCurrentNumberItem" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No item with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "orders.read", "items.read", "system.config.read" ] }, { "oauth2-client-credentials": [ "orders.read", "items.read", "system.config.read" ] } ], "x-sort": 0, "x-stability-level": "draft" } }, "/v2/CopyItemdetails": { "post": { "tags": [ "CopyItemdetailsCommand" ], "operationId": "CopyItemdetails_CopyItemdetails", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CopyItemdetailsCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Itemdetails successfully copied to the specified items.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/Countries/QueryCountries": { "get": { "tags": [ "CountryQuery" ], "summary": "Definition to query countries", "operationId": "Country_QueryCountries", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "system.config.read" ] }, { "oauth2-client-credentials": [ "system.config.read" ] } ], "x-stability-level": "alpha" } }, "/v2/CreateCategory": { "post": { "tags": [ "CategoryCommand" ], "summary": "Creates a new Category.", "operationId": "Category_CreateCategory", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Category.CreateCategoryCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Category was successfully created", "content": { "application/json": {} } }, "404": { "description": "Error while creating category.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/creditNotes/{creditNoteId}/output/mail": { "post": { "tags": [ "creditnote" ], "summary": "Mail Credit Note", "description": "Execute the mailing of a CreditNote", "operationId": "CreditNote_MailCreditNoteAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "formId", "in": "query", "description": "Gets the unique identifier for the form (Formular) entity.\n ", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FormularKey" }, "x-position": 1 }, { "name": "creditNoteId", "in": "path", "required": true, "description": "The id of the sales order for that the mail to start.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.GutschriftKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "The MailJob is created", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesinvoicecorrections.read" ] }, { "oauth2-client-credentials": [ "salesinvoicecorrections.read" ] } ], "x-sort": 5010, "x-stability-level": "beta" } }, "/v2/creditNotes/{creditNoteId}/output/pdf": { "post": { "tags": [ "creditnote" ], "summary": "Pdf Credit Note", "description": "Execute the pdf creation of a CreditNote", "operationId": "CreditNote_PdfCreditNoteAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "formId", "in": "query", "description": "Gets the unique identifier for the form (Formular) entity.\n ", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FormularKey" }, "x-position": 1 }, { "name": "creditNoteId", "in": "path", "required": true, "description": "The id of the sales order for that the creation of a pdf to start.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.GutschriftKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The Filestream of the Created PDF", "content": { "application/json": { "schema": { "type": "string", "format": "byte" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesinvoicecorrections.read" ] }, { "oauth2-client-credentials": [ "salesinvoicecorrections.read" ] } ], "x-sort": 5010, "x-stability-level": "beta" } }, "/v2/creditNotes/{creditNoteId}/output/print": { "post": { "tags": [ "creditnote" ], "summary": "Print Credit Note", "description": "Execute the printing of a CreditNote", "operationId": "CreditNote_PrintCreditNoteAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "formId", "in": "query", "description": "Gets the unique identifier for the form (Formular) entity.\n ", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FormularKey" }, "x-position": 1 }, { "name": "printer", "in": "query", "description": "The target printer to print. The printer is Mandatory, if no User with Own Printer Configuration Available.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "creditNoteId", "in": "path", "required": true, "description": "The id of the sales order for that the print to start.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.GutschriftKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "The Printjob is created", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesinvoicecorrections.print" ] }, { "oauth2-client-credentials": [ "salesinvoicecorrections.print" ] } ], "x-sort": 5010, "x-stability-level": "beta" } }, "/v2/customer/{CustomerId}": { "get": { "tags": [ "CustomerDomainQuery" ], "summary": "Delivers a single customer by its id", "operationId": "CustomerDomain_GetCustomerById", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "CustomerId", "x-originalName": "customerId", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "customers.read" ] }, { "oauth2-client-credentials": [ "customers.read" ] } ], "x-stability-level": "alpha" } }, "/v2/customer/create": { "post": { "tags": [ "CustomerDomainCommand" ], "summary": "Creates a customer", "operationId": "CustomerDomain_CreateCustomer", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Customers.PublicApi.DataTransferObjects.V2.CustomerDomain.CreateCustomerCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Customer created successfully", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-stability-level": "alpha" } }, "/v2/customer/update": { "patch": { "tags": [ "CustomerDomainCommand" ], "summary": "Updates a customer", "operationId": "CustomerDomain_UpdateCustomer", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Customers.PublicApi.DataTransferObjects.V2.CustomerDomain.UpdateCustomerCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Customer changed successfully", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-stability-level": "alpha" } }, "/v2/customerCategories": { "get": { "tags": [ "customerCategory" ], "summary": "Query Customer Categories", "description": "Query all customer categories", "operationId": "CustomerCategory_QueryCustomerCategoriesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all customer categories.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.CustomerCategory.CustomerCategory" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "customers.read" ] }, { "oauth2-client-credentials": [ "customers.read" ] } ], "x-sort": 0, "x-stability-level": "stable" }, "post": { "tags": [ "customerCategory" ], "summary": "Create Customer Category", "description": "Create a new customer category", "operationId": "CustomerCategory_CreateCustomerCategoryAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "customerCategory", "description": "The customer category to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.CustomerCategory.CreateCustomerCategory" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created customer category.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.CustomerCategory.CustomerCategory" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/customerCategories/{customercategoryId}": { "get": { "tags": [ "customerCategory" ], "summary": "Get Customer Category", "description": "Get a specific customercategory", "operationId": "CustomerCategory_GetCustomerCategoryAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customercategoryId", "in": "path", "required": true, "description": "The id of the Customercategory to return.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenKategorieKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the customercategory for the given id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.CustomerCategory.CustomerCategory" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customercategory with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.read" ] }, { "oauth2-client-credentials": [ "customers.read" ] } ], "x-sort": 200, "x-stability-level": "stable" }, "patch": { "tags": [ "customerCategory" ], "summary": "Update Customer Category", "description": "Update a specific customer category", "operationId": "CustomerCategory_UpdateCustomerCategoryAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customercategoryId", "in": "path", "required": true, "description": "The id of the Customer category to update.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenKategorieKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "customerCategory", "description": "The customer category to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.CustomerCategory.UpdateCustomerCategory" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The updated customer category.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.CustomerCategory.CustomerCategory" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customer category with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 0, "x-stability-level": "stable" }, "delete": { "tags": [ "customerCategory" ], "summary": "Delete Customer Category", "description": "Delete a specific customercategory", "operationId": "CustomerCategory_DeleteCustomerCategoryAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customercategoryId", "in": "path", "required": true, "description": "The id of the Customercategory to delete.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenKategorieKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customercategory with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 200, "x-stability-level": "stable" } }, "/v2/customerGroups": { "get": { "tags": [ "customerGroup" ], "summary": "Query Customer Groups", "description": "Query all customer groups", "operationId": "CustomerGroup_QueryCustomerGroupsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all customer groups.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.CustomerGroup.CustomerGroup" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "customers.read" ] }, { "oauth2-client-credentials": [ "customers.read" ] } ], "x-sort": 0, "x-stability-level": "stable" }, "post": { "tags": [ "customerGroup" ], "summary": "Create Customer Group", "description": "Create a new customer group", "operationId": "CustomerGroup_CreateCustomerGroupAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "customerGroup", "description": "The customer group to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.CustomerGroup.CreateCustomerGroup" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created customer group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.CustomerGroup.CustomerGroup" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/customerGroups/{customergroupId}": { "get": { "tags": [ "customerGroup" ], "summary": "Get Customer Group", "description": "Get a specific customergroup", "operationId": "CustomerGroup_GetCustomerGroupAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customergroupId", "in": "path", "required": true, "description": "The id of the Customergroup to return.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the customergroup for the given id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.CustomerGroup.CustomerGroup" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customergroup with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.read" ] }, { "oauth2-client-credentials": [ "customers.read" ] } ], "x-sort": 200, "x-stability-level": "stable" }, "patch": { "tags": [ "customerGroup" ], "summary": "Update Customer Group", "description": "Update a specific customer group", "operationId": "CustomerGroup_UpdateCustomerGroupAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customergroupId", "in": "path", "required": true, "description": "The id of the Customer group to update.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "customerGroup", "description": "The customer to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.CustomerGroup.UpdateCustomerGroup" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The updated customer group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.CustomerGroup.CustomerGroup" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customer group with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 0, "x-stability-level": "stable" }, "delete": { "tags": [ "customerGroup" ], "summary": "Delete Customer Group", "description": "Delete a specific customergroup", "operationId": "CustomerGroup_DeleteCustomerGroupAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customergroupId", "in": "path", "required": true, "description": "The id of the customergroup to delete", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customergroup with the given ID exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/customers": { "get": { "tags": [ "customer" ], "summary": "Query Customers", "description": "Query all customers", "operationId": "Customer_QueryCustomersAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "searchKeyWord", "in": "query", "description": "All Search Keywords for the customer, like the number and the most important fields from the billing address.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "number", "in": "query", "description": "Search for a specific customer number.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "groupId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "x-position": 3 }, { "name": "categoryId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenKategorieKey" }, "x-position": 4 }, { "name": "lastChangeFrom", "in": "query", "description": "All customers where the last change happened after or equal the given time", "schema": { "type": "string", "format": "date-time" }, "x-position": 5 }, { "name": "lastChangeTo", "in": "query", "description": "All customers where the last change happened before or equal the given time", "schema": { "type": "string", "format": "date-time" }, "x-position": 6 }, { "name": "pageNumber", "in": "query", "description": "Number of the page of items to fetch.", "schema": { "type": "integer", "format": "int32" }, "x-position": 7 }, { "name": "pageSize", "in": "query", "description": "Size of the page that is specified by `pageNumber`.", "schema": { "type": "integer", "format": "int32" }, "x-position": 8 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all customer, can be filtered by searchKeyWord or categoryId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Customer.Customer" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "all.read", "cusomters.read", "customers.read" ] }, { "oauth2-client-credentials": [ "all.read", "cusomters.read", "customers.read" ] } ], "x-sort": 100, "x-stability-level": "stable" }, "post": { "tags": [ "customer" ], "summary": "Create Customer", "description": "Create a new customer", "operationId": "Customer_CreateCustomerAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "disableAutomaticWorkflows", "in": "query", "description": "If true, the workflows do not trigger automatic.", "schema": { "type": "boolean" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "customer", "description": "The customer to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.CreateCustomer" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created customer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.Customer" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 210, "x-stability-level": "stable" } }, "/v2/customers/{customerId}": { "get": { "tags": [ "customer" ], "summary": "Get Customer", "description": "Get a specific customer", "operationId": "Customer_GetCustomerAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the Customer to return.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the customer for the given id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.Customer" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customer with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "all.read", "cusomters.read", "customers.read" ] }, { "oauth2-client-credentials": [ "all.read", "cusomters.read", "customers.read" ] } ], "x-sort": 200, "x-stability-level": "stable" }, "patch": { "tags": [ "customer" ], "summary": "Update Customer", "description": "Update a specific customer", "operationId": "Customer_UpdateCustomerAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "disableAutomaticWorkflows", "in": "query", "description": "If true, the workflows do not trigger automatic.", "schema": { "type": "boolean" }, "x-position": 2 }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the Customer to update.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "customer", "description": "The customer to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.UpdateCustomer" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The updated customer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.Customer" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customer with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 220, "x-stability-level": "stable" }, "delete": { "tags": [ "customer" ], "summary": "Delete Customer", "description": "Delete a specific customer", "operationId": "Customer_DeleteCustomerAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer to delete", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customer with the given ID exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 230, "x-stability-level": "stable" } }, "/v2/customers/{customerId}/bankaccounts": { "get": { "tags": [ "customer" ], "summary": "Query Customer Bank Accounts", "description": "Query all bank accounts for a specific customer", "operationId": "Customer_QueryCustomerBankAccountsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the bank accounts belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested bank account of the customer.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.CustomerBankAccount" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No data could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.read" ] }, { "oauth2-client-credentials": [ "customers.read" ] } ], "x-sort": 500, "x-stability-level": "stable" }, "post": { "tags": [ "customer" ], "summary": "Create Customer Bank Account", "description": "Create a new bank account for a specific customer", "operationId": "Customer_CreateCustomerBankAccountAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the bank accounts belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "customerBankAccount", "description": "The bank account of the customer to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.CreateCustomerBankAccount" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created bank account of the customer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.CustomerBankAccount" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 510, "x-stability-level": "stable" } }, "/v2/customers/{customerId}/bankaccounts/{customerBankAccountId}": { "get": { "tags": [ "customer" ], "summary": "Get Customer Bank Account", "description": "Get a specific bank account", "operationId": "Customer_GetCustomerBankAccountAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the bank accounts belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 1 }, { "name": "customerBankAccountId", "in": "path", "required": true, "description": "The id of the customer bank account.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KontoDatenKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the customer bankaccount for the given id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.CustomerBankAccount" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customer bank account with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.read" ] }, { "oauth2-client-credentials": [ "customers.read" ] } ], "x-sort": 505, "x-stability-level": "stable" }, "patch": { "tags": [ "customer" ], "summary": "Update Customer Bank Account", "description": "Update a specific bank account", "operationId": "Customer_UpdateCustomerBankAccountAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the bank accounts belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 2 }, { "name": "customerBankAccountId", "in": "path", "required": true, "description": "The id of the customer bank account.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KontoDatenKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "customerBankAccount", "description": "The customer bank account to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.UpdateCustomerBankAccount" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customer bank account with the given ID exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 520, "x-stability-level": "stable" }, "delete": { "tags": [ "customer" ], "summary": "Delete Customer Bank Account", "description": "Delete a specific bank account", "operationId": "Customer_DeleteCustomerBankAccountAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the bank accounts belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 1 }, { "name": "customerBankAccountId", "in": "path", "required": true, "description": "The id of the customer bank account.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KontoDatenKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customer bank account with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 530, "x-stability-level": "stable" } }, "/v2/customers/{customerId}/contacts": { "get": { "tags": [ "customer" ], "summary": "Query Customer Contacts", "description": "Query all contacts for a specific customer", "operationId": "Customer_QueryCustomerContactsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the contacts belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested contacts of the customer.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.CustomerContact" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No data could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.read" ] }, { "oauth2-client-credentials": [ "customers.read" ] } ], "x-sort": 400, "x-stability-level": "stable" }, "post": { "tags": [ "customer" ], "summary": "Create Customer Contact", "description": "Create a new customer contact", "operationId": "Customer_CreateCustomerContactAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the contacts belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "customerContact", "description": "The contact of the customer to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.CreateCustomerContact" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created contact of the customer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.CustomerContact" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 410, "x-stability-level": "stable" } }, "/v2/customers/{customerId}/contacts/{customerContactId}": { "get": { "tags": [ "customer" ], "summary": "Get Customer Contact", "description": "Get a specific contact from a customer", "operationId": "Customer_GetCustomerContactAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the notes belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 1 }, { "name": "customerContactId", "in": "path", "required": true, "description": "The id of the customer contact.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AnsprechpartnerKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the customer contact for the given id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.CustomerContact" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No concact with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.read" ] }, { "oauth2-client-credentials": [ "customers.read" ] } ], "x-sort": 405, "x-stability-level": "stable" }, "patch": { "tags": [ "customer" ], "summary": "Update Customer Contact", "description": "Update a specific customer contact", "operationId": "Customer_UpdateCustomerContactAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the contacts belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 2 }, { "name": "customerContactId", "in": "path", "required": true, "description": "The id of the customer contact.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AnsprechpartnerKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "customerContact", "description": "The customer contact to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.UpdateCustomerContact" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customer contact with the given ID exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 420, "x-stability-level": "stable" }, "delete": { "tags": [ "customer" ], "summary": "Delete Customer Contact", "description": "Delete a specific customer concact", "operationId": "Customer_DeleteCustomerContactAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the contacts belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 1 }, { "name": "customerContactId", "in": "path", "required": true, "description": "The id of the customer contact.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AnsprechpartnerKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customer contact with the given ID exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 430, "x-stability-level": "stable" } }, "/v2/customers/{customerId}/customfields": { "get": { "tags": [ "customer" ], "summary": "Query Customer Custom Field Values", "description": "Query all custom fields and corresponding values for a specific customer", "operationId": "Customer_QueryCustomerCustomFieldValuesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the custom field belongs to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested custom fields values for a customer .", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CustomFieldValue" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.read" ] }, { "oauth2-client-credentials": [ "customers.read" ] } ], "x-sort": 710, "x-stability-level": "stable" } }, "/v2/customers/{customerId}/customfields/{customfieldId}": { "patch": { "tags": [ "customer" ], "summary": "Update Customer Custom Field", "description": "Update the value of a specific custom field for a given customer", "operationId": "Customer_UpdateCustomerCustomFieldAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the custom field belongs to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 2 }, { "name": "customfieldId", "in": "path", "required": true, "description": "The id of the customfield that should be updated.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EigenesFeldKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "customFieldValue", "description": "The custom field value.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateCustomFieldValue" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customer with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 720, "x-stability-level": "stable" }, "delete": { "tags": [ "customer" ], "summary": "Delete Customer Custom Field", "description": "Delete the value for a specific customer field for a given customer", "operationId": "Customer_DeleteCustomerCustomFieldAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the custom field belongs to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 1 }, { "name": "customfieldId", "in": "path", "required": true, "description": "The id of the custom field that should be deleted.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EigenesFeldKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customer with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 730, "x-stability-level": "stable" } }, "/v2/customers/{customerId}/lastChange": { "get": { "tags": [ "customer" ], "summary": "Get Customer Last Change", "description": "Get the date of the last change for a customer", "operationId": "Customer_GetCustomerLastChangeAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the notes belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the customer's last change date for the given id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.LastChange" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No data could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.read" ] }, { "oauth2-client-credentials": [ "customers.read" ] } ], "x-sort": 640, "x-stability-level": "beta" } }, "/v2/customers/{customerId}/notes": { "get": { "tags": [ "customer" ], "summary": "Query Customer Notes", "description": "Query all notes for a specific customer", "operationId": "Customer_QueryCustomerNotesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the notes belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested notes of the customer.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Note" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No data could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.read" ] }, { "oauth2-client-credentials": [ "customers.read" ] } ], "x-sort": 600, "x-stability-level": "stable" }, "post": { "tags": [ "customer" ], "summary": "Create Customer Note", "description": "Create a new note for a specific customer", "operationId": "Customer_CreateCustomerNoteAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the notes belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "note", "description": "The note of the customer to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateNote" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created note of the customer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Note" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 610, "x-stability-level": "stable" } }, "/v2/customers/{customerId}/notes/{noteId}": { "patch": { "tags": [ "customer" ], "summary": "Update Customer Note", "description": "Update a specific note for a customer", "operationId": "Customer_UpdateCustomerNoteAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the notes belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 2 }, { "name": "noteId", "in": "path", "required": true, "description": "The id of the customer note.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.NotizKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "note", "description": "The note to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateNote" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No note with the given ID exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 620, "x-stability-level": "stable" }, "delete": { "tags": [ "customer" ], "summary": "Delete Customer Note", "description": "Delete a specific note for a customer", "operationId": "Customer_DeleteCustomerNoteAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the notes belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 1 }, { "name": "noteId", "in": "path", "required": true, "description": "The id of the customer note.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.NotizKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No note with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 630, "x-stability-level": "stable" }, "get": { "tags": [ "customer" ], "summary": "Get Customer Note", "description": "Get a specific note from a customer", "operationId": "Customer_GetCustomerNoteAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer that the notes belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 1 }, { "name": "noteId", "in": "path", "required": true, "description": "The id of the customer note.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.NotizKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the customer for the given id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Note" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No note with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.read" ] }, { "oauth2-client-credentials": [ "customers.read" ] } ], "x-sort": 630, "x-stability-level": "stable" } }, "/v2/customers/{customerId}/workflow/{workflowEventId}": { "post": { "tags": [ "customer" ], "summary": "Trigger Customer Workflow", "description": "Trigger a specific workflow event for a given customer", "operationId": "Customer_TriggerCustomerWorkflowAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "workflowEventId", "in": "path", "required": true, "description": "The id of the Event for that the manual workflow event should be started.", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.CustomerWorkflowEvent" }, "x-position": 1 }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer for that the manual workflow event should be started.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 5010, "x-stability-level": "stable" } }, "/v2/customers/{customerId}/workflowEvents": { "post": { "tags": [ "customer" ], "summary": "Trigger Customer Workflow Event", "description": "Trigger a specific workflow event for a given customer", "operationId": "Customer_TriggerCustomerWorkflowEventAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "customerId", "in": "path", "required": true, "description": "The id of the customer for that the manual workflow event should be started.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "workflowEvent", "description": "The workflow event.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateWorkflowEvent" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "customers.write" ] }, { "oauth2-client-credentials": [ "customers.write" ] } ], "x-sort": 2010, "x-stability-level": "stable" } }, "/v2/customers/customfields": { "get": { "tags": [ "customer" ], "summary": "Query Customer Custom Fields", "description": "Query all custom fields available for a customer", "operationId": "Customer_QueryCustomerCustomFieldsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested custom fields for items.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CustomField" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.read" ] }, { "oauth2-client-credentials": [ "customers.read" ] } ], "x-sort": 700, "x-stability-level": "stable" } }, "/v2/customers/workflowEvents": { "get": { "tags": [ "customer" ], "summary": "Query Customer Workflow Events", "description": "Query all workflow events for customers", "operationId": "Customer_QueryCustomerWorkflowEventsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "All manual workflow events for customers that could be used to trigger workflow events via REST-API.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.WorkflowEvent" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "customers.read" ] }, { "oauth2-client-credentials": [ "customers.read" ] } ], "x-sort": 2000, "x-stability-level": "stable" } }, "/v2/DeleteCategory": { "delete": { "tags": [ "CategoryCommand" ], "summary": "Delete a Category", "operationId": "Category_DeleteCategory", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Category.DeleteCategoryCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully deleted category.", "content": { "application/json": {} } }, "404": { "description": "Category not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "500": { "description": "Interanl server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/deliveryNotes": { "get": { "tags": [ "deliverynote" ], "summary": "Query Delivery Notes", "description": "Query all delivery notes", "operationId": "DeliveryNote_QueryDeliveryNotesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderNumber", "in": "query", "description": "Search for a specific sales order number.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "salesOrderNumberId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "customerId", "in": "query", "description": "Gets the unique identifier for the customer.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 3 }, { "name": "IsExisting", "in": "query", "description": "Gets a value indicating whether the customer key represents an existing customer.", "schema": { "type": "boolean" }, "x-position": 4 }, { "name": "pageNumber", "in": "query", "description": "Number of the page of items to fetch.", "schema": { "type": "integer", "format": "int32" }, "x-position": 5 }, { "name": "pageSize", "in": "query", "description": "Size of the page that is specified by `pageNumber`.", "schema": { "type": "integer", "format": "int32" }, "x-position": 6 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all non-pending delivery notes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.DeliveryNote.DeliveryNote" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "deliverynotes.read" ] }, { "oauth2-client-credentials": [ "deliverynotes.read" ] } ], "x-sort": 100, "x-stability-level": "draft" } }, "/v2/deliveryNotes/{deliveryNoteId}": { "get": { "tags": [ "deliverynote" ], "summary": "Get Delivery Note", "description": "Get a specific delivery note", "operationId": "DeliveryNote_GetDeliveryNoteAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "deliveryNoteId", "in": "path", "required": true, "description": "The id of the delivery note.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferscheinKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the delivery note for the given id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.DeliveryNote.DeliveryNote" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No delivery note order with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "deliverynotes.read" ] }, { "oauth2-client-credentials": [ "deliverynotes.read" ] } ], "x-sort": 200, "x-stability-level": "draft" } }, "/v2/deliveryNotes/{deliveryNoteId}/output/mail": { "post": { "tags": [ "deliverynote" ], "summary": "Mail Delivery Note", "description": "Execute the mailing of a DeliveryNote", "operationId": "DeliveryNote_MailDeliveryNoteAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "formId", "in": "query", "description": "Gets the unique identifier for the form (Formular) entity.\n ", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FormularKey" }, "x-position": 1 }, { "name": "deliveryNoteId", "in": "path", "required": true, "description": "The id of the sales order for that the mail to start.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferscheinKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "The MailJob is created", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "deliverynotes.read" ] }, { "oauth2-client-credentials": [ "deliverynotes.read" ] } ], "x-sort": 5010, "x-stability-level": "stable" } }, "/v2/deliveryNotes/{deliveryNoteId}/output/pdf": { "post": { "tags": [ "deliverynote" ], "summary": "Pdf Delivery Note", "description": "Execute the pdf creation of a DeliveryNote", "operationId": "DeliveryNote_PdfDeliveryNoteAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "formId", "in": "query", "description": "Gets the unique identifier for the form (Formular) entity.\n ", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FormularKey" }, "x-position": 1 }, { "name": "deliveryNoteId", "in": "path", "required": true, "description": "The id of the sales order for that the creation of a pdf to start.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferscheinKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The Filestream of the Created PDF", "content": { "application/json": { "schema": { "type": "string", "format": "byte" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "deliverynotes.read" ] }, { "oauth2-client-credentials": [ "deliverynotes.read" ] } ], "x-sort": 5010, "x-stability-level": "stable" } }, "/v2/deliveryNotes/{deliveryNoteId}/output/print": { "post": { "tags": [ "deliverynote" ], "summary": "Print Delivery Note", "description": "Execute the printing of a DeliveryNote", "operationId": "DeliveryNote_PrintDeliveryNoteAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "formId", "in": "query", "description": "Gets the unique identifier for the form (Formular) entity.\n ", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FormularKey" }, "x-position": 1 }, { "name": "printer", "in": "query", "description": "The target printer to print. The printer is Mandatory, if no User with Own Printer Configuration Available.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "deliveryNoteId", "in": "path", "required": true, "description": "The id of the sales order for that the print to start.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferscheinKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "The Printjob is created", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "deliverynotes.print" ] }, { "oauth2-client-credentials": [ "deliverynotes.print" ] } ], "x-sort": 5010, "x-stability-level": "stable" } }, "/v2/deliveryNotes/{deliveryNoteId}/packages": { "get": { "tags": [ "deliverynote" ], "summary": "Get Delivery Note Packages", "description": "Get all packages for a specific delivery note", "operationId": "DeliveryNote_GetDeliveryNotePackagesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "deliveryNoteId", "in": "path", "required": true, "description": "The id of the delivery note.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferscheinKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the delivery note for the given id.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.DeliveryNote.DeliveryNotePackage" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No delivery note order with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "deliverynotes.read" ] }, { "oauth2-client-credentials": [ "deliverynotes.read" ] } ], "x-sort": 200, "x-stability-level": "draft" }, "post": { "tags": [ "deliverynote" ], "summary": "Post Package Data For Delivery Note", "description": "Transmit Package Data", "operationId": "DeliveryNote_PostPackageDataForDeliveryNoteAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "deliveryNoteId", "in": "path", "required": true, "description": "The id of the delivery note.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferscheinKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "package", "description": "The Packages to Create", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.DeliveryNote.CreateDeliveryNotePackagePosting" } } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Returns All packages that are created for the delivery note.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.DeliveryNote.DeliveryNotePackage" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No delivery note order with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "deliverynotes.write" ] }, { "oauth2-client-credentials": [ "deliverynotes.write" ] } ], "x-sort": 200, "x-stability-level": "draft" } }, "/v2/deliveryNotes/{deliveryNoteId}/workflow/{workflowEventId}": { "post": { "tags": [ "deliverynote" ], "summary": "Trigger Delivery Note Workflow", "description": "Trigger a specific workflow event for a given delivery Note", "operationId": "DeliveryNote_TriggerDeliveryNoteWorkflowAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "workflowEventId", "in": "path", "required": true, "description": "The id of the Event for that the manual workflow event should be started.", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.DeliveryNote.DeliveryNoteWorkflowEvent" }, "x-position": 1 }, { "name": "deliveryNoteId", "in": "path", "required": true, "description": "The id of the delivery Note for that the manual workflow event should be started.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferscheinKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "deliverynotes.write" ] }, { "oauth2-client-credentials": [ "deliverynotes.write" ] } ], "x-sort": 5010, "x-stability-level": "stable" } }, "/v2/deliveryNotes/packages/{packageId}": { "patch": { "tags": [ "deliverynote" ], "summary": "Patch Package Data", "description": "Transmit Package Data", "operationId": "DeliveryNote_PatchPackageDataAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "packageId", "in": "path", "required": true, "description": "The id of the package.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "package", "description": "The Package to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.DeliveryNote.UpdateDeliveryNotePackagePosting" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Returns the package that are created for the delivery note.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.DeliveryNote.DeliveryNotePackage" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No delivery note order with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "deliverynotes.write" ] }, { "oauth2-client-credentials": [ "deliverynotes.write" ] } ], "x-sort": 200, "x-stability-level": "draft" } }, "/v2/DuplicateItems": { "post": { "tags": [ "DuplicateItemCommand" ], "summary": "Creates one or more duplicates of an existing item with specified duplication options.", "operationId": "DuplicateItem_DuplicateItems", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.DuplicateItemsCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Items successfully duplicated", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/extensions": { "get": { "tags": [ "Extensibility" ], "summary": "Get Extensions", "description": "Returns the installed Extensions", "operationId": "Extensibility_GetExtensionsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "pageNumber", "in": "query", "description": "Number of the page of items to fetch.", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "pageSize", "in": "query", "description": "Size of the page that is specified by `pageNumber`.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The installed Extensions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Extensibility.Extension" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "extensibility.integration" ] }, { "oauth2-client-credentials": [ "extensibility.integration" ] } ], "x-sort": 0, "x-stability-level": "draft" }, "post": { "tags": [ "Extensibility" ], "summary": "Create Extension", "description": "Create a new Extension and Validate the Signature of the Manifest", "operationId": "Extensibility_CreateExtensionAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "item", "description": "The relevant Information of the Extension", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Extensibility.CreateExtension" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The new Created Extension", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Extensibility.Extension" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "extensibility.integration" ] }, { "oauth2-client-credentials": [ "extensibility.integration" ] } ], "x-sort": 0, "x-stability-level": "draft" } }, "/v2/extensions/{extensionId}": { "get": { "tags": [ "Extensibility" ], "summary": "Get Extension", "description": "Returns the requested Extension", "operationId": "Extensibility_GetExtensionAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "extensionId", "in": "path", "required": true, "description": "The uuid of the Extension", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Extensibility.Core.Contracts.Domain.Keys.ExtensionKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested Extension", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Extensibility.Extension" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No item with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "extensibility.integration" ] }, { "oauth2-client-credentials": [ "extensibility.integration" ] } ], "x-sort": 0, "x-stability-level": "draft" }, "patch": { "tags": [ "Extensibility" ], "summary": "Update Extension", "description": "Updates an Existing Extension", "operationId": "Extensibility_UpdateExtensionAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "extensionId", "in": "path", "required": true, "description": "The id of the Extension", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Extensibility.Core.Contracts.Domain.Keys.ExtensionKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "item", "description": "The relevant Information of the Extension", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Extensibility.UpdateExtension" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "The changed Extension", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Extensibility.Extension" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No item with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "extensibility.integration" ] }, { "oauth2-client-credentials": [ "extensibility.integration" ] } ], "x-sort": 0, "x-stability-level": "draft" }, "delete": { "tags": [ "Extensibility" ], "summary": "Delete Extension", "description": "DELETE an existing Extension", "operationId": "Extensibility_DeleteExtensionAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "extensionId", "in": "path", "required": true, "description": "The id of the Extension", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Extensibility.Core.Contracts.Domain.Keys.ExtensionKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The Extension is deleted", "content": { "application/json": {} } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No item with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "extensibility.integration" ] }, { "oauth2-client-credentials": [ "extensibility.integration" ] } ], "x-sort": 0, "x-stability-level": "draft" } }, "/v2/extensions/{extensionId}/manifest": { "put": { "tags": [ "Extensibility" ], "summary": "Put Extension Manifest", "description": "Push the Extension Manifest", "operationId": "Extensibility_PutExtensionManifestAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "extensionId", "in": "path", "required": true, "description": "The id of the Extension", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Extensibility.Core.Contracts.Domain.Keys.ExtensionKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "manifest", "description": "The Manifest of the Extension", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Extensibility.PutExtensionManifest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "The changed Extension", "content": { "application/json": {} } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No item with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "412": { "description": "The signature is Invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "extensibility.integration" ] }, { "oauth2-client-credentials": [ "extensibility.integration" ] } ], "x-sort": 0, "x-stability-level": "draft" } }, "/v2/feature": { "get": { "tags": [ "features" ], "summary": "Get Features", "description": "Returns the available feature sets with release state and API version", "operationId": "Features_GetFeaturesAsync", "responses": { "200": { "description": "The available features with release state and API version.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Features.FeatureInfo" } } } } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-sort": 0, "x-stability-level": "stable", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." } ] } }, "/v2/info": { "get": { "tags": [ "info" ], "summary": "Get Status", "description": "Returns the status of the API", "operationId": "Info_GetStatusAsync", "responses": { "200": { "description": "Status of the API.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Info.Status" } } } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-sort": 0, "x-stability-level": "stable", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." } ] } }, "/v2/invoices": { "get": { "tags": [ "invoice" ], "summary": "Query Invoices", "description": "Query all Invoices", "operationId": "Invoice_QueryInvoicesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderNumber", "in": "query", "description": "Search for a specific sales order number.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "externalOrderNumber", "in": "query", "description": "Search for a specific external order number.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "invoiceNumber", "in": "query", "description": "Search for a specific invoice number.", "schema": { "type": "string" }, "x-position": 3 }, { "name": "itemId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "x-position": 4 }, { "name": "customerId", "in": "query", "description": "Gets the unique identifier for the customer.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 5 }, { "name": "IsExisting", "in": "query", "description": "Gets a value indicating whether the customer key represents an existing customer.", "schema": { "type": "boolean" }, "x-position": 6 }, { "name": "paymentStatus", "in": "query", "description": "Search for a specific payment status.", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoicePaymentStatus" }, "x-position": 7 }, { "name": "isExternalInvoice", "in": "query", "description": "Search only for external invoices", "schema": { "type": "boolean" }, "x-position": 8 }, { "name": "pageNumber", "in": "query", "description": "Number of the page of items to fetch.", "schema": { "type": "integer", "format": "int32" }, "x-position": 9 }, { "name": "pageSize", "in": "query", "description": "Size of the page that is specified by `pageNumber`.", "schema": { "type": "integer", "format": "int32" }, "x-position": 10 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all non-pending sales orders.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Invoice.Invoice" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "invoices.read" ] }, { "oauth2-client-credentials": [ "invoices.read" ] } ], "x-sort": 100, "x-stability-level": "draft" } }, "/v2/invoices/{invoiceId}": { "get": { "tags": [ "invoice" ], "summary": "Get Invoice", "description": "Get a specific invoice", "operationId": "Invoice_GetInvoiceAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "invoiceId", "in": "path", "required": true, "description": "The ID of the invoice to return.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the invoice for the given ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Invoice.Invoice" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No invoice with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "invoices.read" ] }, { "oauth2-client-credentials": [ "invoices.read" ] } ], "x-sort": 200, "x-stability-level": "draft" } }, "/v2/invoices/{invoiceId}/lineitems": { "get": { "tags": [ "invoice" ], "summary": "Query Invoice Line Items", "description": "Query all line items for a specific invoice", "operationId": "Invoice_QueryInvoiceLineItemsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "invoiceId", "in": "path", "required": true, "description": "The ID of the invoice that the line items belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested line items.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceLineItem" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No invoice line items could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "invoices.read" ] }, { "oauth2-client-credentials": [ "invoices.read" ] } ], "x-sort": 300, "x-stability-level": "draft" } }, "/v2/invoices/{invoiceId}/output/mail": { "post": { "tags": [ "invoice" ], "summary": "Mail Invoice", "description": "Execute the mailing of a Invoice", "operationId": "Invoice_MailInvoiceAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "formId", "in": "query", "description": "Gets the unique identifier for the form (Formular) entity.\n ", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FormularKey" }, "x-position": 1 }, { "name": "invoiceId", "in": "path", "required": true, "description": "The id of the sales invoice for that the mail to start.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "The MailJob is created", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "invoices.read" ] }, { "oauth2-client-credentials": [ "invoices.read" ] } ], "x-sort": 5010, "x-stability-level": "beta" } }, "/v2/invoices/{invoiceId}/output/pdf": { "post": { "tags": [ "invoice" ], "summary": "Pdf Invoice", "description": "Execute the pdf creation of a Invoice", "operationId": "Invoice_PdfInvoiceAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "formId", "in": "query", "description": "Gets the unique identifier for the form (Formular) entity.\n ", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FormularKey" }, "x-position": 1 }, { "name": "invoiceId", "in": "path", "required": true, "description": "The id of the sales invoice for that the creation of a pdf to start.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The Filestream of the Created PDF", "content": { "application/json": { "schema": { "type": "string", "format": "byte" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "invoices.read" ] }, { "oauth2-client-credentials": [ "invoices.read" ] } ], "x-sort": 5010, "x-stability-level": "beta" } }, "/v2/invoices/{invoiceId}/output/print": { "post": { "tags": [ "invoice" ], "summary": "Print Invoice", "description": "Execute the printing of a Invoice", "operationId": "Invoice_PrintInvoiceAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "formId", "in": "query", "description": "Gets the unique identifier for the form (Formular) entity.\n ", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FormularKey" }, "x-position": 1 }, { "name": "printer", "in": "query", "description": "The target printer to print. The printer is Mandatory, if no User with Own Printer Configuration Available.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "invoiceId", "in": "path", "required": true, "description": "The id of the sales invoice for that the print to start.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "The Printjob is created", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "invoices.print" ] }, { "oauth2-client-credentials": [ "invoices.print" ] } ], "x-sort": 5010, "x-stability-level": "beta" } }, "/v2/invoices/{invoiceId}/workflow/{workflowEventId}": { "post": { "tags": [ "invoice" ], "summary": "Trigger Invoice Workflow", "description": "Trigger a specific workflow event for a given invoice", "operationId": "Invoice_TriggerInvoiceWorkflowAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "workflowEventId", "in": "path", "required": true, "description": "The id of the Event for that the manual workflow event should be started.", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceWorkflowEvent" }, "x-position": 1 }, { "name": "invoiceId", "in": "path", "required": true, "description": "The ID of the invoice for which the manual workflow event should be started.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "invoices.write" ] }, { "oauth2-client-credentials": [ "invoices.write" ] } ], "x-sort": 5010, "x-stability-level": "stable" } }, "/v2/invoices/{invoiceId}/workflowEvents": { "post": { "tags": [ "invoice" ], "summary": "Trigger Invoice Workflow Event", "description": "Trigger a specific workflow event for a given invoice", "operationId": "Invoice_TriggerInvoiceWorkflowEventAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "invoiceId", "in": "path", "required": true, "description": "The ID of the invoice for which the manual workflow event should be started.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "workflowEvent", "description": "The workflow event.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateWorkflowEvent" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "invoices.write" ] }, { "oauth2-client-credentials": [ "invoices.write" ] } ], "x-sort": 2100, "x-stability-level": "draft" } }, "/v2/invoices/cancellationReasons": { "get": { "tags": [ "cancellationreason" ], "summary": "Query Invoice Cancellation Reasons", "description": "Query all cancellation reasons for invoices", "operationId": "Invoice_QueryInvoiceCancellationReasonsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all cancellation reasons for invoices", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceCancellationReason" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "invoices.read" ] }, { "oauth2-client-credentials": [ "invoices.read" ] } ], "x-sort": 0, "x-stability-level": "draft" } }, "/v2/invoices/workflowEvents": { "get": { "tags": [ "invoice" ], "summary": "Query Invoice Workflow Events", "description": "Query all available workflow events for invoices", "operationId": "Invoice_QueryInvoiceWorkflowEventsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "All manual workflow events for invoices that could be used to trigger workflow events via REST API.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.WorkflowEvent" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No events could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "invoices.read" ] }, { "oauth2-client-credentials": [ "invoices.read" ] } ], "x-sort": 2000, "x-stability-level": "draft" } }, "/v2/itemdetails/change": { "patch": { "tags": [ "ItemdetailsCommand" ], "summary": "Modifies an existing regular item with all specified properties. This command enables complete reconfiguration of an item including identifiers, descriptions, prices, measurements, and miscellaneous information.", "operationId": "Itemdetails_ChangeItem", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.ChangeItemCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Item was successfully modified.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/itemdetails/create": { "post": { "tags": [ "ItemdetailsCommand" ], "summary": "Creates a new regular item with all specified properties. This command enables complete configuration of an item including identifiers, descriptions, prices, and measurements.", "operationId": "Itemdetails_CreateItem", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Item was successfully created", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/itemdetails/suppliers/add": { "post": { "tags": [ "ItemdetailsCommand" ], "summary": "Adds supplier information to an existing regular item. This command allows the association of suppliers with the item, including details such as purchase prices, delivery times, and order intervals.", "operationId": "Itemdetails_AddItemSupplier", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.AddItemSupplierCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Supplier was successfully added to the item.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/itemdetails/variations/add": { "post": { "tags": [ "ItemdetailsCommand" ], "summary": "Adds a new variation (e.g., color, size) to an existing item. Variations allow customers to select different product options.", "operationId": "Itemdetails_AddItemVariation", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.AddItemVariationCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Variation was successfully added to the item.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/itemdetails/variations/delete": { "post": { "tags": [ "ItemdetailsCommand" ], "summary": "Removes an existing variation from an item. All associated variation values and combinations will also be removed.", "operationId": "Itemdetails_DeleteItemVariation", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.DeleteItemVariationCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Variation was successfully removed from the item.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/itemdetails/variationvalues/add": { "post": { "tags": [ "ItemdetailsCommand" ], "summary": "Adds a new value to an existing item variation.", "operationId": "Itemdetails_AddItemVariationValue", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.AddItemVariationValueCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "VariationValue was successfully added to the item.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/itemdetails/variationvalues/delete": { "post": { "tags": [ "ItemdetailsCommand" ], "summary": "Removes a specific value from an item variation.", "operationId": "Itemdetails_DeleteItemVariationValue", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.DeleteItemVariationValueCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "VariationValue was successfully removed from the item.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/items/{Id}": { "get": { "tags": [ "ItemdetailsQuery" ], "summary": "Retrieves a single article by its ID including all sub-elements", "operationId": "Itemdetails_GetItemById", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "Id", "x-originalName": "id", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.read" ] }, { "oauth2-client-credentials": [ "items.read" ] } ], "x-stability-level": "alpha" } }, "/v2/languages/activate": { "post": { "tags": [ "LanguagesCommand" ], "summary": "Activates a language in the system", "operationId": "Languages_ActivateLanguage", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Stammdaten.PublicApi.DataTransferObjects.V2.Languages.ActivateLanguageCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Language activated successfully", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "system.config.write" ] }, { "oauth2-client-credentials": [ "system.config.write" ] } ], "x-stability-level": "alpha" } }, "/v2/languages/deactivate": { "post": { "tags": [ "LanguagesCommand" ], "summary": "Deactivates a language in the system", "operationId": "Languages_DeactivateLanguage", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Stammdaten.PublicApi.DataTransferObjects.V2.Languages.DeactivateLanguageCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Language deactivated successfully", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "system.config.write" ] }, { "oauth2-client-credentials": [ "system.config.write" ] } ], "x-stability-level": "alpha" } }, "/v2/languages/QueryLanguages": { "get": { "tags": [ "LanguagesQuery" ], "summary": "Query for activated languages", "operationId": "Languages_QueryLanguages", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "system.config.read" ] }, { "oauth2-client-credentials": [ "system.config.read" ] } ], "x-stability-level": "alpha" } }, "/v2/lot-sizes/{id}": { "get": { "tags": [ "LotSizesQuery" ], "summary": "Retrieves a lot size by its ID.", "operationId": "LotSizes_QueryLotSizeById", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "id", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.LotSizeKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.read" ] }, { "oauth2-client-credentials": [ "pps.read" ] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Invoicing/ExcludeInvoiceCorrectionFromUpload": { "post": { "tags": [ "InvoicingCommand" ], "summary": "Exclude marketplace invoice corrections from upload.", "operationId": "Invoicing_ExcludeMarketplaceInvoiceCorrectionFromUpload", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Invoicing.ExcludeMarketplaceInvoiceCorrectionFromUploadCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully excluded invoice corrections from upload.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Invoicing/ExcludeInvoiceCorrectionPdfFromUpload": { "post": { "tags": [ "InvoicingCommand" ], "summary": "Exclude marketplace invoice correction PDFs from upload.", "operationId": "Invoicing_ExcludeMarketplaceInvoiceCorrectionPdfFromUpload", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Invoicing.ExcludeMarketplaceInvoiceCorrectionPdfFromUploadCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully excluded invoice correction PDFs from upload.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Invoicing/ExcludeInvoicePdfFromUpload": { "post": { "tags": [ "InvoicingCommand" ], "summary": "Exclude marketplace invoice PDFs from upload.", "operationId": "Invoicing_ExcludeMarketplaceInvoicePdfFromUpload", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Invoicing.ExcludeMarketplaceInvoicePdfFromUploadCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully excluded invoice PDFs from upload.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Invoicing/ResetInvoiceCorrectionPdfUploadCounter": { "post": { "tags": [ "InvoicingCommand" ], "summary": "Reset the upload counter for marketplace invoice correction PDFs.", "operationId": "Invoicing_ResetMarketplaceInvoiceCorrectionPdfUploadCounter", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Invoicing.ResetMarketplaceInvoiceCorrectionPdfUploadCounterCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully reset the upload counter for marketplace invoice correction PDFs.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Invoicing/ResetInvoiceCorrectionUploadCounter": { "post": { "tags": [ "InvoicingCommand" ], "summary": "Reset the upload counter for marketplace invoice corrections.", "operationId": "Invoicing_ResetMarketplaceInvoiceCorrectionUploadCounter", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Invoicing.ResetMarketplaceInvoiceCorrectionUploadCounterCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully reset the upload counter for marketplace invoice corrections.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Invoicing/ResetInvoicePdfPrinting": { "post": { "tags": [ "InvoicingCommand" ], "summary": "Resets PDF generation for marketplace invoices/invoice corrections so they can be reprinted and uploaded again.", "operationId": "Invoicing_ResetMarketplaceInvoicePdfPrinting", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Invoicing.ResetMarketplaceInvoicePdfPrintingCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully reset PDF generation for invoices/invoice corrections so they can be reprinted and uploaded again.", "content": { "application/json": {} } }, "400": { "description": "Bad request.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Offers/DeleteOffer": { "post": { "tags": [ "OffersCommand" ], "summary": "Deletes the specified marketplace offers.", "operationId": "Offers_DeleteMarketplaceOffer", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Offers.DeleteMarketplaceOfferCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully deleted the specified marketplace offers.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Offers/RemoveItemFromOffer": { "post": { "tags": [ "OffersCommand" ], "summary": "Removes the item assignment from the specified marketplace offers.", "operationId": "Offers_RemoveItemFromMarketplaceOffer", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Offers.RemoveItemFromMarketplaceOfferCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully removed item assignments from the specified marketplace offers.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Offers/SetOfferMaxQuantity": { "post": { "tags": [ "OffersCommand" ], "summary": "Sets the maximum stock quantity for the specified marketplace offers.", "operationId": "Offers_SetMarketplaceOfferMaxQuantity", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Offers.SetMarketplaceOfferMaxQuantityCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully updated maximum stock quantity for the specified marketplace offers.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Offers/SetOfferMinQuantity": { "post": { "tags": [ "OffersCommand" ], "summary": "Sets the minimum stock quantity for the specified marketplace offers.", "operationId": "Offers_SetMarketplaceOfferMinQuantity", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Offers.SetMarketplaceOfferMinQuantityCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully updated minimum stock quantity for the specified marketplace offers.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Offers/TriggerStockSynchronisation": { "post": { "tags": [ "OffersCommand" ], "summary": "Triggers stock synchronisation for the specified marketplace offers.", "operationId": "Offers_TriggerMarketplaceStockSynchronisation", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Offers.TriggerMarketplaceStockSynchronisationCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully triggered stock synchronisation for the specified marketplace offers.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Orders/CancelOrderCancellationRequestUpload": { "post": { "tags": [ "OrdersCommand" ], "summary": "Cancel marketplace order cancellation request uploads.", "operationId": "Orders_CancelMarketplaceOrderCancellationRequestUpload", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.CancelMarketplaceOrderCancellationRequestUploadCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully cancelled marketplace order cancellation request uploads.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Orders/ExcludeOrderCancellationUploadFromUpload": { "post": { "tags": [ "OrdersCommand" ], "summary": "Exclude marketplace order cancellation uploads from upload.", "operationId": "Orders_ExcludeMarketplaceOrderCancellationUploadFromUpload", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.ExcludeMarketplaceOrderCancellationUploadFromUploadCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully excluded marketplace order cancellation uploads from upload.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Orders/ExcludePaymentUploadFromUpload": { "post": { "tags": [ "OrdersCommand" ], "summary": "Exclude marketplace payment uploads from upload.", "operationId": "Orders_ExcludeMarketplacePaymentUploadFromUpload", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.ExcludeMarketplacePaymentUploadFromUploadCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully excluded marketplace payment uploads from upload.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Orders/ExcludeReturnUploadFromUpload": { "post": { "tags": [ "OrdersCommand" ], "summary": "Exclude marketplace return uploads from upload.", "operationId": "Orders_ExcludeMarketplaceReturnUploadFromUpload", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.ExcludeMarketplaceReturnUploadFromUploadCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully excluded marketplace return uploads from upload.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Orders/ExcludeShippingInformationUploadFromUpload": { "post": { "tags": [ "OrdersCommand" ], "summary": "Exclude marketplace shipping information uploads from upload.", "operationId": "Orders_ExcludeMarketplaceShippingInformationUploadFromUpload", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.ExcludeMarketplaceShippingInformationUploadFromUploadCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully excluded marketplace shipping information uploads from upload.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Orders/ResetOrderCancellationUploadCounter": { "post": { "tags": [ "OrdersCommand" ], "summary": "Reset the upload counter for marketplace order cancellation uploads.", "operationId": "Orders_ResetMarketplaceOrderCancellationUploadCounter", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.ResetMarketplaceOrderCancellationUploadCounterCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully reset the upload counter for marketplace order cancellation uploads.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Orders/ResetPaymentUploadCounter": { "post": { "tags": [ "OrdersCommand" ], "summary": "Reset the upload counter for marketplace payment uploads.", "operationId": "Orders_ResetMarketplacePaymentUploadCounter", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.ResetMarketplacePaymentUploadCounterCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully reset the upload counter for marketplace payment uploads.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Orders/ResetReturnUploadCounter": { "post": { "tags": [ "OrdersCommand" ], "summary": "Reset the upload counter for marketplace return uploads.", "operationId": "Orders_ResetMarketplaceReturnUploadCounter", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.ResetMarketplaceReturnUploadCounterCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully reset the upload counter for marketplace return uploads.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/Marketplace/Orders/ResetShippingInformationUploadCounter": { "post": { "tags": [ "OrdersCommand" ], "summary": "Reset the upload counter for marketplace shipping information uploads.", "operationId": "Orders_ResetMarketplaceShippingInformationUploadCounter", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.ResetMarketplaceShippingInformationUploadCounterCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successfully reset the upload counter for marketplace shipping information uploads.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/offer/{offerId}/output/mail": { "post": { "tags": [ "offer" ], "summary": "Mail Offer", "description": "Execute the mailing of a Offer", "operationId": "Offer_MailOfferAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "formId", "in": "query", "description": "Gets the unique identifier for the form (Formular) entity.\n ", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FormularKey" }, "x-position": 1 }, { "name": "offerId", "in": "path", "required": true, "description": "The id of the sales order for that the mail to start.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "The MailJob is created", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "offers.read" ] }, { "oauth2-client-credentials": [ "offers.read" ] } ], "x-sort": 5010, "x-stability-level": "beta" } }, "/v2/offer/{offerId}/output/pdf": { "post": { "tags": [ "offer" ], "summary": "Pdf Offer", "description": "Execute the pdf creation of a Offer", "operationId": "Offer_PdfOfferAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "formId", "in": "query", "description": "Gets the unique identifier for the form (Formular) entity.\n ", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FormularKey" }, "x-position": 1 }, { "name": "offerId", "in": "path", "required": true, "description": "The id of the sales order for that the creation of a pdf to start.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The Filestream of the Created PDF", "content": { "application/json": { "schema": { "type": "string", "format": "byte" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "offers.read" ] }, { "oauth2-client-credentials": [ "offers.read" ] } ], "x-sort": 5010, "x-stability-level": "beta" } }, "/v2/offer/{offerId}/output/print": { "post": { "tags": [ "offer" ], "summary": "Print Offer", "description": "Execute the printing of a Offer", "operationId": "Offer_PrintOfferAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "formId", "in": "query", "description": "Gets the unique identifier for the form (Formular) entity.\n ", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FormularKey" }, "x-position": 1 }, { "name": "printer", "in": "query", "description": "The target printer to print. The printer is Mandatory, if no User with Own Printer Configuration Available.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "offerId", "in": "path", "required": true, "description": "The id of the sales order for that the print to start.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "The Printjob is created", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "offers.print" ] }, { "oauth2-client-credentials": [ "offers.print" ] } ], "x-sort": 5010, "x-stability-level": "beta" } }, "/v2/onHoldReasons": { "get": { "tags": [ "onholdreason" ], "summary": "Query On Hold Reasons", "description": "Query all on hold reasons for sales orders", "operationId": "OnHoldReason_QueryOnHoldReasonsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all payment methods.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.OnHoldReason.OnHoldReason" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "orders.read", "invoices.read" ] }, { "oauth2-client-credentials": [ "orders.read", "invoices.read" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/package/change": { "patch": { "tags": [ "ShipmentPackagesCommand" ], "summary": "Modifies an existing Package Weight", "operationId": "ShipmentPackages_ChangePackageWeight", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.ShipmentPackages.ChangePackageWeightCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Package Weight was successfully modified.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/package/deliver": { "post": { "tags": [ "ShipmentPackagesCommand" ], "summary": "Delivers an existing Package", "operationId": "ShipmentPackages_CreateDeliverPackage", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.ShipmentPackages.CreateDeliverPackageCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Package was successfully Delivered.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/package/QueryOrderData/{packageId}": { "get": { "tags": [ "ShipmentPackagesQuery" ], "summary": "Delivers order data for a specific package", "operationId": "ShipmentPackages_QueryOrderData", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "packageId", "in": "path", "required": true, "schema": { "type": "string" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.read" ] }, { "oauth2-client-credentials": [ "inventory.read" ] } ], "x-stability-level": "alpha" } }, "/v2/paymentMethods": { "get": { "tags": [ "paymentmethod" ], "summary": "Query Payment Methods", "description": "Query all payment methods", "operationId": "PaymentMethod_QueryPaymentMethodsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all payment methods.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.PaymentMethod.PaymentMethod" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "orders.read", "invoices.read" ] }, { "oauth2-client-credentials": [ "orders.read", "invoices.read" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/printers": { "get": { "tags": [ "printer" ], "summary": "Installed Printers", "description": "Returns all Installed Printers", "operationId": "Printers_InstalledPrintersAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Installed Printers", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "system.config.read" ] }, { "oauth2-client-credentials": [ "system.config.read" ] } ], "x-sort": 0, "x-stability-level": "beta" } }, "/v2/ProductGroup/AddProductGroups": { "post": { "tags": [ "ProductGroupsCommand" ], "summary": "Add new product groups.", "operationId": "ProductGroups_AddProductGroups", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.ProductGroups.AddProductGroupsCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Product groups successfully created.", "content": { "application/json": {} } }, "400": { "description": "Error while creating product groups.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/ProductGroup/DeleteProductGroups": { "delete": { "tags": [ "ProductGroupsCommand" ], "summary": "Delete existing product groups.", "operationId": "ProductGroups_DeleteProductGroups", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.ProductGroups.DeleteProductGroupsCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Product groups successfully deleted.", "content": { "application/json": {} } }, "404": { "description": "Product group not found.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/ProductGroup/UpdateProductGroups": { "patch": { "tags": [ "ProductGroupsCommand" ], "summary": "Update the properties of product groups.", "operationId": "ProductGroups_UpdateProductGroups", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.ProductGroups.UpdateProductGroupsCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Product groups successfully changed", "content": { "application/json": {} } }, "404": { "description": "Product group not found.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/production-items/{id}": { "get": { "tags": [ "ProductionItemsQuery" ], "summary": "Retrieves a production item by its ID.", "operationId": "ProductionItems_QueryProductionItemById", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "id", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.ProdItemKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.read" ] }, { "oauth2-client-credentials": [ "pps.read" ] } ], "x-stability-level": "alpha" } }, "/v2/production-items/{productionItemId}/bills-of-materials/create": { "post": { "tags": [ "CreateCommand" ], "summary": "Creates a new bill of materials for a production item, including its components.", "operationId": "Create_CreateBillOfMaterials", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "productionItemId", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.ProdItemKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateBillOfMaterialsCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Successfully created a bill of materials.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.write" ] }, { "oauth2-client-credentials": [ "pps.write" ] } ], "x-stability-level": "alpha" } }, "/v2/production-items/{productionItemId}/lot-sizes/create": { "post": { "tags": [ "CreateCommand" ], "summary": "Creates a new lot size for a production item.", "operationId": "Create_CreateLotSize", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "productionItemId", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.ProdItemKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateLotSizeCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Successfully created a lot size.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.write" ] }, { "oauth2-client-credentials": [ "pps.write" ] } ], "x-stability-level": "alpha" } }, "/v2/production-items/by-item-id/{itemId}": { "get": { "tags": [ "ProductionItemsQuery" ], "summary": "Retrieves a production item by the ID of the underlying item.", "operationId": "ProductionItems_QueryProductionItemByItemId", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "itemId", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.read" ] }, { "oauth2-client-credentials": [ "pps.read" ] } ], "x-stability-level": "alpha" } }, "/v2/production-items/create": { "post": { "tags": [ "CreateCommand" ], "summary": "Creates a new production item, including its bills of materials with their components.", "operationId": "Create_CreateProductionItem", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateProductionItemCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Successfully created a production item.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.write" ] }, { "oauth2-client-credentials": [ "pps.write" ] } ], "x-stability-level": "alpha" } }, "/v2/production-orders/{id}": { "get": { "tags": [ "ProductionOrdersQuery" ], "summary": "Retrieves a production order by its ID.", "operationId": "ProductionOrders_QueryProductionOrderById", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "id", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.ProductionOrderKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.read" ] }, { "oauth2-client-credentials": [ "pps.read" ] } ], "x-stability-level": "alpha" } }, "/v2/production-orders/{productionOrderId}/release": { "post": { "tags": [ "ProductionOrdersCommand" ], "summary": "Releases an existing production order.", "operationId": "ProductionOrders_ReleaseProductionOrder", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "productionOrderId", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.ProductionOrderKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.PPS.ProductionOrders.PublicApi.DataTransferObjects.V2.ProductionOrders.ReleaseProductionOrderCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Successfully released the production order.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.write" ] }, { "oauth2-client-credentials": [ "pps.write" ] } ], "x-stability-level": "alpha" } }, "/v2/production-orders/create": { "post": { "tags": [ "ProductionOrdersCommand" ], "summary": "Creates a new production order.", "operationId": "ProductionOrders_CreateProductionOrder", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.PPS.ProductionOrders.PublicApi.DataTransferObjects.V2.ProductionOrders.CreateProductionOrderCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Successfully created a production order.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "pps.write" ] }, { "oauth2-client-credentials": [ "pps.write" ] } ], "x-stability-level": "alpha" } }, "/v2/properties": { "get": { "tags": [ "property" ], "summary": "Query Properties", "description": "Query all properties for items", "operationId": "Property_QueryPropertiesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all properties.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Property.Property" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.read" ] }, { "oauth2-client-credentials": [ "items.read" ] } ], "x-sort": 100, "x-stability-level": "stable" }, "post": { "tags": [ "property" ], "summary": "Create Property", "description": "Create a new property", "operationId": "Property_CreatePropertyAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "property", "description": "The property to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Property.CreateProperty" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created property.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Property.Property" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-sort": 110, "x-stability-level": "stable" } }, "/v2/properties/{propertyId}/values": { "get": { "tags": [ "property" ], "summary": "Query Property Values", "description": "Query all velues for a specific property", "operationId": "Property_QueryPropertyValuesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "propertyId", "in": "path", "required": true, "description": "The id of the property that the property values belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested property values of the property.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Property.PropertyValue" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No data could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "items.read" ] }, { "oauth2-client-credentials": [ "items.read" ] } ], "x-sort": 300, "x-stability-level": "stable" }, "post": { "tags": [ "property" ], "summary": "Create Property Value", "description": "Create a new value for a specific property", "operationId": "Property_CreatePropertyValueAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "propertyId", "in": "path", "required": true, "description": "The id of the property that the property values belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "propertyValue", "description": "The value of the property.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Property.CreatePropertyValue" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created property value.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Property.PropertyValue" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-sort": 310, "x-stability-level": "stable" } }, "/v2/properties/{propertyId}/values/{propertyValueId}": { "patch": { "tags": [ "property" ], "summary": "Update Property Value", "description": "Update the value of a specific property", "operationId": "Property_UpdatePropertyValueAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "propertyId", "in": "path", "required": true, "description": "The id of the property that the property values belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalKey" }, "x-position": 2 }, { "name": "propertyValueId", "in": "path", "required": true, "description": "The id of the property value.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalWertKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "propertyValue", "description": "The value of the property.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Property.UpdatePropertyValue" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No property value or property with the given ID exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-sort": 320, "x-stability-level": "stable" }, "delete": { "tags": [ "property" ], "summary": "Delete Property Value", "description": "Delete a specific value for a given property", "operationId": "Property_DeletePropertyValueAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "propertyId", "in": "path", "required": true, "description": "The id of the property that the property values belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalKey" }, "x-position": 1 }, { "name": "propertyValueId", "in": "path", "required": true, "description": "The id of the property value.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalWertKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No property value or property with the given ID exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-sort": 330, "x-stability-level": "stable" } }, "/v2/properties/{propertyId}/values/{propertyValueId}/descriptions": { "get": { "tags": [ "property" ], "summary": "Query Property Value Descriptions", "description": "Query all descriptions for a specific property value", "operationId": "Property_QueryPropertyValueDescriptionsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "propertyId", "in": "path", "required": true, "description": "The id of the property.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalKey" }, "x-position": 1 }, { "name": "propertyValueId", "in": "path", "required": true, "description": "The id of the property value.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalWertKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested property value descriptions.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Property.PropertyValueDescription" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "items.read" ] }, { "oauth2-client-credentials": [ "items.read" ] } ], "x-sort": 400, "x-stability-level": "stable" }, "post": { "tags": [ "property" ], "summary": "Create Property Value Description", "description": "Create a new description for a specific property value", "operationId": "Property_CreatePropertyValueDescriptionAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "propertyId", "in": "path", "required": true, "description": "The id of the property.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalKey" }, "x-position": 2 }, { "name": "propertyValueId", "in": "path", "required": true, "description": "The id of the property value.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalWertKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "propertyValueDescription", "description": "The PropertyValueDescription to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Property.CreatePropertyValueDescription" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created property value description.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Property.PropertyValueDescription" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-sort": 410, "x-stability-level": "stable" } }, "/v2/properties/{propertyId}/values/{propertyValueId}/descriptions/{languageIso}": { "patch": { "tags": [ "property" ], "summary": "Update Property Value Description", "description": "Update the description for a specific property value and language", "operationId": "Property_UpdatePropertyValueDescriptionAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "languageIso", "in": "path", "required": true, "description": "The iso code of the language that the descriptions belong to.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "propertyId", "in": "path", "required": true, "description": "The id of the property.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalKey" }, "x-position": 3 }, { "name": "propertyValueId", "in": "path", "required": true, "description": "The id of the property value.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalWertKey" }, "x-position": 4 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "propertyValueDescription", "description": "The property value description to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Property.UpdatePropertyValueDescription" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No data with the given IDs exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-sort": 420, "x-stability-level": "stable" }, "delete": { "tags": [ "property" ], "summary": "Delete Property Value Description", "description": "Delete the description for a specific property value and language", "operationId": "Property_DeletePropertyValueDescriptionAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "languageIso", "in": "path", "required": true, "description": "The iso code of the language that the descriptions belong to.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "propertyId", "in": "path", "required": true, "description": "The id of the property.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalKey" }, "x-position": 2 }, { "name": "propertyValueId", "in": "path", "required": true, "description": "The id of the property value.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalWertKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No data with the given IDs exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-sort": 430, "x-stability-level": "stable" } }, "/v2/properties/groups": { "get": { "tags": [ "property" ], "summary": "Query Property Groups", "description": "Query all groups for properties", "operationId": "Property_QueryPropertyGroupsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all property groups.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Property.PropertyGroup" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.read" ] }, { "oauth2-client-credentials": [ "items.read" ] } ], "x-sort": 200, "x-stability-level": "stable" }, "post": { "tags": [ "property" ], "summary": "Create Property Group", "description": "Create a new property group", "operationId": "Property_CreatePropertyGroupAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "propertyGroup", "description": "The property group to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Property.CreatePropertyGroup" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created property group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Property.PropertyGroup" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-sort": 210, "x-stability-level": "stable" } }, "/v2/refunds/cancellationReasons": { "get": { "tags": [ "cancellationreason" ], "summary": "Query Refund Cancellation Reasons", "description": "Query all cancellation reasons for refunds", "operationId": "Refund_QueryRefundCancellationReasonsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all cancellation reasons for refunds", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Refund.RefundCancellationReason" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesinvoicecorrections.read" ] }, { "oauth2-client-credentials": [ "salesinvoicecorrections.read" ] } ], "x-sort": 0, "x-stability-level": "draft" } }, "/v2/responsiblePersons": { "get": { "tags": [ "item" ], "summary": "Query Responsible Persons", "description": "Query all ResponsiblePerson", "operationId": "ResponsiblePerson_QueryResponsiblePersonsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all ResponsiblePerson.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.ResponsiblePerson.ResponsiblePerson" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "items.read" ] }, { "oauth2-client-credentials": [ "items.read" ] } ], "x-sort": 0, "x-stability-level": "beta" } }, "/v2/returnReasons": { "get": { "tags": [ "returnreason" ], "summary": "Query Return Reasons", "description": "Query all return reasons", "operationId": "ReturnReason_QueryReturnReasonsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all return reasons.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.ReturnReason.ReturnReason" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "returns.read" ] }, { "oauth2-client-credentials": [ "returns.read" ] } ], "x-sort": 0, "x-stability-level": "draft" } }, "/v2/returns": { "post": { "tags": [ "return" ], "summary": "Create Return", "description": "Create a new return with associated items and packages.", "operationId": "Return_CreateReturnAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "createReturn", "description": "The details of the return to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Return.CreateReturn" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created return.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Return.Return" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "500": { "description": "An error occurred while processing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "returns.write" ] }, { "oauth2-client-credentials": [ "returns.write" ] } ], "x-sort": 400, "x-stability-level": "beta" }, "get": { "tags": [ "return" ], "summary": "Query Returns", "description": "Query all returns", "operationId": "Return_QueryReturnsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "returnNumber", "in": "query", "description": "Search for a specific return number.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "customerId", "in": "query", "description": "Gets the unique identifier for the customer.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 2 }, { "name": "IsExisting", "in": "query", "description": "Gets a value indicating whether the customer key represents an existing customer.", "schema": { "type": "boolean" }, "x-position": 3 }, { "name": "salesOrderId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 4 }, { "name": "returnStateId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RetoureStatusKey" }, "x-position": 5 }, { "name": "pageNumber", "in": "query", "description": "Number of the page of items to fetch.", "schema": { "type": "integer", "format": "int32" }, "x-position": 6 }, { "name": "pageSize", "in": "query", "description": "Size of the page that is specified by `pageNumber`.", "schema": { "type": "integer", "format": "int32" }, "x-position": 7 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all non-pending returns.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Return.Return" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "returns.read" ] }, { "oauth2-client-credentials": [ "returns.read" ] } ], "x-sort": 100, "x-stability-level": "draft" } }, "/v2/returns/{returnId}": { "get": { "tags": [ "return" ], "summary": "Get Return", "description": "Get a specific return", "operationId": "Return_GetReturnAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "returnId", "in": "path", "required": true, "description": "The id of the return.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RetoureKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the return for the given id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Return.Return" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No return with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "returns.read" ] }, { "oauth2-client-credentials": [ "returns.read" ] } ], "x-sort": 200, "x-stability-level": "draft" } }, "/v2/returns/{returnId}/lineitems": { "get": { "tags": [ "return" ], "summary": "Query Return Line Items", "description": "Query all line items for a specific return", "operationId": "Return_QueryReturnLineItemsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "returnId", "in": "path", "required": true, "description": "The id of the return that the line items belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RetoureKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested line items.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Return.ReturnLineItem" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "returns.read" ] }, { "oauth2-client-credentials": [ "returns.read" ] } ], "x-sort": 300, "x-stability-level": "draft" } }, "/v2/returns/{returnId}/packages": { "get": { "tags": [ "return" ], "summary": "Query Return Packages", "description": "Query all packages for a specific return", "operationId": "Return_QueryReturnPackagesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "returnId", "in": "path", "required": true, "description": "The id of the return that the packages belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RetoureKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested packages.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Return.ReturnPackage" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "returns.read" ] }, { "oauth2-client-credentials": [ "returns.read" ] } ], "x-sort": 400, "x-stability-level": "draft" } }, "/v2/returnStates": { "get": { "tags": [ "returnstate" ], "summary": "Query Return States", "description": "Query all return states", "operationId": "ReturnState_QueryReturnStatesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all return states.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.ReturnState.ReturnState" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "returns.read" ] }, { "oauth2-client-credentials": [ "returns.read" ] } ], "x-sort": 0, "x-stability-level": "draft" } }, "/v2/salesChannels": { "get": { "tags": [ "saleschannel" ], "summary": "Get Sales Channels", "description": "Get all sales channels", "operationId": "SalesChannel_GetSalesChannelsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all sales channels with the available endpoints.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesChannel.SalesChannel" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "saleschannels.read" ] }, { "oauth2-client-credentials": [ "saleschannels.read" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/salesinvoice/cancel": { "post": { "tags": [ "SalesInvoiceDomainCommand" ], "summary": "Cancel a sales invoice", "operationId": "SalesInvoiceDomain_CancelSalesInvoice", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesInvoiceDomain.CancelSalesInvoiceCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Sales invoice cancelled successfully", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesinvoices.write" ] }, { "oauth2-client-credentials": [ "salesinvoices.write" ] } ], "x-stability-level": "alpha" } }, "/v2/salesinvoice/createsalesinvoice": { "post": { "tags": [ "SalesInvoiceDomainCommand" ], "summary": "Create a new sales invoice for a salesorder", "operationId": "SalesInvoiceDomain_CreateSalesInvoice", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesInvoiceDomain.CreateSalesInvoiceCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Sales invoice created successfully", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesinvoices.write" ] }, { "oauth2-client-credentials": [ "salesinvoices.write" ] } ], "x-stability-level": "alpha" } }, "/v2/salesinvoice/createsalesinvoicecorrection": { "post": { "tags": [ "SalesInvoiceCorrectionDomainCommand" ], "summary": "Create a new sales invoice correction from an existing invoice", "operationId": "SalesInvoiceCorrectionDomain_CreateSalesInvoiceCorrection", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesInvoiceCorrectionDomain.CreateSalesInvoiceCorrectionCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Sales invoice correction created successfully", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesinvoicecorrections.write" ] }, { "oauth2-client-credentials": [ "salesinvoicecorrections.write" ] } ], "x-stability-level": "alpha" } }, "/v2/salesinvoicecorrection/cancel": { "post": { "tags": [ "SalesInvoiceCorrectionDomainCommand" ], "summary": "Cancel a sales invoice correction", "operationId": "SalesInvoiceCorrectionDomain_CancelSalesInvoiceCorrection", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesInvoiceCorrectionDomain.CancelSalesInvoiceCorrectionCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Sales invoice correction cancelled successfully", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesinvoicecorrections.write" ] }, { "oauth2-client-credentials": [ "salesinvoicecorrections.write" ] } ], "x-stability-level": "alpha" } }, "/v2/salesInvoiceCorrections/cancellationReasons": { "get": { "tags": [ "cancellationreason" ], "summary": "Query Sales Invoice Correction Cancellation Reasons", "description": "Query all cancellation reasons for sales invoice corrections", "operationId": "SalesInvoiceCorrection_QuerySalesInvoiceCorrectionCancellationReasonsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all cancellation reasons for sales invoice corrections", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesInvoiceCorrection.SalesInvoiceCorrectionCancellationReason" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesinvoicecorrections.read" ] }, { "oauth2-client-credentials": [ "salesinvoicecorrections.read" ] } ], "x-sort": 0, "x-stability-level": "draft" } }, "/v2/salesorder/{Id}": { "get": { "tags": [ "SalesOrderDomainQuery" ], "summary": "Delivers a single sales order by its id", "operationId": "SalesOrderDomain_GetSalesOrderById", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "Id", "x-originalName": "id", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.read" ] }, { "oauth2-client-credentials": [ "salesorders.read" ] } ], "x-stability-level": "alpha" } }, "/v2/salesorder/calculate": { "post": { "tags": [ "SalesOrderDomainCommand" ], "summary": "Calculate prices, discounts, and taxes for a sales order without persisting it.", "operationId": "SalesOrderDomain_CalculateSalesOrder", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CalculateSalesOrderCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Sales order calculated successfully.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.read" ] }, { "oauth2-client-credentials": [ "salesorders.read" ] } ], "x-stability-level": "alpha" } }, "/v2/salesorder/calculatesalesorder": { "post": { "tags": [ "SalesOrderDomainCommand" ], "summary": "[Deprecated] Use salesorder/calculate instead.\nCalculate prices, discounts, and taxes for a sales order without persisting it.", "operationId": "SalesOrderDomain_CalculateSalesOrderLegacy", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CalculateSalesOrderCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Sales order calculated successfully.", "content": { "application/json": {} } } }, "deprecated": true, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-stability-level": "alpha" } }, "/v2/salesorder/create": { "post": { "tags": [ "SalesOrderDomainCommand" ], "summary": "Creates a new sales order.", "operationId": "SalesOrderDomain_CreateSalesOrder", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateSalesOrderCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Sales order created successfully", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-stability-level": "alpha" } }, "/v2/salesorder/empty": { "get": { "tags": [ "SalesOrderDomainQuery" ], "summary": "Returns an empty sales order with default values without persisting it. This is equivalent to opening a new sales order dialog in the UI.", "operationId": "SalesOrderDomain_GetEmptySalesOrder", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.read" ] }, { "oauth2-client-credentials": [ "salesorders.read" ] } ], "x-stability-level": "alpha" } }, "/v2/salesorder/itempricedetails": { "get": { "tags": [ "SalesOrderDomainQuery" ], "summary": "Returns a list of price details for the requested items.", "operationId": "SalesOrderDomain_ListItemPriceDetails", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "itemIds", "in": "query", "style": "form", "explode": true, "schema": { "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" } }, "x-position": 1 }, { "name": "customerId", "in": "query", "description": "Gets the unique identifier for the customer.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 2 }, { "name": "IsExisting", "in": "query", "description": "Gets a value indicating whether the customer key represents an existing customer.", "schema": { "type": "boolean" }, "x-position": 3 }, { "name": "currencyFactor", "in": "query", "schema": { "type": "number", "format": "decimal" }, "x-position": 4 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.read" ] }, { "oauth2-client-credentials": [ "salesorders.read" ] } ], "x-stability-level": "alpha" } }, "/v2/salesorder/update": { "patch": { "tags": [ "SalesOrderDomainCommand" ], "summary": "Modifies an existing sales order.", "operationId": "SalesOrderDomain_UpdateSalesOrder", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.UpdateSalesOrderCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "SalesOrder was successfully modified.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-stability-level": "alpha" } }, "/v2/salesOrders": { "get": { "tags": [ "salesorder" ], "summary": "Query Sales Orders", "description": "Query all sales orders", "operationId": "SalesOrder_QuerySalesOrdersAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderNumber", "in": "query", "description": "Search for a specific sales order number.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "externalOrderNumber", "in": "query", "description": "Search for a specific external order number.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "billingNumber", "in": "query", "description": "Search for a specific billing number.", "schema": { "type": "string" }, "x-position": 3 }, { "name": "itemId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "x-position": 4 }, { "name": "customerId", "in": "query", "description": "Gets the unique identifier for the customer.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "x-position": 5 }, { "name": "IsExisting", "in": "query", "description": "Gets a value indicating whether the customer key represents an existing customer.", "schema": { "type": "boolean" }, "x-position": 6 }, { "name": "paymentStatus", "in": "query", "description": "Search for a specific payment status.", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.PaymentStatus" }, "x-position": 7 }, { "name": "paymentMethodId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "x-position": 8 }, { "name": "deliveryCompleteStatus", "in": "query", "description": "Search for a specific payment status.", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.DeliveryCompleteStatus" }, "x-position": 9 }, { "name": "createdUserId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Identity.Abstractions.BenutzerKey" }, "x-position": 10 }, { "name": "companyId", "in": "query", "description": "Gets the unique identifier for the firm.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "x-position": 11 }, { "name": "salesChannelId", "in": "query", "description": "Search for a specific sales channel Id.", "schema": { "type": "string" }, "x-position": 12 }, { "name": "createdSince", "in": "query", "description": "Search for sales orders created after this date.", "schema": { "type": "string", "format": "date-time" }, "x-position": 13 }, { "name": "createdUntil", "in": "query", "description": "Search for sales orders created before this date.", "schema": { "type": "string", "format": "date-time" }, "x-position": 14 }, { "name": "colorId", "in": "query", "description": "Gets the unique identifier for the color.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FarbeKey" }, "x-position": 15 }, { "name": "ebayUsername", "in": "query", "description": "Search for sales orders with a specific eBay username.", "schema": { "type": "string" }, "x-position": 16 }, { "name": "shippingMethodId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey" }, "x-position": 17 }, { "name": "deliveredDate", "in": "query", "description": "Search for sales orders delivered on this date.", "schema": { "type": "string", "format": "date-time" }, "x-position": 18 }, { "name": "isCancelled", "in": "query", "description": "Determines if the sales order is cancelled.", "schema": { "type": "boolean" }, "x-position": 19 }, { "name": "onHoldReasonId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RueckhaltegrundKey" }, "x-position": 20 }, { "name": "isExternalInvoice", "in": "query", "description": "Determines if the sales order is an external invoice.", "schema": { "type": "boolean" }, "x-position": 21 }, { "name": "pageNumber", "in": "query", "description": "Number of the page of items to fetch.", "schema": { "type": "integer", "format": "int32" }, "x-position": 22 }, { "name": "pageSize", "in": "query", "description": "Size of the page that is specified by `pageNumber`.", "schema": { "type": "integer", "format": "int32" }, "x-position": 23 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all non-pending sales orders.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrder" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "all.read", "salesorders.read" ] }, { "oauth2-client-credentials": [ "all.read", "salesorders.read" ] } ], "x-sort": 100, "x-stability-level": "stable" }, "post": { "tags": [ "salesorder" ], "summary": "Create Sales Order", "description": "Create a new sales order", "operationId": "SalesOrder_CreateSalesOrderAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "renameSalesOrderNumberWhenAlreadyExists", "in": "query", "description": "If true, the sales order number will be renamed if it already exists.", "schema": { "type": "boolean" }, "x-position": 2 }, { "name": "disableAutomaticWorkflows", "in": "query", "description": "If true, the workflows do not trigger automatic.", "schema": { "type": "boolean" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "salesOrder", "description": "The sales order to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.CreateSalesOrder" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created sales order.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrder" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 210, "x-stability-level": "stable" } }, "/v2/salesOrders/{salesOrderId}": { "get": { "tags": [ "salesorder" ], "summary": "Get Sales Order", "description": "Get a specific sales order", "operationId": "SalesOrder_GetSalesOrderAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the order to return. Only non-pending orders are returned.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the sales order for the given id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrder" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No sales order with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "all.read", "salesorders.read" ] }, { "oauth2-client-credentials": [ "all.read", "salesorders.read" ] } ], "x-sort": 200, "x-stability-level": "stable" }, "patch": { "tags": [ "salesorder" ], "summary": "Update Sales Order", "description": "Update a specific sales order", "operationId": "SalesOrder_UpdateSalesOrderAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "recalculateTax", "in": "query", "description": "0 - Keine Neuberechnung, auch wenn steuerrelevante Felder geändert wurden. 1 - Nettopreise beibehalten (Änderungen des Mehrwertsteuersatzes werden vom Kunden getragen). 2 - Bruttopreise beibehalten (Änderungen des Mehrwertsteuersatzes werden vom Einzelhändler getragen).", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.RecalculateTaxMode" }, "x-position": 2 }, { "name": "disableAutomaticWorkflows", "in": "query", "description": "If true, the workflows do not trigger automatic.", "schema": { "type": "boolean" }, "x-position": 3 }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order to update.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 4 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "salesOrder", "description": "The sales order to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.UpdateSalesOrder" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The updated sales order.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrder" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No sales order with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 220, "x-stability-level": "stable" } }, "/v2/salesOrders/{salesOrderId}/cancel": { "post": { "tags": [ "salesorder" ], "summary": "Cancel Sales Order", "description": "Cancel a specific sales order", "operationId": "SalesOrder_CancelSalesOrderAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order to cancel.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "cancellationDetails", "description": "The details for the cancellation to be performed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.CreateSalesOrderCancellationDetails" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "406": { "description": "The sales order cannot be cancelled.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 1000, "x-stability-level": "stable" } }, "/v2/salesOrders/{salesOrderId}/customfields": { "get": { "tags": [ "salesorder" ], "summary": "Query Sales Order Custom Field Values", "description": "Query all custom fields and values for a specific sales order", "operationId": "SalesOrder_QuerySalesOrderCustomFieldValuesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the custom field belongs to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested custom fields values for a sales order.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CustomFieldValue" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.read", "all.read" ] }, { "oauth2-client-credentials": [ "salesorders.read", "all.read" ] } ], "x-sort": 710, "x-stability-level": "stable" } }, "/v2/salesOrders/{salesOrderId}/customfields/{customfieldId}": { "patch": { "tags": [ "salesorder" ], "summary": "Update Sales Order Custom Field", "description": "Update the value of a specific sales order custom field", "operationId": "SalesOrder_UpdateSalesOrderCustomFieldAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the custom field belongs to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "customfieldId", "in": "path", "required": true, "description": "The id of the customfield that should be updated.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EigenesFeldKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "customFieldValue", "description": "The custom field value.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateCustomFieldValue" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No sales order with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 720, "x-stability-level": "stable" }, "delete": { "tags": [ "salesorder" ], "summary": "Delete Sales Order Custom Field", "description": "Delete the value of a specific custom field of a given sales order", "operationId": "SalesOrder_DeleteSalesOrderCustomFieldAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the custom field belongs to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 1 }, { "name": "customfieldId", "in": "path", "required": true, "description": "The id of the customfield that should be deleted.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EigenesFeldKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No sales order with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 730, "x-stability-level": "stable" } }, "/v2/salesOrders/{salesOrderId}/files": { "get": { "tags": [ "salesorder" ], "summary": "Query Sales Order Files", "description": "Query all files for a specific sales order", "operationId": "SalesOrder_QuerySalesOrderFilesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the file belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested files.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderFile" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.read", "all.read" ] }, { "oauth2-client-credentials": [ "salesorders.read", "all.read" ] } ], "x-sort": 500, "x-stability-level": "stable" }, "post": { "tags": [ "salesorder" ], "summary": "Create Sales Order File", "description": "Create a new file for a specific sales order", "operationId": "SalesOrder_CreateSalesOrderFileAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the file belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "file", "description": "The file to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateFile" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created file.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderFile" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 520, "x-stability-level": "stable" } }, "/v2/salesOrders/{salesOrderId}/files/{salesOrderFileId}": { "get": { "tags": [ "salesorder" ], "summary": "Query Sales Order File Data", "description": "Query the data for a specific sales order file", "operationId": "SalesOrder_QuerySalesOrderFileDataAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the file belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 1 }, { "name": "salesOrderFileId", "in": "path", "required": true, "description": "The unique identifier of the sales order file.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragFileKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested file data.", "content": { "application/json": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "all.read", "salesorders.read" ] }, { "oauth2-client-credentials": [ "all.read", "salesorders.read" ] } ], "x-sort": 510, "x-stability-level": "stable" }, "patch": { "tags": [ "salesorder" ], "summary": "Update Sales Order File", "description": "Update a file for a specific sales order", "operationId": "SalesOrder_UpdateSalesOrderFileAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the file belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "salesOrderFileId", "in": "path", "required": true, "description": "The id for a specific sales order file.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragFileKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "file", "description": "The file to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateFile" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The updated sales order file.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderFile" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": {} } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No sales order with the given ID exists.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 525, "x-stability-level": "stable" }, "delete": { "tags": [ "salesorder" ], "summary": "Delete Sales Order File", "description": "Delete a specific file for a given sales order", "operationId": "SalesOrder_DeleteSalesOrderFileAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the file belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 1 }, { "name": "salesOrderFileId", "in": "path", "required": true, "description": "The id of the sales order file.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragFileKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No sales order with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 530, "x-stability-level": "stable" } }, "/v2/salesOrders/{salesOrderId}/lineitems": { "get": { "tags": [ "salesorder" ], "summary": "Query Sales Order Line Items", "description": "Query all line items for a specific sales order", "operationId": "SalesOrder_QuerySalesOrderLineItemsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the line items belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested line items.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderLineItem" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.read", "all.read" ] }, { "oauth2-client-credentials": [ "salesorders.read", "all.read" ] } ], "x-sort": 300, "x-stability-level": "stable" }, "post": { "tags": [ "salesorder" ], "summary": "Create Sales Order Line Item", "description": "Create a new line item for a specific sales order", "operationId": "SalesOrder_CreateSalesOrderLineItemAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the line items belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "lineItems", "description": "The line items to create.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.CreateSalesOrderLineItem" } } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created line items.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderLineItem" } } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 310, "x-stability-level": "stable" } }, "/v2/salesOrders/{salesOrderId}/lineitems/{salesOrderLineItemId}": { "patch": { "tags": [ "salesorder" ], "summary": "Update Sales Order Line Item", "description": "Update a line item for a specific sales order", "operationId": "SalesOrder_UpdateSalesOrderLineItemAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the line items belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "salesOrderLineItemId", "in": "path", "required": true, "description": "The id of the line item that the belongs to the sales order.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "salesOrderLineItem", "description": "The item to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.UpdateSalesOrderLineItem" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No line item with the given ID exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 320, "x-stability-level": "stable" }, "delete": { "tags": [ "salesorder" ], "summary": "Delete Sales Order Line Item", "description": "Delete a specific line item for a given sales order", "operationId": "SalesOrder_DeleteSalesOrderLineItemAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the line items belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 1 }, { "name": "salesOrderLineItemId", "in": "path", "required": true, "description": "The id of the line item that the belongs to the sales order.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "403": { "description": "Deletion of position not allowed", "content": { "application/json": {} } }, "404": { "description": "No sales order with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 330, "x-stability-level": "stable" } }, "/v2/salesOrders/{salesOrderId}/lineitems/{salesOrderLineItemId}/files": { "get": { "tags": [ "salesorder" ], "summary": "Query Sales Order Line Item Files", "description": "Query files for line items of a specific sales order", "operationId": "SalesOrder_QuerySalesOrderLineItemFilesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order for which line item files are being queried.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 1 }, { "name": "salesOrderLineItemId", "in": "path", "required": true, "description": "The id of the sales order line item for which files are being queried.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The files for the line items of the specified sales order.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderLineItemFile" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No files found for the line items of the specified sales order.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.read" ] }, { "oauth2-client-credentials": [ "salesorders.read" ] } ], "x-sort": 540, "x-stability-level": "stable" }, "post": { "tags": [ "salesorder" ], "summary": "Create Sales Order Line Item File", "description": "Create a new file for a specific sales order line item", "operationId": "SalesOrder_CreateSalesOrderLineItemFileAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the file belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "salesOrderLineItemId", "in": "path", "required": true, "description": "Search for a specific sales order line item number.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "file", "description": "The file to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateFile" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created file.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderLineItemFile" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": {} } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 520, "x-stability-level": "stable" } }, "/v2/salesOrders/{salesOrderId}/lineitems/{salesOrderLineItemId}/files/{salesOrderLineItemFileId}": { "get": { "tags": [ "salesorder" ], "summary": "Query Sales Order Line Item File Data", "description": "Query the data for a specific sales order file", "operationId": "SalesOrder_QuerySalesOrderLineItemFileDataAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the file belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 1 }, { "name": "salesOrderLineItemId", "in": "path", "required": true, "description": "The id of the sales order line item that the file belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "x-position": 2 }, { "name": "salesOrderLineItemFileId", "in": "path", "required": true, "description": "The unique identifier of the sales order line item file.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionFileKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested file data.", "content": { "application/json": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "all.read", "salesorders.read" ] }, { "oauth2-client-credentials": [ "all.read", "salesorders.read" ] } ], "x-sort": 510, "x-stability-level": "stable" }, "delete": { "tags": [ "salesorder" ], "summary": "Delete Sales Order Line Item File", "description": "Delete all line item files for a given sales order and line item", "operationId": "SalesOrder_DeleteSalesOrderLineItemFileAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the file belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 1 }, { "name": "salesOrderLineItemId", "in": "path", "required": true, "description": "The id of the sales order line item that the file belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "x-position": 2 }, { "name": "salesOrderLineItemFileId", "in": "path", "required": true, "description": "Delete a specific file.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionFileKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": {} } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No sales order with the given ID exists.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 530, "x-stability-level": "stable" }, "patch": { "tags": [ "salesorder" ], "summary": "Update Sales Order Line Item File", "description": "Update a file for a specific sales order line item", "operationId": "SalesOrder_UpdateSalesOrderLineItemFileAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the file belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "salesOrderLineItemId", "in": "path", "required": true, "description": "The id of the sales order line item that the file belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "x-position": 3 }, { "name": "salesOrderLineItemFileId", "in": "path", "required": true, "description": "The id for a specific sales order line item file.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionFileKey" }, "x-position": 4 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "file", "description": "The file to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.UpdateSalesOrderLineItemFile" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The updated sales order line item file.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderLineItemFile" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": {} } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No sales order with the given ID exists.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 540, "x-stability-level": "stable" } }, "/v2/salesOrders/{salesOrderId}/notes": { "get": { "tags": [ "salesorder" ], "summary": "Query Sales Order Notes", "description": "Query all notes for a specific sales order", "operationId": "SalesOrder_QuerySalesOrderNotesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the notes belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested notes of the sales order.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Note" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No data could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.read", "all.read" ] }, { "oauth2-client-credentials": [ "salesorders.read", "all.read" ] } ], "x-sort": 400, "x-stability-level": "stable" }, "post": { "tags": [ "salesorder" ], "summary": "Create Sales Order Note", "description": "Create a new note for a specific sales order", "operationId": "SalesOrder_CreateSalesOrderNoteAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the notes belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "note", "description": "The note of the sales order to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateNote" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created note of the sales order.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Note" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 410, "x-stability-level": "stable" } }, "/v2/salesOrders/{salesOrderId}/notes/{noteId}": { "patch": { "tags": [ "salesorder" ], "summary": "Update Sales Order Note", "description": "Update a specific note for a given sales order", "operationId": "SalesOrder_UpdateSalesOrderNoteAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order that the notes belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "noteId", "in": "path", "required": true, "description": "The id of the note.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.NotizKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "note", "description": "The note to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateNote" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No note with the given ID exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 720, "x-stability-level": "stable" }, "delete": { "tags": [ "salesorder" ], "summary": "Delete Sales Order Note", "description": "Delete a specific note for a given sales order", "operationId": "SalesOrder_DeleteSalesOrderNoteAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the customer that the notes belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 1 }, { "name": "noteId", "in": "path", "required": true, "description": "The id of the note.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.NotizKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No customer note with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 730, "x-stability-level": "stable" } }, "/v2/salesOrders/{salesOrderId}/output/mail": { "post": { "tags": [ "salesorder" ], "summary": "Mail Sales Order", "description": "Execute the mailing of a SalesOrder", "operationId": "SalesOrder_MailSalesOrderAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "formId", "in": "query", "description": "Gets the unique identifier for the form (Formular) entity.\n ", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FormularKey" }, "x-position": 1 }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order for that the mail to start.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "The Mailjob is created", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.read" ] }, { "oauth2-client-credentials": [ "salesorders.read" ] } ], "x-sort": 5010, "x-stability-level": "beta" } }, "/v2/salesOrders/{salesOrderId}/output/pdf": { "post": { "tags": [ "salesorder" ], "summary": "Pdf Sales Order", "description": "Execute the pdf creation of a SalesOrder", "operationId": "SalesOrder_PdfSalesOrderAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "formId", "in": "query", "description": "Gets the unique identifier for the form (Formular) entity.\n ", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FormularKey" }, "x-position": 1 }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order for that the creation of a pdf to start.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The Filestream of the Created PDF", "content": { "application/json": { "schema": { "type": "string", "format": "byte" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.read" ] }, { "oauth2-client-credentials": [ "salesorders.read" ] } ], "x-sort": 5010, "x-stability-level": "beta" } }, "/v2/salesOrders/{salesOrderId}/output/print": { "post": { "tags": [ "salesorder" ], "summary": "Print Sales Order", "description": "Execute the printing of a SalesOrder", "operationId": "SalesOrder_PrintSalesOrderAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "formId", "in": "query", "description": "Gets the unique identifier for the form (Formular) entity.\n ", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FormularKey" }, "x-position": 1 }, { "name": "printer", "in": "query", "description": "The target printer to print. The printer is Mandatory, if no User with Own Printer Configuration Available.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order for that the print to start.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "The Printjob is created", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.print" ] }, { "oauth2-client-credentials": [ "salesorders.print" ] } ], "x-sort": 5010, "x-stability-level": "beta" } }, "/v2/salesOrders/{salesOrderId}/workflow/{workflowEventId}": { "post": { "tags": [ "salesorder" ], "summary": "Trigger Sales Order Workflow", "description": "Trigger a specific workflow event for a given sales order", "operationId": "SalesOrder_TriggerSalesOrderWorkflowAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "workflowEventId", "in": "path", "required": true, "description": "The id of the event for that the manual workflow event should be started.", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderWorkflowEvent" }, "x-position": 1 }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order for that the manual workflow event should be started.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 5010, "x-stability-level": "stable" } }, "/v2/salesOrders/{salesOrderId}/workflowEvents": { "post": { "tags": [ "salesorder" ], "summary": "Trigger Sales Order Workflow Event", "description": "Trigger a specific workflow event for a given sales order", "operationId": "SalesOrder_TriggerSalesOrderWorkflowEventAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "salesOrderId", "in": "path", "required": true, "description": "The id of the sales order for that the manual workflow event should be started.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "workflowEvent", "description": "The workflow event.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateWorkflowEvent" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "", "content": { "application/json": {} } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-sort": 2100, "x-stability-level": "stable" } }, "/v2/salesOrders/cancellationReasons": { "get": { "tags": [ "cancellationreason" ], "summary": "Query Sales Order Cancellation Reasons", "description": "Query all cancellation reasons for sales orders", "operationId": "SalesOrder_QuerySalesOrderCancellationReasonsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all cancellation reasons for sales orders", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderCancellationReason" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "all.read", "salesorders.read" ] }, { "oauth2-client-credentials": [ "all.read", "salesorders.read" ] } ], "x-sort": 0, "x-stability-level": "draft" } }, "/v2/salesOrders/customfields": { "get": { "tags": [ "salesorder" ], "summary": "Query Sales Order Custom Fields", "description": "Query all custom fields for a sales order", "operationId": "SalesOrder_QuerySalesOrderCustomFieldsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested custom fields for sales orders.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CustomField" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.read", "all.read" ] }, { "oauth2-client-credentials": [ "salesorders.read", "all.read" ] } ], "x-sort": 700, "x-stability-level": "stable" } }, "/v2/salesOrders/workflowEvents": { "get": { "tags": [ "salesorder" ], "summary": "Query Sales Order Workflow Events", "description": "Query all available workflow events for sales orders", "operationId": "SalesOrder_QuerySalesOrderWorkflowEventsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "All manual workflow events for sales orders that could be used to trigger workflow events via REST-API.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.WorkflowEvent" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.read", "all.read" ] }, { "oauth2-client-credentials": [ "salesorders.read", "all.read" ] } ], "x-sort": 2000, "x-stability-level": "stable" } }, "/v2/salesquotation/{Id}": { "get": { "tags": [ "SalesQuotationDomainQuery" ], "summary": "Delivers a single sales quotation by its id", "operationId": "SalesQuotationDomain_GetSalesQuotationById", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "Id", "x-originalName": "id", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesquotations.read" ] }, { "oauth2-client-credentials": [ "salesquotations.read" ] } ], "x-stability-level": "alpha" } }, "/v2/salesquotation/cancel": { "post": { "tags": [ "SalesQuotationDomainCommand" ], "summary": "Cancel a sales quotation", "operationId": "SalesQuotationDomain_CancelSalesQuotation", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CancelSalesQuotationCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Sales quotation cancelled successfully", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesquotations.write" ] }, { "oauth2-client-credentials": [ "salesquotations.write" ] } ], "x-stability-level": "alpha" } }, "/v2/salesquotation/create": { "post": { "tags": [ "SalesQuotationDomainCommand" ], "summary": "Creates a new sales quotation.", "operationId": "SalesQuotationDomain_CreateSalesQuotation", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateSalesQuotationCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Sales quotation created successfully", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesquotations.write" ] }, { "oauth2-client-credentials": [ "salesquotations.write" ] } ], "x-stability-level": "alpha" } }, "/v2/salesquotation/createsalesorder": { "post": { "tags": [ "SalesQuotationDomainCommand" ], "summary": "Create a new sales order for a sales quotation", "operationId": "SalesQuotationDomain_CreateSalesOrderFromSalesQuotation", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateSalesOrderFromSalesQuotationCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Sales order created successfully", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.write" ] }, { "oauth2-client-credentials": [ "salesorders.write" ] } ], "x-stability-level": "alpha" } }, "/v2/shipment/label/{packageId}": { "get": { "tags": [ "shipment" ], "summary": "Shipping Label", "description": "Download a PDF Shipping Label from database by ID", "operationId": "Shipment_ShippingLabelAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "packageId", "in": "path", "required": true, "description": "The Package ID of the Package to retrieve the PDF document.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The PDF file stream as binary content.", "content": { "application/json": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "The given Package ID does not exist.\nor\nThe Shipment Label to the Package ID does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } }, "x-expectedSchemas": [ { "description": "The given Package ID does not exist.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } ] } }, { "description": "The Shipment Label to the Package ID does not exist.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } ] } } ] } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-sort": 100, "x-stability-level": "stable" } }, "/v2/shipment/wms/shippingLine/packages/{packageId}/packageWeight": { "post": { "tags": [ "shipment" ], "summary": "Package Weight", "description": "Set the weight of a package by ID", "operationId": "Shipment_PackageWeightAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "packageId", "in": "path", "required": true, "description": "The Package ID of the Package to retrieve the PDF document.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "packageWeight", "description": "The Package Weight to set.", "content": { "application/json": { "schema": { "type": "number", "format": "decimal" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The Package Weight that was set.", "content": { "application/json": {} } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "The given Package ID does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [] }, { "oauth2-client-credentials": [] } ], "x-sort": 200, "x-stability-level": "stable" } }, "/v2/shippingclass/create": { "post": { "tags": [ "ShippingClassCommand" ], "summary": "Creates a new shipping class", "operationId": "ShippingClass_CreateShippingClass", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.ShippingClass.CreateShippingClassCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "ShippingClass created successfully", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/shippingClasses": { "get": { "tags": [ "item" ], "summary": "Query Shipping Classes", "description": "Query all shipping classes", "operationId": "ShippingClass_QueryShippingClassesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all shipping classes.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.ShippingClass.ShippingClass" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "items.read" ] }, { "oauth2-client-credentials": [ "items.read" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/shippingMethods": { "get": { "tags": [ "shippingmethod" ], "summary": "Query Shipping Methods", "description": "Query all shipping methods", "operationId": "ShippingMethod_QueryShippingMethodsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all shipping methods.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.ShippingMethod.ShippingMethod" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "deliveries.read" ] }, { "oauth2-client-credentials": [ "deliveries.read" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/stocks": { "get": { "tags": [ "stock" ], "summary": "Query Stocks Per Item", "description": "Query stocks for a specific item, warehouse or storage location", "operationId": "Stock_QueryStocksPerItemAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "itemId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "x-position": 1 }, { "name": "warehouseId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "x-position": 2 }, { "name": "storageLocationId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" }, "x-position": 3 }, { "name": "pageNumber", "in": "query", "description": "Number of the page of items to fetch.", "schema": { "type": "integer", "format": "int32" }, "x-position": 4 }, { "name": "pageSize", "in": "query", "description": "Size of the page that is specified by `pageNumber`.", "schema": { "type": "integer", "format": "int32" }, "x-position": 5 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested stock information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Stock.Stock" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "inventories.read" ] }, { "oauth2-client-credentials": [ "inventories.read" ] } ], "x-sort": 200, "x-stability-level": "stable" }, "post": { "tags": [ "stock" ], "summary": "Stock Adjustment", "description": "Adjust the stock of a specific item. Depending from the item and warehouse many more details must be given (f.e. storage location, batch,...).", "operationId": "Stock_StockAdjustmentAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "disableAutomaticWorkflows", "in": "query", "description": "If true, the workflows do not trigger automatic.", "schema": { "type": "boolean" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "stock", "description": "The relevant information for the stock change.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Stock.CreateStock" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "The created stock.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Stock.Stock" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No category with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "inventories.write" ] }, { "oauth2-client-credentials": [ "inventories.write" ] } ], "x-sort": 400, "x-stability-level": "stable" } }, "/v2/stocks/changes": { "get": { "tags": [ "stock" ], "summary": "Query Stock Changes", "description": "Returns all stock changes for a specific item from a given start date", "operationId": "Stock_QueryStockChangesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "itemId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "x-position": 1 }, { "name": "startDate", "in": "query", "description": "The start date from which all stock Adjustments until now are returned.", "schema": { "type": "string", "format": "date-time" }, "x-position": 2 }, { "name": "pageNumber", "in": "query", "description": "Number of the page of items to fetch.", "schema": { "type": "integer", "format": "int32" }, "x-position": 3 }, { "name": "pageSize", "in": "query", "description": "Size of the page that is specified by `pageNumber`.", "schema": { "type": "integer", "format": "int32" }, "x-position": 4 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested stock changes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Stock.StockChange" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "inventories.read" ] }, { "oauth2-client-credentials": [ "inventories.read" ] } ], "x-sort": 300, "x-stability-level": "stable" } }, "/v2/stocks/serialnumbers": { "get": { "tags": [ "stock" ], "summary": "Query Serial Number Per Warehouse", "description": "Query the serial numbers for a specific item and warehouse", "operationId": "Stock_QuerySerialNumberPerWarehouseAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "itemId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "x-position": 1 }, { "name": "warehouseId", "in": "query", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "x-position": 2 }, { "name": "pageNumber", "in": "query", "description": "Number of the page of items to fetch.", "schema": { "type": "integer", "format": "int32" }, "x-position": 3 }, { "name": "pageSize", "in": "query", "description": "Size of the page that is specified by `pageNumber`.", "schema": { "type": "integer", "format": "int32" }, "x-position": 4 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested serial numbers for the item and warehouse.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Stock.SerialNumber" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "inventories.read" ] }, { "oauth2-client-credentials": [ "inventories.read" ] } ], "x-sort": 500, "x-stability-level": "stable" } }, "/v2/suppliers": { "get": { "tags": [ "supplier" ], "summary": "Query Suppliers", "description": "Query all suppliers", "operationId": "Supplier_QuerySuppliersAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "lastChangedSince", "in": "query", "description": "All suppliers where the last change happened after or equal the given time.", "schema": { "type": "string", "format": "date-time" }, "x-position": 1 }, { "name": "lastChangedUntil", "in": "query", "description": "All suppliers where the last change happened before or equal the given time.", "schema": { "type": "string", "format": "date-time" }, "x-position": 2 }, { "name": "pageNumber", "in": "query", "description": "Number of the page of items to fetch.", "schema": { "type": "integer", "format": "int32" }, "x-position": 3 }, { "name": "pageSize", "in": "query", "description": "Size of the page that is specified by `pageNumber`.", "schema": { "type": "integer", "format": "int32" }, "x-position": 4 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all suppliers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Supplier.Supplier" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "suppliers.read" ] }, { "oauth2-client-credentials": [ "suppliers.read" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/tax/item/{itemId}/{companyId}/{departureCountryISO}/{shipmentCountryISO}": { "get": { "tags": [ "tax" ], "summary": "Get Tax For Item", "description": "Returns the Taxrate for the given Item", "operationId": "Tax_GetTaxForItemAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "departureCountryISO", "in": "path", "required": true, "description": "Country ISO code of the source Country.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "shipmentCountryISO", "in": "path", "required": true, "description": "Country ISO code of the target Country.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "taxNumber", "in": "query", "description": "The taxNumber of the Customer", "schema": { "type": "string" }, "x-position": 3 }, { "name": "invoiceCountryISO", "in": "query", "description": "The Country ISO Code of the Invoice", "schema": { "type": "string" }, "x-position": 4 }, { "name": "invoiceCountryStateISO", "in": "query", "description": "The State in the Country of the Invoice", "schema": { "type": "string" }, "x-position": 5 }, { "name": "shipmentCountryStateISO", "in": "query", "description": "The State in the target Country", "schema": { "type": "string" }, "x-position": 6 }, { "name": "itemId", "in": "path", "required": true, "description": "The id of the Item to return.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "x-position": 7 }, { "name": "companyId", "in": "path", "required": true, "description": "The id of the Company to return.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "x-position": 8 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The TaxRate for the given Item.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Tax.TaxRate" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No item with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "taxes.read" ] }, { "oauth2-client-credentials": [ "taxes.read" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/tax/taxclass/{taxClassId}/{companyId}/{departureCountryISO}/{shipmentCountryISO}": { "get": { "tags": [ "tax" ], "summary": "Get Tax For Tax Class", "description": "Returns the Taxrate for the given Item", "operationId": "Tax_GetTaxForTaxClassAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "departureCountryISO", "in": "path", "required": true, "description": "Country ISO code of the source Country.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "shipmentCountryISO", "in": "path", "required": true, "description": "Country ISO code of the target Country.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "taxNumber", "in": "query", "description": "The taxNumber of the Customer", "schema": { "type": "string" }, "x-position": 3 }, { "name": "invoiceCountryISO", "in": "query", "description": "The Country ISO Code of the Invoice", "schema": { "type": "string" }, "x-position": 4 }, { "name": "invoiceCountryStateISO", "in": "query", "description": "The State in the Country of the Invoice", "schema": { "type": "string" }, "x-position": 5 }, { "name": "shipmentCountryStateISO", "in": "query", "description": "The State in the target Country", "schema": { "type": "string" }, "x-position": 6 }, { "name": "taxClassId", "in": "path", "required": true, "description": "The id of the TaxClass to return.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey" }, "x-position": 7 }, { "name": "companyId", "in": "path", "required": true, "description": "The id of the Company to return.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "x-position": 8 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The TaxRate for the given TaxClassId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Tax.TaxRate" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No TaxClass with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "taxes.read" ] }, { "oauth2-client-credentials": [ "taxes.read" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/taxClasses": { "get": { "tags": [ "item" ], "summary": "Query Tax Classes", "description": "Query all tax classes", "operationId": "TaxClass_QueryTaxClassesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all tax classes.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.TaxClass.TaxClass" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No fields could be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "taxes.read" ] }, { "oauth2-client-credentials": [ "taxes.read" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/taxclasses/create": { "post": { "tags": [ "TaxDomainCommand" ], "summary": "Creates a new tax class in the system", "operationId": "TaxDomain_CreateTaxClass", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.CreateTaxClassCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Tax class created successfully", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "taxes.write" ] }, { "oauth2-client-credentials": [ "taxes.write" ] } ], "x-stability-level": "alpha" } }, "/v2/taxclasses/delete": { "delete": { "tags": [ "TaxDomainCommand" ], "summary": "Deletes an existing tax class", "operationId": "TaxDomain_DeleteTaxClass", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.DeleteTaxClassCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Tax class was successfully deleted.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "taxes.write" ] }, { "oauth2-client-credentials": [ "taxes.write" ] } ], "x-stability-level": "alpha" } }, "/v2/taxclasses/taxclasseswithtaxrates": { "get": { "tags": [ "TaxDomainQuery" ], "summary": "Returns a list of all tax classes and their calculated tax rates for the given parameters.", "operationId": "TaxDomain_ListTaxClassesWithTaxRates", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "companyId", "in": "query", "description": "Gets the unique identifier for the firm.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "x-position": 1 }, { "name": "departureCountryIso", "in": "query", "schema": { "type": "string" }, "x-position": 2 }, { "name": "taxReference", "in": "query", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.TaxDomainTaxReference" }, "x-position": 3 }, { "name": "shipmentAddressVatId", "in": "query", "schema": { "type": "string" }, "x-position": 4 }, { "name": "shipmentAddressCountryIso", "in": "query", "schema": { "type": "string" }, "x-position": 5 }, { "name": "shipmentAddressState", "in": "query", "schema": { "type": "string" }, "x-position": 6 }, { "name": "billingAddressVatId", "in": "query", "schema": { "type": "string" }, "x-position": 7 }, { "name": "billingAddressCountryIso", "in": "query", "schema": { "type": "string" }, "x-position": 8 }, { "name": "billingAddressState", "in": "query", "schema": { "type": "string" }, "x-position": 9 }, { "name": "specialTaxTreatment", "in": "query", "schema": { "$ref": "#/components/schemas/JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.TaxDomainSpecialTaxTreatment" }, "x-position": 10 }, { "name": "taxClasses", "in": "query", "style": "form", "explode": true, "schema": { "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey" } }, "x-position": 11 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "taxes.read" ] }, { "oauth2-client-credentials": [ "taxes.read" ] } ], "x-stability-level": "alpha" } }, "/v2/taxclasses/update": { "patch": { "tags": [ "TaxDomainCommand" ], "summary": "Updates an existing tax class", "operationId": "TaxDomain_UpdateTaxClass", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.UpdateTaxClassCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Tax class was successfully updated.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "taxes.write" ] }, { "oauth2-client-credentials": [ "taxes.write" ] } ], "x-stability-level": "alpha" } }, "/v2/taxcodes/create": { "post": { "tags": [ "TaxDomainCommand" ], "summary": "Creates a new tax code in the system", "operationId": "TaxDomain_CreateTaxCode", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.CreateTaxCodeCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Tax code created successfully", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "taxes.write" ] }, { "oauth2-client-credentials": [ "taxes.write" ] } ], "x-stability-level": "alpha" } }, "/v2/taxcodes/delete": { "delete": { "tags": [ "TaxDomainCommand" ], "summary": "Deletes an existing tax code", "operationId": "TaxDomain_DeleteTaxCode", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.DeleteTaxCodeCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Tax code was successfully deleted.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "taxes.write" ] }, { "oauth2-client-credentials": [ "taxes.write" ] } ], "x-stability-level": "alpha" } }, "/v2/taxcodes/update": { "patch": { "tags": [ "TaxDomainCommand" ], "summary": "Updates an existing tax code", "operationId": "TaxDomain_UpdateTaxCode", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.UpdateTaxCodeCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Tax code was successfully updated.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "taxes.write" ] }, { "oauth2-client-credentials": [ "taxes.write" ] } ], "x-stability-level": "alpha" } }, "/v2/transactionStatuses": { "get": { "tags": [ "transactionStatus" ], "summary": "Query Transaction Status", "description": "Query all transaction status for sales order", "operationId": "TransactionStatus_QueryTransactionStatusAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all transaction status.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.TransactionStatus.TransactionStatus" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "salesorders.read" ] }, { "oauth2-client-credentials": [ "salesorders.read" ] } ], "x-sort": 0, "x-stability-level": "stable" } }, "/v2/UpdateCategory": { "patch": { "tags": [ "CategoryCommand" ], "summary": "Updates a new Category", "operationId": "Category_UpdateCategory", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Category.UpdateCategoryCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Category was successfully modified", "content": { "application/json": {} } }, "404": { "description": "Error while updating category.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/UpdateItemSalesChannels": { "post": { "tags": [ "SalesChannelsCommand" ], "summary": "Updates the active sales channels for a set of items", "operationId": "SalesChannels_UpdateItemSalesChannels", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.SalesChannels.UpdateItemSalesChannelsCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Item sales channels were successfully modified.", "content": { "application/json": {} } }, "404": { "description": "Error while updating Item sales channels.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "items.write" ] }, { "oauth2-client-credentials": [ "items.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/bin-locations/{BinLocationId}": { "get": { "tags": [ "BinLocationManagementQuery" ], "summary": "Returns a single bin location by its ID.", "operationId": "BinLocationManagement_GetBinLocationById", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "BinLocationId", "x-originalName": "binLocationId", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.read" ] }, { "oauth2-client-credentials": [ "inventory.read" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/bin-locations/activate": { "post": { "tags": [ "BinLocationManagementCommand" ], "summary": "Activates a bin location, making it available for operations.", "operationId": "BinLocationManagement_ActivateBinLocation", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.BinLocationManagement.ActivateBinLocationCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Bin location was successfully activated.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/bin-locations/create": { "post": { "tags": [ "BinLocationManagementCommand" ], "summary": "Creates a new bin location in a warehouse.", "operationId": "BinLocationManagement_CreateBinLocation", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.BinLocationManagement.CreateBinLocationCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Bin location was successfully created.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/bin-locations/deactivate": { "post": { "tags": [ "BinLocationManagementCommand" ], "summary": "Deactivates a bin location, making it unavailable for operations.", "operationId": "BinLocationManagement_DeactivateBinLocation", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.BinLocationManagement.DeactivateBinLocationCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Bin location was successfully deactivated.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/bin-locations/delete": { "delete": { "tags": [ "BinLocationManagementCommand" ], "summary": "Deletes a bin location from the warehouse.", "operationId": "BinLocationManagement_DeleteBinLocation", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.BinLocationManagement.DeleteBinLocationCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Bin location was successfully deleted.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/bin-locations/lock": { "post": { "tags": [ "BinLocationManagementCommand" ], "summary": "Locks a bin location, preventing stock movements.", "operationId": "BinLocationManagement_LockBinLocation", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.BinLocationManagement.LockBinLocationCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Bin location was successfully locked.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/bin-locations/lock-for-stock": { "post": { "tags": [ "BinLocationManagementCommand" ], "summary": "Locks a bin location for available stock, preventing it from being used for stock allocation.", "operationId": "BinLocationManagement_LockBinLocationForAvailableStock", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.BinLocationManagement.LockBinLocationForAvailableStockCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Bin location was successfully locked for available stock.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/bin-locations/statuses": { "get": { "tags": [ "BinLocationManagementQuery" ], "summary": "Returns all available bin location statuses.", "operationId": "BinLocationManagement_GetBinLocationStatuses", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.read" ] }, { "oauth2-client-credentials": [ "inventory.read" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/bin-locations/types": { "get": { "tags": [ "BinLocationManagementQuery" ], "summary": "Returns all available bin location types.", "operationId": "BinLocationManagement_GetBinLocationTypes", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.read" ] }, { "oauth2-client-credentials": [ "inventory.read" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/bin-locations/unlock-for-stock": { "post": { "tags": [ "BinLocationManagementCommand" ], "summary": "Unlocks a bin location for available stock, allowing it to be used for stock allocation.", "operationId": "BinLocationManagement_UnlockBinLocationForAvailableStock", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.BinLocationManagement.UnlockBinLocationForAvailableStockCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Bin location was successfully unlocked for available stock.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/bin-locations/update": { "patch": { "tags": [ "BinLocationManagementCommand" ], "summary": "Updates metadata of an existing bin location (name, type, sort order).", "operationId": "BinLocationManagement_UpdateBinLocationMetadata", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.BinLocationManagement.UpdateBinLocationMetadataCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Bin location metadata was successfully updated.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/shipping-boxes/assign-location": { "post": { "tags": [ "WarehouseAssistantCommand" ], "summary": "Reassigns a shipping box to a different bin location (Rule SB-5).", "operationId": "WarehouseAssistant_AssignShippingBoxToLocation", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseAssistant.AssignShippingBoxToLocationCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Shipping box was successfully assigned to the new bin location.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/shipping-boxes/create": { "post": { "tags": [ "WarehouseAssistantCommand" ], "summary": "Creates a new shipping box within a warehouse.", "operationId": "WarehouseAssistant_CreateShippingBox", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseAssistant.CreateShippingBoxCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Shipping box was successfully created.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/shipping-boxes/delete": { "delete": { "tags": [ "WarehouseAssistantCommand" ], "summary": "Permanently deletes a shipping box and all its attributes (Rule SB-8).", "operationId": "WarehouseAssistant_DeleteShippingBox", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseAssistant.DeleteShippingBoxCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Shipping box was successfully deleted.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/shipping-boxes/update": { "patch": { "tags": [ "WarehouseAssistantCommand" ], "summary": "Updates mutable metadata of an existing shipping box. TypeId is immutable (Rule SB-3).", "operationId": "WarehouseAssistant_UpdateShippingBoxMetadata", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseAssistant.UpdateShippingBoxMetadataCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Shipping box metadata was successfully updated.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/warehouse-zones/add-bin-locations": { "post": { "tags": [ "WarehouseZoneCommand" ], "summary": "Adds bin locations to a warehouse zone.", "operationId": "WarehouseZone_AddBinLocationsToZone", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseZone.AddBinLocationsToZoneCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Bin locations were successfully added to the zone.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/warehouse-zones/create": { "post": { "tags": [ "WarehouseZoneCommand" ], "summary": "Creates a new warehouse zone.", "operationId": "WarehouseZone_CreateWarehouseZone", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseZone.CreateWarehouseZoneCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Warehouse zone was successfully created.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/warehouse-zones/delete": { "delete": { "tags": [ "WarehouseZoneCommand" ], "summary": "Deletes a warehouse zone.", "operationId": "WarehouseZone_DeleteWarehouseZone", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseZone.DeleteWarehouseZoneCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Warehouse zone was successfully deleted.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/warehouse-zones/remove-bin-locations": { "post": { "tags": [ "WarehouseZoneCommand" ], "summary": "Removes bin locations from a warehouse zone.", "operationId": "WarehouseZone_RemoveBinLocationsFromZone", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseZone.RemoveBinLocationsFromZoneCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Bin locations were successfully removed from the zone.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouseassistant/warehouse-zones/update": { "patch": { "tags": [ "WarehouseZoneCommand" ], "summary": "Updates mutable metadata (code, description, type) of an existing warehouse zone.", "operationId": "WarehouseZone_UpdateWarehouseZoneMetadata", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseZone.UpdateWarehouseZoneMetadataCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Warehouse zone metadata was successfully updated.", "content": { "application/json": {} } }, "500": { "description": "Internal server error.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "inventory.write" ] }, { "oauth2-client-credentials": [ "inventory.write" ] } ], "x-stability-level": "alpha" } }, "/v2/warehouses": { "get": { "tags": [ "warehouse" ], "summary": "Query Warehouses", "description": "Query all warehouses", "operationId": "Warehouse_QueryWarehousesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "isActive", "in": "query", "description": "Search for active or inactive warehouses.", "schema": { "type": "boolean" }, "x-position": 1 }, { "name": "pageNumber", "in": "query", "description": "Number of the page of items to fetch.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "pageSize", "in": "query", "description": "Size of the page that is specified by `pageNumber`.", "schema": { "type": "integer", "format": "int32" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all warehouses.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Warehouse.Warehouse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "warehouse.read" ] }, { "oauth2-client-credentials": [ "warehouse.read" ] } ], "x-sort": 100, "x-stability-level": "stable" } }, "/v2/warehouses/{warehouseId}/storagelocations": { "get": { "tags": [ "warehouse" ], "summary": "Query Storage Locations", "description": "Query all storage locations for a given warehouse", "operationId": "Warehouse_QueryStorageLocationsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "pageNumber", "in": "query", "description": "Number of the page of items to fetch.", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "pageSize", "in": "query", "description": "Size of the page that is specified by `pageNumber`.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "warehouseId", "in": "path", "required": true, "description": "The id of the warehouse that the storage locations belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all storage locations of the warehouse.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Warehouse.StorageLocation" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No warehouse with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "warehouse.read" ] }, { "oauth2-client-credentials": [ "warehouse.read" ] } ], "x-sort": 110, "x-stability-level": "stable" } }, "/v2/warehouses/storagelocationtypes": { "get": { "tags": [ "warehouse" ], "summary": "Query Storage Location Type", "description": "Query all storage location types", "operationId": "Warehouse_QueryStorageLocationTypeAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all storage location types.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Warehouse.StorageLocationType" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "warehouse.read" ] }, { "oauth2-client-credentials": [ "warehouse.read" ] } ], "x-sort": 110, "x-stability-level": "stable" } }, "/v2/warehouses/types": { "get": { "tags": [ "warehouse" ], "summary": "Query Warehouse Types", "description": "Query all warehouse types", "operationId": "Warehouse_QueryWarehouseTypesAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all warehouse types.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Warehouse.WarehouseType" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "warehouse.read" ] }, { "oauth2-client-credentials": [ "warehouse.read" ] } ], "x-sort": 110, "x-stability-level": "stable" } }, "/v2/wms/{warehouseId}/picklists": { "get": { "tags": [ "wms" ], "summary": "Query Pick List", "description": "Query all pick lists for a specific wms warehouse that are not completed.", "operationId": "WMS_QueryPickListAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "pageNumber", "in": "query", "description": "Number of the page of items to fetch.", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "pageSize", "in": "query", "description": "Size of the page that is specified by `pageNumber`.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "warehouseId", "in": "path", "required": true, "description": "The id of the wms warehouse that the pick list belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "x-position": 3 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all pick lists for a given wms warehouse that are not completed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.WMS.PickList" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No wms warehouse with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "picklists.read" ] }, { "oauth2-client-credentials": [ "picklists.read" ] } ], "x-sort": 300, "x-stability-level": "stable" }, "post": { "tags": [ "wms" ], "summary": "Create Pick List", "description": "Create a new pick list for a specific wms warehouse", "operationId": "WMS_CreatePickListAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "warehouseId", "in": "path", "required": true, "description": "The id of the wms warehouse where the pick list should be created.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "pickList", "description": "The relevant information to create a picking list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.WMS.CreatePickList" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Returns the created pick list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.WMS.PickList" } } } }, "400": { "description": "The sent data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No wms warehouse or pick list template with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "picklists.write" ] }, { "oauth2-client-credentials": [ "picklists.write" ] } ], "x-sort": 320, "x-stability-level": "stable" } }, "/v2/wms/{warehouseId}/picklists/{picklistId}": { "get": { "tags": [ "wms" ], "summary": "Query Pick List Position", "description": "Query all positions for a given pick list", "operationId": "WMS_QueryPickListPositionAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "warehouseId", "in": "path", "required": true, "description": "The id of the wms warehouse that the pick list belong to.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "x-position": 1 }, { "name": "picklistId", "in": "path", "required": true, "description": "The id of the pick list.", "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PicklisteKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all pick lists positions for an given pick list.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.WMS.PickListPosition" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No wms warehouse or pick list with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "picklists.read" ] }, { "oauth2-client-credentials": [ "picklists.read" ] } ], "x-sort": 310, "x-stability-level": "stable" } }, "/v2/wms/picklisttemplates": { "get": { "tags": [ "wms" ], "summary": "Query Pick List Template", "description": "Query all pick list templates. A pick list template is used for creating a new pick list.", "operationId": "WMS_QueryPickListTemplateAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "pageNumber", "in": "query", "description": "Number of the page of items to fetch.", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "pageSize", "in": "query", "description": "Size of the page that is specified by `pageNumber`.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all pick lists templates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.WMS.PickListTemplate" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "picklists.read" ] }, { "oauth2-client-credentials": [ "picklists.read" ] } ], "x-sort": 350, "x-stability-level": "stable" } }, "/v2/workbenchResources/{Id}": { "get": { "tags": [ "WorkbenchResourcesQuery" ], "summary": "Retrieves a single workbench resource by its ID", "operationId": "WorkbenchResources_QueryWorkbenchResourceById", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "Id", "x-originalName": "id", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.WorkbenchResourceKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "resources.read" ] }, { "oauth2-client-credentials": [ "resources.read" ] } ], "x-stability-level": "alpha" } }, "/v2/workbenchResources/create": { "post": { "tags": [ "WorkbenchResourcesCommand" ], "summary": "Creates a new workbench resource", "operationId": "WorkbenchResources_CreateWorkbenchResource", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.PPS.ResourceManagement.PublicApi.DataTransferObjects.V2.WorkbenchResources.CreateWorkbenchResourceCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Successfully created a workbench resource", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "resources.write" ] }, { "oauth2-client-credentials": [ "resources.write" ] } ], "x-stability-level": "alpha" } }, "/v2/workbenchResourceTypes/{Id}": { "get": { "tags": [ "WorkbenchResourceTypesQuery" ], "summary": "Queries a single workbench resource type by its ID", "operationId": "WorkbenchResourceTypes_QueryWorkbenchResourceTypeById", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "Id", "x-originalName": "id", "in": "path", "required": true, "schema": { "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.ResourceTypeKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "resources.read" ] }, { "oauth2-client-credentials": [ "resources.read" ] } ], "x-stability-level": "alpha" } }, "/v2/workbenchResourceTypes/create": { "post": { "tags": [ "WorkbenchResourceTypesCommand" ], "summary": "Creates a new workbench resource type", "operationId": "WorkbenchResourceTypes_CreateWorkbenchResourceType", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "request", "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.PPS.ResourceManagement.PublicApi.DataTransferObjects.V2.WorkbenchResourceTypes.CreateWorkbenchResourceTypeCommandRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Successfully created a workbench resource type", "content": { "application/json": {} } } }, "security": [ { "oauth2-authorization-code": [ "resources.write" ] }, { "oauth2-client-credentials": [ "resources.write" ] } ], "x-stability-level": "alpha" } }, "/v2/workers": { "get": { "tags": [ "worker" ], "summary": "Get Worker Syncs", "description": "Returns the Available Syncs of the Worker", "operationId": "Worker_GetWorkerSyncsAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The TaxRate for the given Item.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Worker.WorkerSyncItem" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No item with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "system.worker.read" ] }, { "oauth2-client-credentials": [ "system.worker.read" ] } ], "x-sort": 0, "x-stability-level": "draft" } }, "/v2/workers/{syncId}": { "post": { "tags": [ "worker" ], "summary": "Configure Sync", "description": "Restart the Worker", "operationId": "Worker_ConfigureSyncAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "syncId", "in": "path", "required": true, "description": "The id of the job to Configure", "schema": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WorkerSyncKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "syncItem", "description": "The relevant Information of the Sync Item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Worker.CreateWorkerSyncConfiguration" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "The changed Worker Configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Worker.WorkerSyncItem" } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No item with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "system.worker.write" ] }, { "oauth2-client-credentials": [ "system.worker.write" ] } ], "x-sort": 0, "x-stability-level": "draft" }, "put": { "tags": [ "worker" ], "summary": "Sync Control", "description": "Control the Sync Processes", "operationId": "Worker_SyncControlAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "syncId", "in": "path", "required": true, "description": "The id of the job to Restart", "schema": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WorkerSyncKey" }, "x-position": 2 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "requestBody": { "x-name": "action", "description": "The Information to Control the Sync", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Worker.PutWorkerSyncAction" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "The Action is Invoked", "content": { "application/json": {} } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No item with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "system.worker.write" ] }, { "oauth2-client-credentials": [ "system.worker.write" ] } ], "x-sort": 0, "x-stability-level": "draft" } }, "/v2/workers/status": { "get": { "tags": [ "worker" ], "summary": "Get Worker Status", "description": "Returns the Status of the Worker", "operationId": "Worker_GetWorkerStatusAsync", "parameters": [ { "name": "x-tenant-id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The tenant ID for the target ERP instance." }, { "name": "syncId", "in": "query", "description": "Gets the unique identifier for the configuration key.", "schema": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WorkerSyncKey" }, "x-position": 1 }, { "name": "x-runas", "in": "header", "description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.", "schema": { "type": "string" } }, { "name": "x-companyid", "in": "header", "description": "The Company-Id (int or uuid) of the company on whose behalf the request is executed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The Status Elements of the Worker", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Worker.WorkerSyncStatus" } } } } }, "401": { "description": "", "content": { "application/json": {} } }, "402": { "description": "No licence available or the app has not been authorised by JTL.", "content": { "application/json": {} } }, "404": { "description": "No item with the given ID exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse" } } } } }, "security": [ { "oauth2-authorization-code": [ "system.worker.read" ] }, { "oauth2-client-credentials": [ "system.worker.read" ] } ], "x-sort": 0, "x-stability-level": "draft" } } }, "components": { "schemas": { "JTL.Data.Contracts.Keys.AdresseKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.AmazonUserKey": { "type": "string", "description": "Represents a unique key for identifying an Amazon user within the system.\n ", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.AnsprechpartnerKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.Artikel.CrossSellingGruppeKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.ArtikelKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.AttributKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.AuftragStornogrundKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.BildKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.ConfigKey": { "type": "string", "description": "Represents a configuration key that serves as a unique identifier for configuration entities.", "format": "uuid", "additionalProperties": false }, "JTL.Data.Contracts.Keys.ContactManagement.ProductComplianceContactKey": { "type": "string", "description": "Produktverantwortlichen Schlüssel", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.EbayUserKey": { "type": "string", "description": "Represents a unique key for identifying an eBay user within the system.\n ", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.EigenesFeldKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.EinheitKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.FarbeKey": { "type": "string", "description": "Represents a key for identifying a color entity in the system.", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.FileKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.FirmaKey": { "type": "string", "description": "Represents a key for identifying a firm within the application.", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.FormularKey": { "type": "string", "description": "Represents a unique key for identifying a form (Formular) entity within the system.\n ", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.GebindeKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.GutschriftKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.GutschriftPosKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.GutschriftStornogrundKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.HerstellerKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.KategorieKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.KonfiggruppeKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.KontoDatenKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.KundeKey": { "type": "string", "description": "Represents a unique key for identifying a customer in the JTL system.", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.KundenGruppeKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.KundenKategorieKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.LabelKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.LhmKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.LhmTypeKey": { "type": "string", "description": "Represents a unique key for identifying a lhm type in the JTL system.", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.LieferantKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.LieferscheinKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.LieferstatusKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.MassEinheitKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.MerkmalGruppeKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.MerkmalKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.MerkmalWertKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.NotizKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.PicklisteKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.PicklistePosKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.PicklisteVorlageKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.PlattformKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.RechnungKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.RechnungPositionKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.RechnungStornogrundKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.RetoureEtikettKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.RetoureKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.RetourenLieferscheinPositionKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.RetourePosKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.RetoureStatusKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.RueckgabegrundKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.RueckhaltegrundKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.ShopKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.ShopSubshopKey": { "type": "string", "description": "Represents a key for identifying a shop subshop in the system.\n ", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.SpracheKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.SteuerklasseKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.SteuerschluesselKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.VariationKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.VariationWertKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.VerkaufAuftragFileKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.VerkaufAuftragKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.VerkaufAuftragPositionFileKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.VerkaufsEinheitKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.VersandartKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.VersandKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.VersandklasseKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.VorgangsstatusKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.VorlagenSetKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.WarengruppeKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.WarenLagerBereichKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.WarenlagerKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.WarenLagerPlatzKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.WorkerSyncKey": { "type": "string", "description": "Represents a configuration key that serves as a unique identifier for configuration entities.", "format": "uuid", "additionalProperties": false }, "JTL.Data.Contracts.Keys.ZahlungKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.ZahlungsartKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Data.Contracts.Keys.ZustandKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Entities.dbo.Table.AttributEntity": { "type": "object", "description": "Attribute dienen zur flexibleren Verteilung von Eigenschaften zu bestimmten Objekten ", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Primärschlüssel der Tabelle", "format": "int32" }, "istMehrsprachig": { "type": "integer", "description": "Gibt an ob dieses Attribut ein mehrsprachiges Attribut ist", "format": "int32" }, "istFreifeld": { "type": "integer", "description": "Gibt an ob es sich bei dem Attribut um ein Benutzerdefiniertes Attribut handelt", "format": "int32" }, "sortierung": { "type": "integer", "description": "Gibt die Sortierreihenfolge dieses Attributs an", "format": "int32" }, "beschreibung": { "type": "string", "description": "Enthält einen Beschreibungstext zum Attribut", "maxLength": 1000 }, "bezugstyp": { "type": "integer", "description": "Der Bezugstyp gibt an zu welchen anderen Objekten dieses Attribut einen Bezug hat", "format": "int32" }, "ausgabeweg": { "type": "integer", "description": "Bestimmt wo dieses Attribut für Benutzer dargestellt werden soll. Wenn > 0, dann ist es z.B. ein Freifeld.", "format": "int32" }, "istStandard": { "type": "integer", "description": "Gibt an, ob das Attribut von uns vorgegeben ist und nicht gelöscht werden darf", "format": "int32" }, "feldTypId": { "type": "integer", "description": "Verweis auf den Primärschlüssel der Tabelle dbo.tFeldTyp.", "format": "int32" }, "regEx": { "type": "string", "description": "Gibt einen regulären Ausdruck an der verwendet wird um die Wertmenge einzuschränken oder zu formatieren" }, "gruppeName": { "type": "string", "description": "Name der Gruppe zu dem das Attribut gehört.", "maxLength": 150 }, "readOnly": { "type": "integer", "description": "Gibt an, ob das Attribut Read Only ist.", "format": "int32" }, "aktivFuerArtikelOhneWarengruppe": { "type": "boolean" }, "istPflichtfeld": { "type": "boolean" }, "attributId": { "type": "string", "maxLength": 255 }, "istUnsichtbar": { "type": "boolean", "description": "Bestimmt ob das Attribut/Eigenes Feld in der UI unsichtbar bleiben soll." }, "skipHooks": { "type": "boolean" }, "feldTyp": { "$ref": "#/components/schemas/JTL.Entities.dbo.Table.FeldTypEntity" }, "bezeichnungen": { "type": "array", "items": { "$ref": "#/components/schemas/JTL.Entities.dbo.Table.AttributSpracheEntity" } } } }, "JTL.Entities.dbo.Table.AttributSpracheEntity": { "type": "object", "additionalProperties": false, "properties": { "attributId": { "type": "integer", "description": "Enthält den Referenzschlüssel auf das Attribut.", "format": "int32" }, "spracheId": { "type": "integer", "description": "Enthält den Referenzschlüssel auf die Sprache.", "format": "int32" }, "name": { "type": "string", "description": "Name des Attributs in der jeweiligen Sprache", "maxLength": 255 }, "wertListe": { "type": "string", "description": "Wertliste mit separierten stringvalues die als Optionen bereitgestellt werden" }, "skipHooks": { "type": "boolean" } } }, "JTL.Entities.dbo.Table.FeldTypEntity": { "type": "object", "description": "Typ eines definierten semantischen Feldes welches mit einem primitiven Datentyp verknüpft ist", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Primärschlüssel der Tabelle", "format": "int32" }, "name": { "type": "string", "description": "Name des semantischen Feldes", "maxLength": 300 }, "datenTyp": { "type": "integer", "description": "Gibt den primitiven Datentypen an der verwendet wird um dieses Feld zu speichern", "format": "int32" }, "regEx": { "type": "string", "description": "Gibt einen regulären Ausdruck an der verwendet wird um die Wertmenge einzuschränken oder zu formatieren" }, "skipHooks": { "type": "boolean" }, "typ": { "$ref": "#/components/schemas/JTL.Entities.dbo.Table.FeldTypEntity_FeldDatenTyp" } } }, "JTL.Entities.dbo.Table.FeldTypEntity_FeldDatenTyp": { "type": "integer", "description": "0 = Integer, 1 = Decimal, 2 = String, 3 = DateTime", "format": "int32", "x-enumNames": [ "Integer", "Decimal", "String", "DateTime" ], "enum": [ 0, 1, 2, 3 ] }, "JTL.Identity.Abstractions.BenutzerKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Pps.Core.Contracts.Keys.BillOfMaterialComponentKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Pps.Core.Contracts.Keys.BillOfMaterialKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Pps.Core.Contracts.Keys.LotSizeKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Pps.Core.Contracts.Keys.OperationKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Pps.Core.Contracts.Keys.ProdItemKey": { "type": "string", "description": "Der Schlüssel eines Produktionsartikels.", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Pps.Core.Contracts.Keys.ProductionOrderKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Pps.Core.Contracts.Keys.ResourceTypeKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Pps.Core.Contracts.Keys.WorkbenchResourceKey": { "type": "string", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.BillOfMaterialsComponents.DeleteBillOfMaterialsItemCommandRequest": { "type": "object", "description": "Deletes a bill of materials item from a bill of materials. - Request", "additionalProperties": false, "properties": { "id": { "description": "The ID of the bill of materials item to be deleted.", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialComponentKey" } } }, "JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.BillOfMaterialsComponents.DeleteBillOfMaterialsOperationCommandRequest": { "type": "object", "description": "Deletes a bill of materials operation from a bill of materials. - Request", "additionalProperties": false, "properties": { "id": { "description": "The ID of the bill of materials operation to be deleted.", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialComponentKey" } } }, "JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.BillsOfMaterials.DeleteBillOfMaterialsCommandRequest": { "type": "object", "description": "Deletes a bill of materials. - Request", "additionalProperties": false, "properties": { "id": { "description": "The ID of the bill of materials to be deleted.", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialKey" } } }, "JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateBillOfMaterialsCommandRequest": { "type": "object", "description": "Creates a new bill of materials for a production item, including its components. - Request", "additionalProperties": false, "required": [ "ProductionItemId", "Input" ], "properties": { "productionItemId": { "description": "The ID of the production item for which the bill of materials is to be created.", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.ProdItemKey" }, "input": { "description": "The input for creating a bill of materials as part of a production item.", "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateBillOfMaterialsInput" } } }, "JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateBillOfMaterialsInput": { "type": "object", "description": "Represents the input for creating a bill of materials as part of a production item.", "additionalProperties": false, "required": [ "Name", "Operations" ], "properties": { "name": { "type": "string", "description": "The name of the bill of materials." }, "description": { "type": "string", "description": "An optional description of the bill of materials." }, "componentPostingsShelfLifeEndDateRequirements": { "type": "integer", "description": "Requirements for the production input of all components of this bill of materials regarding the shelf life end dates of the stock accounts to be debited. This requirement can be overridden for individual components. Optional; defaults to None. Must not be set to a value other than None if no component's underlying item has a shelf life end date configured.", "format": "int32", "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateOverallComponentPostingsInventoryAccountingDataRequirements" }, "componentPostingsBatchNumberRequirements": { "type": "integer", "description": "Requirements for the production input of all components of this bill of materials regarding the batch numbers of the stock accounts to be debited. This requirement can be overridden for individual components. Optional; defaults to None. Must not be set to a value other than None if no component's underlying item has a batch number configured.", "format": "int32", "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateOverallComponentPostingsInventoryAccountingDataRequirements" }, "shelfLifeEndDateGenerationMode": { "type": "integer", "description": "Indicates how the shelf life end date of the produced item is calculated after completing a lot.", "format": "int32", "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateShelfLifeEndDateGenerationMode" }, "additionalShelfLifeEndDateTime": { "type": "string", "description": "A time span that is added when calculating the shelf life end date of the produced item after completing a lot. Required when ShelfLifeEndDateGenerationMode is ProductionDate; optional when ShelfLifeEndDateGenerationMode is Earliest or Latest; is ignored when ShelfLifeEndDateGenerationMode is not specified.", "format": "duration" }, "operations": { "type": "array", "description": "The operations of this bill of materials. At least one operation is required, and across all operations at least one item must be present.", "items": { "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateBillOfMaterialsOperationInput" } } } }, "JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateBillOfMaterialsItemCommandRequest": { "type": "object", "description": "Creates a new bill of materials item for a bill of materials operation. - Request", "additionalProperties": false, "required": [ "ProductionItemId", "BillOfMaterialsId", "BillOfMaterialsOperationId", "Input" ], "properties": { "productionItemId": { "description": "The ID of the production item.", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.ProdItemKey" }, "billOfMaterialsId": { "description": "The ID of the bill of materials.", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialKey" }, "billOfMaterialsOperationId": { "description": "The ID of the bill of materials operation.", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialComponentKey" }, "input": { "description": "The input for creating a bill of materials item.", "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateBillOfMaterialsItemInput" } } }, "JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateBillOfMaterialsItemInput": { "type": "object", "description": "Represents the input for creating a bill of materials item as part of a bill of materials operation.", "additionalProperties": false, "required": [ "ItemId", "Quantity" ], "properties": { "itemId": { "description": "The ID of the item to be used as a bill of materials item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "quantity": { "type": "number", "description": "The required quantity of this component for the production of the production item. Must be greater than zero.", "format": "decimal" }, "measurementUnitId": { "description": "The ID of the measurement unit in which the quantity is managed, or NULL to use the sales unit of the underlying item.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MassEinheitKey" }, "componentPostingsShelfLifeEndDateRequirements": { "type": "integer", "description": "Requirements for the production input of this component regarding the shelf life end dates of the stock accounts to be debited. Overrides the corresponding setting on the bill of materials level for this component. Optional; defaults to Inherited, which applies the requirement specified at the bill of materials level. Must not be set to a value other than Inherited if the underlying item does not have a shelf life end date configured.", "format": "int32", "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateComponentPostingsInventoryAccountingDataRequirements" }, "componentPostingsBatchNumberRequirements": { "type": "integer", "description": "Requirements for the production input of this component regarding the batch numbers of the stock accounts to be debited. Overrides the corresponding setting on the bill of materials level for this component. Optional; defaults to Inherited, which applies the requirement specified at the bill of materials level. Must not be set to a value other than Inherited if the underlying item does not have a batch number configured.", "format": "int32", "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateComponentPostingsInventoryAccountingDataRequirements" } } }, "JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateBillOfMaterialsOperationCommandRequest": { "type": "object", "description": "Creates a new bill of materials operation for a bill of materials, including its items. - Request", "additionalProperties": false, "required": [ "ProductionItemId", "BillOfMaterialsId", "Input" ], "properties": { "productionItemId": { "description": "The ID of the production item.", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.ProdItemKey" }, "billOfMaterialsId": { "description": "The ID of the bill of materials.", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialKey" }, "input": { "description": "The input for creating a bill of materials operation.", "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateBillOfMaterialsOperationInput" } } }, "JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateBillOfMaterialsOperationInput": { "type": "object", "description": "Represents the input for creating a bill of materials operation as part of a new bill of materials.", "additionalProperties": false, "required": [ "OperationId" ], "properties": { "operationId": { "description": "The ID of the operation to be assigned to this bill of materials operation. The operation must exist.", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.OperationKey" }, "items": { "type": "array", "description": "The bill of materials items assigned to this operation. Optional per individual operation, but at least one component must be present across all operations within the bill of materials.", "items": { "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateBillOfMaterialsItemInput" } } } }, "JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateComponentPostingsInventoryAccountingDataRequirements": { "type": "integer", "description": "0 = Inherited, 1 = None, 2 = Identical", "format": "int32", "x-enumNames": [ "Inherited", "None", "Identical" ], "enum": [ 0, 1, 2 ] }, "JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateLotSizeCommandRequest": { "type": "object", "description": "Creates a new lot size for a production item. - Request", "additionalProperties": false, "required": [ "ProductionItemId", "Input" ], "properties": { "productionItemId": { "description": "The ID of the production item for which the lot size is to be created.", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.ProdItemKey" }, "input": { "description": "The input for creating a lot size as part of a production item.", "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateLotSizeInput" } } }, "JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateLotSizeInput": { "type": "object", "description": "Represents the input for creating a lot size as part of a production item.", "additionalProperties": false, "required": [ "LotSize" ], "properties": { "lotSize": { "type": "integer", "description": "The lot size value. Must be greater than zero.", "format": "int32" } } }, "JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateOverallComponentPostingsInventoryAccountingDataRequirements": { "type": "integer", "description": "0 = None, 1 = Identical", "format": "int32", "x-enumNames": [ "None", "Identical" ], "enum": [ 0, 1 ] }, "JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateProductionItemCommandRequest": { "type": "object", "description": "Creates a new production item, including its bills of materials with their components. - Request", "additionalProperties": false, "required": [ "Input" ], "properties": { "input": { "description": "The input for creating the production item, including the details of the production item itself and the bills of materials and lot sizes to be created for the production item.", "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateProductionItemInput" } } }, "JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateProductionItemInput": { "type": "object", "description": "Represents the input for creating a new production item, including the details of the production item itself and the bills of materials and lot sizes to be created for the production item.", "additionalProperties": false, "required": [ "ItemId", "BillsOfMaterials" ], "properties": { "itemId": { "description": "The ID of the item for which the production item is to be created.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "isCustomized": { "type": "boolean", "description": "Indicates whether this production item is a customized production item (true) or a regular production item (false)." }, "lotLabelTemplateId": { "description": "The ID of a template to be used for printing an item label when a lot is completed, or NULL if no item label should be printed on completion.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VorlagenSetKey" }, "singleItemLabelTemplateId": { "description": "The ID of a template to be used for printing an item label for each produced unit when a lot is completed, or NULL if no per-unit item label should be printed on completion. Optional.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VorlagenSetKey" }, "billsOfMaterials": { "type": "array", "description": "The bills of materials to create for this production item. At least one bill of materials is required. Each bill of materials must contain at least one operation, and across all operations, at least one component must be present.", "items": { "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateBillOfMaterialsInput" } }, "lotSizes": { "type": "array", "description": "The optional lot sizes to create for this production item.", "items": { "$ref": "#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateLotSizeInput" } } } }, "JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.Create.CreateShelfLifeEndDateGenerationMode": { "type": "integer", "description": "0 = Earliest, 1 = Latest, 2 = ProductionDate", "format": "int32", "x-enumNames": [ "Earliest", "Latest", "ProductionDate" ], "enum": [ 0, 1, 2 ] }, "JTL.PPS.ProductionOrders.PublicApi.DataTransferObjects.V2.ProductionOrders.CreateProductionOrderCommandRequest": { "type": "object", "description": "Creates a new production order. - Request", "additionalProperties": false, "required": [ "Input" ], "properties": { "input": { "description": "The input for creating the production order, including the production item, bill of materials, lot configuration, and optional scheduling details.", "$ref": "#/components/schemas/JTL.PPS.ProductionOrders.PublicApi.DataTransferObjects.V2.ProductionOrders.CreateProductionOrderInput" } } }, "JTL.PPS.ProductionOrders.PublicApi.DataTransferObjects.V2.ProductionOrders.CreateProductionOrderInput": { "type": "object", "description": "Represents the input for creating a new production order, including references to the production item, the bill of materials as well as the lot configuration and scheduling details.", "additionalProperties": false, "required": [ "ProductionItemId", "BillOfMaterialsId", "LotCount", "LotSize", "TargetTotalQuantity" ], "properties": { "productionItemId": { "description": "The ID of the production item for which the production order is to be created.", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.ProdItemKey" }, "billOfMaterialsId": { "description": "The ID of the bill of materials to be used for production.", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialKey" }, "lotCount": { "type": "integer", "description": "The number of lots to be produced.", "format": "int32" }, "lotSize": { "type": "number", "description": "The size of each lot to be produced.", "format": "decimal" }, "targetTotalQuantity": { "type": "number", "description": "The planned total quantity to be produced.", "format": "decimal" }, "isTargetTotalQuantityBelowLotSizeAllowed": { "type": "boolean", "description": "Indicates whether it is allowed for this order to have a target total quantity below the lot size (true) or not (false). Defaults to false." }, "referenceNumber": { "type": "string", "description": "The reference number associated with the production order." }, "projectNumber": { "type": "string", "description": "The project number associated with the production order." }, "notice": { "type": "string", "description": "Additional note on the order that will be displayed during production." }, "targetStartTimestamp": { "type": "string", "description": "The planned start time of the production order.", "format": "date-time" }, "targetCompletionTimestamp": { "type": "string", "description": "The planned completion time of the production order.", "format": "date-time" } } }, "JTL.PPS.ProductionOrders.PublicApi.DataTransferObjects.V2.ProductionOrders.ReleaseProductionOrderCommandRequest": { "type": "object", "description": "Releases an existing production order. - Request", "additionalProperties": false, "required": [ "ProductionOrderId" ], "properties": { "productionOrderId": { "description": "The ID of the production order to be released.", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.ProductionOrderKey" } } }, "JTL.PPS.ResourceManagement.PublicApi.DataTransferObjects.V2.WorkbenchResources.CreateWorkbenchResourceCommandRequest": { "type": "object", "description": "Creates a new workbench resource - Request", "additionalProperties": false, "required": [ "Number", "Name", "Description", "WorkbenchResourceTypeId", "HostName", "WarehouseId", "ReservationMode", "AutoShowProcessParameterValuesInProduction", "ExpiredComponentsUsage", "ReplenishmentCreationStockReservationMode" ], "properties": { "number": { "type": "string", "description": "This workbench resource's unique number." }, "name": { "type": "string", "description": "This workbench resource's name." }, "description": { "type": "string", "description": "This workbench resource's description." }, "workbenchResourceTypeId": { "description": "The ID of the resource type assigned to this workbench resource.", "$ref": "#/components/schemas/JTL.Pps.Core.Contracts.Keys.ResourceTypeKey" }, "hostName": { "type": "string", "description": "The name of the host assigned to this workbench resource." }, "warehouseId": { "description": "The ID of the warehouse assigned to this workbench resource.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "reservationMode": { "description": "The reservation mode of this workbench resource.", "$ref": "#/components/schemas/JTL.PPS.ResourceManagement.PublicApi.DataTransferObjects.V2.WorkbenchResources.ReservationMode" }, "autoShowProcessParameterValuesInProduction": { "type": "boolean", "description": "Specifies whether the dialog for displaying and/or capturing process parameter values in the context of production should be displayed automatically when process parameter values can/must be displayed or captured." }, "expiredComponentsUsage": { "description": "Specifies whether and to what extent the use of expired components is permitted.", "$ref": "#/components/schemas/JTL.PPS.ResourceManagement.PublicApi.DataTransferObjects.V2.WorkbenchResources.ExpiredComponentsUsage" }, "replenishmentCreationStockReservationMode": { "description": "Specifies wthether and how available stock should be reserved when creating a replenishment order.", "$ref": "#/components/schemas/JTL.PPS.ResourceManagement.PublicApi.DataTransferObjects.V2.WorkbenchResources.ReplenishmentCreationAvailableStockReservationMode" } } }, "JTL.PPS.ResourceManagement.PublicApi.DataTransferObjects.V2.WorkbenchResources.ExpiredComponentsUsage": { "type": "integer", "description": "0 = NotPermitted, 1 = Permitted", "format": "int32", "x-enumNames": [ "NotPermitted", "Permitted" ], "enum": [ 0, 1 ] }, "JTL.PPS.ResourceManagement.PublicApi.DataTransferObjects.V2.WorkbenchResources.ReplenishmentCreationAvailableStockReservationMode": { "type": "integer", "description": "0 = None, 1 = UserPrompt, 2 = Auto", "format": "int32", "x-enumNames": [ "None", "UserPrompt", "Auto" ], "enum": [ 0, 1, 2 ] }, "JTL.PPS.ResourceManagement.PublicApi.DataTransferObjects.V2.WorkbenchResources.ReservationMode": { "type": "integer", "description": "0 = Operation, 1 = Iteration, 2 = Session", "format": "int32", "x-enumNames": [ "Operation", "Iteration", "Session" ], "enum": [ 0, 1, 2 ] }, "JTL.PPS.ResourceManagement.PublicApi.DataTransferObjects.V2.WorkbenchResourceTypes.CreateWorkbenchResourceTypeCommandRequest": { "type": "object", "description": "Creates a new workbench resource type - Request", "additionalProperties": false, "required": [ "Name" ], "properties": { "name": { "type": "string", "description": "The workbench resource type's name." } } }, "JTL.Wawi.ContactManagement.Core.Contracts.Domain.Keys.ContactKey": { "type": "string", "description": "Stellt den Schlüssel eines Kontaktes dar.", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Wawi.Customers.PublicApi.DataTransferObjects.V2.CustomerDomain.CreateCreateCustomerAddress": { "type": "object", "description": "Model Class: CreateCreateCustomerAddress ", "additionalProperties": false, "required": [ "Street", "City", "CountryIso" ], "properties": { "street": { "type": "string", "description": "Name of the street (including number)." }, "additionalAddressLine": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "City name of the customer." }, "postalCode": { "type": "string", "description": "Postal code of the customer." }, "state": { "type": "string", "description": "Name of the state." }, "countryIso": { "type": "string", "description": "ISO code of the country (2 letters).", "maxLength": 2, "minLength": 2 }, "emailAddress": { "type": "string", "description": "The customers email address." }, "phoneNumber": { "type": "string", "description": "The customers phone number." }, "mobilePhoneNumber": { "type": "string", "description": "The customers mobile phone number." }, "faxNumber": { "type": "string", "description": "The customers fax number." }, "vatId": { "type": "string", "description": "The customers VAT ID." }, "salutation": { "type": "string", "description": "The customers salutation (e.g. Mr., Mrs., etc.)" }, "title": { "type": "string", "description": "The customers title (e.g. Dr., Prof., etc.)" }, "firstName": { "type": "string", "description": "The customers first name" }, "lastName": { "type": "string", "description": "The customers last name" }, "companyName": { "type": "string", "description": "The customers company name" }, "additionalCompanyLine": { "type": "string", "description": "The customers company additional line" } } }, "JTL.Wawi.Customers.PublicApi.DataTransferObjects.V2.CustomerDomain.CreateCreateCustomerPaymentSettings": { "type": "object", "description": "Model Class: CreateCreateCustomerPaymentSettings ", "additionalProperties": false, "properties": { "creditLimit": { "type": "integer", "description": "The customers credit limit.", "format": "int32" }, "paymentDueDateInDays": { "type": "integer", "description": "Payment target (in days).", "format": "int32" }, "discount": { "type": "number", "description": "The customers discount percentage.", "format": "decimal" }, "isDunningBlocked": { "type": "boolean", "description": "Whether the customer is blocked for dunning notices." } } }, "JTL.Wawi.Customers.PublicApi.DataTransferObjects.V2.CustomerDomain.CreateCustomerCommandRequest": { "type": "object", "description": "Creates a customer - Request", "additionalProperties": false, "required": [ "CustomerGroupId", "BillingAddress" ], "properties": { "companyId": { "description": "Id of the company the customer belongs to. Optional — defaults to 0 (no company) when omitted.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "customerGroupId": { "description": "Customer group for the customer to be in.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "customerCategoryId": { "description": "The customers category ID.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenKategorieKey" }, "paymentMethodId": { "description": "The customers preferred payment method ID.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "accountsReceivableNumber": { "type": "integer", "description": "The accounts receivable number of the customer.", "format": "int32" }, "birthday": { "type": "string", "description": "The customer's date of birth.", "format": "date-time" }, "commercialRegisterNumber": { "type": "string", "description": "The customer's commercial register number." }, "customerNumber": { "type": "string", "description": "Number of the customer. If no number is given when posting a customer, the number will be generated automatically." }, "ebayName": { "type": "string", "description": "The customers ebay name." }, "homepage": { "type": "string", "description": "The customers homepage URL." }, "initialContact": { "type": "string", "description": "The source of initial contact. This could be for example a specific sales channel, a convention or a marketing campaign." }, "isCashRegisterBased": { "type": "boolean", "description": "States if a customer is from a cash-register or point of sale and if their data should be synchronized with JTL-POS, for example." }, "isLocked": { "type": "boolean", "description": "The customer's locked status." }, "languageIso": { "type": "string", "description": "The customer's preferred language in ISO format (e.g. \"de\", \"en\")." }, "taxIdentificationNumber": { "type": "string", "description": "The customer's tax identification number." }, "billingAddress": { "description": "Default billing address of the customer.", "$ref": "#/components/schemas/JTL.Wawi.Customers.PublicApi.DataTransferObjects.V2.CustomerDomain.CreateCreateCustomerAddress" }, "shipmentAddress": { "description": "Default shipping address of the customer.", "$ref": "#/components/schemas/JTL.Wawi.Customers.PublicApi.DataTransferObjects.V2.CustomerDomain.CreateCreateCustomerAddress" }, "paymentSettings": { "description": "Settings relevant to payment for the customer.", "$ref": "#/components/schemas/JTL.Wawi.Customers.PublicApi.DataTransferObjects.V2.CustomerDomain.CreateCreateCustomerPaymentSettings" } } }, "JTL.Wawi.Customers.PublicApi.DataTransferObjects.V2.CustomerDomain.CustomerAddressType": { "type": "integer", "description": "0 = ShipmentAddress, 1 = BillingAddress, 2 = Other", "format": "int32", "x-enumNames": [ "ShipmentAddress", "BillingAddress", "Other" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Customers.PublicApi.DataTransferObjects.V2.CustomerDomain.UpdateCustomerCommandRequest": { "type": "object", "description": "Updates a customer - Request", "additionalProperties": false, "required": [ "CustomerId" ], "properties": { "customerId": { "description": "Id of the customer.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "companyId": { "description": "Id of the company the customer belongs to. Optional — if omitted, the existing company assignment is left unchanged.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "customerGroupId": { "description": "Customer group for the customer to be in.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "customerCategoryId": { "description": "The customers category ID.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenKategorieKey" }, "paymentMethodId": { "description": "The customers preferred payment method ID.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "accountsReceivableNumber": { "type": "integer", "description": "The accounts receivable number of the customer.", "format": "int32" }, "birthday": { "type": "string", "description": "The customer's date of birth.", "format": "date-time" }, "commercialRegisterNumber": { "type": "string", "description": "The customer's commercial register number." }, "customerNumber": { "type": "string", "description": "Number of the customer. If no number is given when posting a customer, the number will be generated automatically." }, "ebayName": { "type": "string", "description": "The customers ebay name." }, "homepage": { "type": "string", "description": "The customers homepage URL." }, "initialContact": { "type": "string", "description": "The source of initial contact. This could be for example a specific sales channel, a convention or a marketing campaign." }, "isCashRegisterBased": { "type": "boolean", "description": "States if a customer is from a cash-register or point of sale and if their data should be synchronized with JTL-POS, for example." }, "isLocked": { "type": "boolean", "description": "The customer's locked status." }, "languageIso": { "type": "string", "description": "The customer's preferred language in ISO format (e.g. \"de\", \"en\")." }, "taxIdentificationNumber": { "type": "string", "description": "The customer's tax identification number." }, "addresses": { "type": "array", "description": "Addresses of the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Customers.PublicApi.DataTransferObjects.V2.CustomerDomain.UpdateUpdateCustomerAddress" } }, "paymentSettings": { "description": "Settings relevant to payment for the customer.", "$ref": "#/components/schemas/JTL.Wawi.Customers.PublicApi.DataTransferObjects.V2.CustomerDomain.UpdateUpdateCustomerPaymentSettings" }, "createdDate": { "type": "string", "description": "The date and time of the customer's creation.", "format": "date-time" } } }, "JTL.Wawi.Customers.PublicApi.DataTransferObjects.V2.CustomerDomain.UpdateUpdateCustomerAddress": { "type": "object", "description": "Model Class: UpdateUpdateCustomerAddress ", "additionalProperties": false, "properties": { "customerAddressId": { "description": "Unique identifier for the address.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AdresseKey" }, "addressType": { "type": "integer", "description": "Type of the address (shipment, billing, etc.).", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Customers.PublicApi.DataTransferObjects.V2.CustomerDomain.CustomerAddressType" }, "street": { "type": "string", "description": "Name of the street (including number)." }, "additionalAddressLine": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "City name of the customer." }, "postalCode": { "type": "string", "description": "Postal code of the customer." }, "state": { "type": "string", "description": "Name of the state." }, "countryIso": { "type": "string", "description": "ISO code of the country (2 letter code, e.g. DE, AT, CH)." }, "emailAddress": { "type": "string", "description": "The customers email address." }, "phoneNumber": { "type": "string", "description": "The customers phone number." }, "mobilePhoneNumber": { "type": "string", "description": "The customers mobile phone number." }, "faxNumber": { "type": "string", "description": "The customers fax number." }, "vatId": { "type": "string", "description": "The customers VAT ID." }, "salutation": { "type": "string", "description": "The customers salutation (e.g. Mr., Mrs., etc.)" }, "title": { "type": "string", "description": "The customers title (e.g. Dr., Prof., etc.)" }, "firstName": { "type": "string", "description": "The customers first name" }, "lastName": { "type": "string", "description": "The customers last name" }, "companyName": { "type": "string", "description": "The customers company name" }, "additionalCompanyLine": { "type": "string", "description": "The customers company extension" }, "isDefaultAddress": { "type": "boolean", "description": "Indicates whether this is the default address." } } }, "JTL.Wawi.Customers.PublicApi.DataTransferObjects.V2.CustomerDomain.UpdateUpdateCustomerPaymentSettings": { "type": "object", "description": "Model Class: UpdateUpdateCustomerPaymentSettings ", "additionalProperties": false, "properties": { "creditLimit": { "type": "integer", "description": "The customers credit limit.", "format": "int32" }, "paymentDueDateInDays": { "type": "integer", "description": "Payment target (in days).", "format": "int32" }, "discount": { "type": "number", "description": "The customers discount percentage.", "format": "decimal" }, "isDunningBlocked": { "type": "boolean", "description": "Whether the customer is blocked for dunning notices." } } }, "JTL.Wawi.Extensibility.Core.Contracts.Domain.Keys.ExtensionKey": { "type": "string", "description": "Represents a unique key for identifying an extension within the JTL.Wawi extensibility framework.", "format": "uuid", "additionalProperties": false }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Category.CreateCategoryCommandRequest": { "type": "object", "description": "Creates a new Category. - Request", "additionalProperties": false, "required": [ "Name" ], "properties": { "parentId": { "description": "The parent category of the category.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey" }, "sortNumber": { "type": "integer", "description": "The sort number of the category.", "format": "int32" }, "name": { "type": "string", "description": "The category name." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Category.DeleteCategoryCommandRequest": { "type": "object", "description": "Delete a Category - Request", "additionalProperties": false, "properties": { "id": { "description": "The category to delete", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey" }, "moveChildrenTargetId": { "description": "The destination category to which all remaining child categories will be moved.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Category.UpdateCategoryCommandRequest": { "type": "object", "description": "Updates a new Category - Request", "additionalProperties": false, "required": [ "Id" ], "properties": { "id": { "description": "The category to update", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey" }, "parentId": { "description": "The parent category of the category.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey" }, "sortNumber": { "type": "integer", "description": "The sort number of the category.", "format": "int32" }, "name": { "type": "string", "description": "The category name." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CopyItemdetailsCommandRequest": { "type": "object", "description": "- Request\n ", "additionalProperties": false, "required": [ "CopyDetailsFromItemId", "CopyDetailsIntoItemIds", "CopyOptions" ], "properties": { "copyDetailsFromItemId": { "description": "The unique identifier of the source itemdetails to be copied.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "copyDetailsIntoItemIds": { "type": "array", "description": "Transfer the itemdetails into the items identified by these unique identifiers.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" } }, "copyOptions": { "description": "Specifies which properties and aspects of the source item should be duplicated to the new items.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateItemdetailsCopyOptions" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateAttributesCopyOptions": { "type": "object", "description": "Options for copying item attributes.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether attributes should be copied." }, "copyAction": { "description": "Specifies whether to replace existing attributes or attach/merge new attributes with existing ones.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateBomComponentsCopyOptions": { "type": "object", "description": "Options for copying bill of materials (BOM) components.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether BOM components should be copied." }, "copyAction": { "description": "Specifies whether to replace all existing BOM components or attach/add new components to the existing BOM structure.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateCharacteristicsCopyOptions": { "type": "object", "description": "Options for copying item characteristics (Merkmale).", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether characteristics should be copied." }, "copyAction": { "description": "Specifies whether to replace all existing characteristics or attach/add new characteristics to existing ones.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateConfigurationsCopyOptions": { "type": "object", "description": "Options for copying item configurations.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether configurations should be copied." }, "copyAction": { "description": "Specifies whether to replace all existing configurations or attach/add new configurations to existing ones.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateCrossSellingCopyOptions": { "type": "object", "description": "Options for copying cross-selling data.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether cross-selling data should be copied." }, "copyAction": { "description": "Specifies whether to replace existing cross-selling relations or attach/add new ones to existing cross-selling data.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateCustomFieldsCopyOptions": { "type": "object", "description": "Options for copying custom fields (eigene Felder).", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether custom fields should be copied." }, "copyAction": { "description": "Specifies whether to replace all existing custom field values or attach/merge new custom field values with existing ones.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateDeliveryOptionsCopyOptions": { "type": "object", "description": "Options for copying delivery options and constraints.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether delivery options should be copied." }, "copyAction": { "description": "Specifies whether to replace existing delivery options. Only Replace is applicable for delivery options, as they are exclusive settings.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateDescriptionsCopyOptions": { "type": "object", "description": "Options for copying item texts and descriptions.", "additionalProperties": false, "required": [ "IsActive", "ConsiderItemName", "ConsiderItemDescription", "ConsiderItemMetadata", "ConsiderItemUrlPath", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether texts and descriptions should be copied." }, "considerItemName": { "type": "boolean", "description": "Indicates whether the item name should be copied." }, "considerItemDescription": { "type": "boolean", "description": "Indicates whether the item description (long text) should be copied." }, "considerItemMetadata": { "type": "boolean", "description": "Indicates whether item metadata (meta description, meta keywords, title tag) should be copied." }, "considerItemUrlPath": { "type": "boolean", "description": "Indicates whether the item URL path (SEO URL) should be copied." }, "copyAction": { "description": "Specifies whether to replace existing texts or attach/merge new texts with existing ones.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateDownloadFilesCopyOptions": { "type": "object", "description": "Options for copying download files.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether download files should be copied." }, "copyAction": { "description": "Specifies whether to replace all existing download files or attach/add new download files to existing ones.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateIdentifiersCopyOptions": { "type": "object", "description": "Options for copying item identifiers (EAN, ISBN, HAN, UPC, TARIC, etc.).", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether identifiers should be copied." }, "copyAction": { "description": "Specifies whether to replace existing identifiers. Only Replace is applicable for identifiers as they are unique values.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateImagesCopyOptions": { "type": "object", "description": "Options for copying item images.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether images should be copied." }, "copyAction": { "description": "Specifies whether to replace all existing images or attach/add new images to existing ones.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateItemdetailsCopyOptions": { "type": "object", "description": "Defines which item properties should be copied when copying item details. This structure controls the copy behavior for all relevant item aspects.", "additionalProperties": false, "properties": { "attributesCopyOptions": { "description": "Options for copying item attributes.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateAttributesCopyOptions" }, "descriptionsCopyOptions": { "description": "Options for copying item texts and descriptions.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateDescriptionsCopyOptions" }, "imagesCopyOptions": { "description": "Options for copying item images.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateImagesCopyOptions" }, "crossSellingCopyOptions": { "description": "Options for copying cross-selling data.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateCrossSellingCopyOptions" }, "downloadFilesCopyOptions": { "description": "Options for copying download files.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateDownloadFilesCopyOptions" }, "customFieldsCopyOptions": { "description": "Options for copying custom fields.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateCustomFieldsCopyOptions" }, "purchasePricesCopyOptions": { "description": "Options for copying purchase prices.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreatePurchasePricesCopyOptions" }, "identifiersCopyOptions": { "description": "Options for copying item identifiers.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateIdentifiersCopyOptions" }, "configurationsCopyOptions": { "description": "Options for copying item configurations.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateConfigurationsCopyOptions" }, "suppliersCopyOptions": { "description": "Options for copying supplier data.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateSuppliersCopyOptions" }, "deliveryOptionsCopyOptions": { "description": "Options for copying delivery options.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateDeliveryOptionsCopyOptions" }, "measurementsCopyOptions": { "description": "Options for copying dimensions and weights.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateMeasurementsCopyOptions" }, "mediaFilesCopyOptions": { "description": "Options for copying media files.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateMediaFilesCopyOptions" }, "characteristicsCopyOptions": { "description": "Options for copying item characteristics.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateCharacteristicsCopyOptions" }, "onlineShopsCopyOptions": { "description": "Options for copying online shop settings.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateOnlineShopsCopyOptions" }, "oversalesCopyOptions": { "description": "Options for copying over-sales settings.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateOversalesCopyOptions" }, "scxCopyOptions": { "description": "Options for copying SCX marketplace data.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateScxCopyOptions" }, "specialPricesCopyOptions": { "description": "Options for copying special prices.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateSpecialPricesCopyOptions" }, "masterDataCopyOptions": { "description": "Options for copying master data.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateMasterDataCopyOptions" }, "bomComponentsCopyOptions": { "description": "Options for copying bill of materials components.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateBomComponentsCopyOptions" }, "uploadFilesCopyOptions": { "description": "Options for copying upload files.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateUploadFilesCopyOptions" }, "variationsCopyOptions": { "description": "Options for copying variations.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateVariationsCopyOptions" }, "salesPricesCopyOptions": { "description": "Options for copying sales prices.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateSalesPricesCopyOptions" }, "packagingCopyOptions": { "description": "Options for copying packaging settings.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreatePackagingCopyOptions" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateMasterDataCopyOptions": { "type": "object", "description": "Options for copying master data (manufacturer, product group, shipping class, tax class, etc.).", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether master data should be copied." }, "copyAction": { "description": "Specifies whether to replace existing master data. Only Replace is applicable for master data as these are exclusive assignments.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateMeasurementsCopyOptions": { "type": "object", "description": "Options for copying dimensions and weights.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether dimensions and weights should be copied." }, "copyAction": { "description": "Specifies whether to replace existing dimensions and weights. Only Replace is applicable for measurements.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateMediaFilesCopyOptions": { "type": "object", "description": "Options for copying media files.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether media files should be copied." }, "copyAction": { "description": "Specifies whether to replace all existing media files or attach/add new media files to existing ones.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateOnlineShopsCopyOptions": { "type": "object", "description": "Options for copying online shop settings and visibility.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether online shop settings should be copied." }, "copyAction": { "description": "Specifies whether to replace all existing online shop settings or attach/add new shop settings to existing ones.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateOversalesCopyOptions": { "type": "object", "description": "Options for copying over-sales settings.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether over-sales settings should be copied." }, "copyAction": { "description": "Specifies whether to replace existing over-sales settings or attach new ones. Only Replace is applicable for over-sales settings.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreatePackagingCopyOptions": { "type": "object", "description": "Options for copying item packaging settings.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether configurations should be copied." }, "copyAction": { "description": "Specifies whether to replace all existing configurations or attach/add new configurations to existing ones.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreatePurchasePricesCopyOptions": { "type": "object", "description": "Options for copying purchase prices.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether purchase prices should be copied." }, "copyAction": { "description": "Specifies whether to replace existing purchase prices. Only Replace is applicable for purchase prices.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateSalesPricesCopyOptions": { "type": "object", "description": "Options for copying sales prices including shop-specific and customer group prices.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether sales prices should be copied." }, "copyAction": { "description": "Specifies whether to replace all existing sales prices or attach/add new price entries to existing ones.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateScxCopyOptions": { "type": "object", "description": "Options for copying SCX (shopping.com XML) marketplace data.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether SCX data should be copied." }, "copyAction": { "description": "Specifies whether to replace existing SCX data or attach/add new SCX data to existing ones.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateSpecialPricesCopyOptions": { "type": "object", "description": "Options for copying special prices (Sonderpreise) including time-based promotional prices.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether special prices should be copied." }, "copyAction": { "description": "Specifies whether to replace all existing special prices or attach/add new special price entries to existing ones.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateSuppliersCopyOptions": { "type": "object", "description": "Options for copying supplier data.", "additionalProperties": false, "required": [ "IsActive", "KeepItemNumber", "KeepItemName", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether supplier data should be copied." }, "keepItemNumber": { "type": "boolean", "description": "Indicates whether the supplier-specific item SKU (article number) should be copied. When true, the SKU used by the supplier will be copied to the target items." }, "keepItemName": { "type": "boolean", "description": "Indicates whether the supplier-specific item name should be copied. When true, the item name used by the supplier will be copied to the target items." }, "copyAction": { "description": "Specifies whether to replace all existing suppliers or attach/add new suppliers to the existing supplier list.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateUploadFilesCopyOptions": { "type": "object", "description": "Options for copying upload files.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether upload files should be copied." }, "copyAction": { "description": "Specifies whether to replace all existing upload files or attach/add new upload files to existing ones.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.CreateVariationsCopyOptions": { "type": "object", "description": "Options for copying item variations.", "additionalProperties": false, "required": [ "IsActive", "CopyAction" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether variations should be copied." }, "copyAction": { "description": "Specifies whether to replace all existing variations or attach/add new variations to existing ones.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.CopyItemdetails.ItemSettingCopyAction": { "type": "integer", "description": "0 = Replace, 1 = Attach", "format": "int32", "x-enumNames": [ "Replace", "Attach" ], "enum": [ 0, 1 ] }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateAttributesDuplicationOptions": { "type": "object", "description": "Options for duplicating item attributes.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether item attributes should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateBomDuplicationOptions": { "type": "object", "description": "Options for duplicating bill of materials components.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether bill of materials components should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateCharacteristicsDuplicationOptions": { "type": "object", "description": "Options for duplicating item characteristics.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether item characteristics should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateConfigurationsDuplicationOptions": { "type": "object", "description": "Options for duplicating configurations.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether configurations should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateCrossSellingDuplicationOptions": { "type": "object", "description": "Options for duplicating cross-selling data.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether cross-selling data should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateCustomFieldsDuplicationOptions": { "type": "object", "description": "Options for duplicating custom fields.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether custom fields should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateDeliveryOptionsDuplicationOptions": { "type": "object", "description": "Options for duplicating delivery options.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether delivery options should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateDescriptionsDuplicationOptions": { "type": "object", "description": "Options for duplicating descriptions.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether descriptions should be duplicated." }, "considerDescriptions": { "type": "boolean", "description": "Indicates whether the item description should be considered during duplication. When true, the full description text will be duplicated." }, "considerMetadata": { "type": "boolean", "description": "Indicates whether the item metadata (such as meta description, meta keywords, and title tags) should be considered during duplication." }, "considerUrlPaths": { "type": "boolean", "description": "Indicates whether the URL path should be considered during duplication. When true, the SEO-friendly URL path will be duplicated." }, "considerNames": { "type": "boolean", "description": "Indicates whether the item name should be considered during duplication. When true, the item name from descriptions will be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateDownloadFilesDuplicationOptions": { "type": "object", "description": "Options for duplicating download files.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether download files should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateIdentifiersDuplicationOptions": { "type": "object", "description": "Options for duplicating identifiers.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether identifiers should be duplicated." }, "considerEan": { "type": "boolean", "description": "Indicates whether the EAN (European Article Number) should be considered during duplication." }, "considerIsbn": { "type": "boolean", "description": "Indicates whether the ISBN (International Standard Book Number) should be considered during duplication." }, "considerUpc": { "type": "boolean", "description": "Indicates whether the UPC (Universal Product Code) should be considered during duplication." }, "considerHan": { "type": "boolean", "description": "Indicates whether the HAN (manufacturer number) should be considered during duplication." }, "considerTaricCode": { "type": "boolean", "description": "Indicates whether the TARIC code should be considered during duplication." }, "considerCountryCode": { "type": "boolean", "description": "Indicates whether the country of origin code should be considered during duplication." }, "considerHazardNumber": { "type": "boolean", "description": "Indicates whether the hazard identification number should be considered during duplication." }, "considerSeries": { "type": "boolean", "description": "Indicates whether the series information should be considered during duplication." }, "considerUnNumber": { "type": "boolean", "description": "Indicates whether the UN number should be considered during duplication." }, "considerAmazonFnsku": { "type": "boolean", "description": "Indicates whether the Amazon FNSKU should be considered during duplication." }, "considerNotes": { "type": "boolean", "description": "Indicates whether item notes should be considered during duplication." }, "considerSearchTerms": { "type": "boolean", "description": "Indicates whether search terms should be considered during duplication." }, "considerIncludeInPriceList": { "type": "boolean", "description": "Indicates whether the include in price list flag should be considered during duplication." }, "considerOrderSuggestions": { "type": "boolean", "description": "Indicates whether order suggestions should be considered during duplication." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateImagesDuplicationOptions": { "type": "object", "description": "Options for duplicating images.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether images should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateItemDuplicate": { "type": "object", "description": "Represents the basic information for a duplicated item including SKU and name.", "additionalProperties": false, "required": [ "Sku", "Name" ], "properties": { "sku": { "type": "string", "description": "The stock keeping unit (SKU) for the duplicated item. Must be unique." }, "name": { "type": "string", "description": "The name of the duplicated item." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateItemDuplicationOptions": { "type": "object", "description": "Defines which item properties should be duplicated when creating item copies. This structure controls the duplication behavior for all relevant item aspects.", "additionalProperties": false, "properties": { "oversalesDuplicationOptions": { "description": "Options for duplicating over-sales settings.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateOversalesDuplicationOptions" }, "attributesDuplicationOptions": { "description": "Options for duplicating item attributes.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateAttributesDuplicationOptions" }, "imagesDuplicationOptions": { "description": "Options for duplicating images.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateImagesDuplicationOptions" }, "downloadFilesDuplicationOptions": { "description": "Options for duplicating download files.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateDownloadFilesDuplicationOptions" }, "uploadFilesDuplicationOptions": { "description": "Options for duplicating upload files.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateUploadFilesDuplicationOptions" }, "mediaFilesDuplicationOptions": { "description": "Options for duplicating media files.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateMediaFilesDuplicationOptions" }, "characteristicsDuplicationOptions": { "description": "Options for duplicating item characteristics.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateCharacteristicsDuplicationOptions" }, "bomDuplicationOptions": { "description": "Options for duplicating bill of materials components.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateBomDuplicationOptions" }, "variationsDuplicationOptions": { "description": "Options for duplicating variations.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateVariationsDuplicationOptions" }, "configurationsDuplicationOptions": { "description": "Options for duplicating configurations.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateConfigurationsDuplicationOptions" }, "descriptionsDuplicationOptions": { "description": "Options for duplicating descriptions.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateDescriptionsDuplicationOptions" }, "crossSellingDuplicationOptions": { "description": "Options for duplicating cross-selling data.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateCrossSellingDuplicationOptions" }, "customFieldsDuplicationOptions": { "description": "Options for duplicating custom fields.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateCustomFieldsDuplicationOptions" }, "purchasePricesDuplicationOptions": { "description": "Options for duplicating purchase prices.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreatePurchasePricesDuplicationOptions" }, "identifiersDuplicationOptions": { "description": "Options for duplicating identifiers.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateIdentifiersDuplicationOptions" }, "salesPricesDuplicationOptions": { "description": "Options for duplicating sales prices.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateSalesPricesDuplicationOptions" }, "masterDataDuplicationOptions": { "description": "Options for duplicating master data.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateMasterDataDuplicationOptions" }, "specialPricesDuplicationOptions": { "description": "Options for duplicating special prices.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateSpecialPricesDuplicationOptions" }, "deliveryOptionsDuplicationOptions": { "description": "Options for duplicating delivery options.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateDeliveryOptionsDuplicationOptions" }, "measurementssDuplicationOptions": { "description": "Options for duplicating dimensions and weights.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateMeasurementssDuplicationOptions" }, "suppliersDuplicationOptions": { "description": "Options for duplicating supplier data.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateSuppliersDuplicationOptions" }, "saleschannelDuplicationOptions": { "description": "Options for duplicating saleschannel settings.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateSaleschannelDuplicationOptions" }, "scxDuplicationOptions": { "description": "Options for duplicating SCX data.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateScxDuplicationOptions" }, "packagingDuplicationOptions": { "description": "Options for duplicating packaging data.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreatePackagingDuplicationOptions" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateMasterDataDuplicationOptions": { "type": "object", "description": "Options for duplicating master data.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether master data should be duplicated." }, "considerManufacturer": { "type": "boolean", "description": "Indicates whether the manufacturer should be considered during duplication." }, "considerProductGroup": { "type": "boolean", "description": "Indicates whether the product group should be considered during duplication." }, "considerTaxClass": { "type": "boolean", "description": "Indicates whether the tax class should be considered during duplication." }, "considerShippingClass": { "type": "boolean", "description": "Indicates whether the shipping class should be considered during duplication." }, "considerBasePriceUnit": { "type": "boolean", "description": "Indicates whether the base price unit should be considered during duplication." }, "considerMinimumPurchaseSettings": { "type": "boolean", "description": "Indicates whether minimum purchase settings should be considered during duplication." }, "considerPackaging": { "type": "boolean", "description": "Indicates whether packaging information should be considered during duplication." }, "considerNonDiscountable": { "type": "boolean", "description": "Indicates whether the non-discountable flag should be considered during duplication." }, "considerItemType": { "type": "boolean", "description": "Indicates whether the item type should be considered during duplication." }, "considerInventoryManagement": { "type": "boolean", "description": "Indicates whether inventory management settings should be considered during duplication." }, "considerMinMaxInventory": { "type": "boolean", "description": "Indicates whether minimum and maximum inventory levels should be considered during duplication." }, "considerProductCompliancePerson": { "type": "boolean", "description": "Indicates whether the product compliance responsible person should be considered during duplication." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateMeasurementssDuplicationOptions": { "type": "object", "description": "Options for duplicating dimensions and weights.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether dimensions and weights should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateMediaFilesDuplicationOptions": { "type": "object", "description": "Options for duplicating media files.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether media files should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateOversalesDuplicationOptions": { "type": "object", "description": "Options for duplicating over-sales settings.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether over-sales settings should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreatePackagingDuplicationOptions": { "type": "object", "description": "Options for copying item packaging settings.", "additionalProperties": false, "required": [ "IsActive" ], "properties": { "isActive": { "type": "boolean", "description": "Indicates whether packaging settings should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreatePurchasePricesDuplicationOptions": { "type": "object", "description": "Options for duplicating purchase prices.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether purchase prices should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateSaleschannelDuplicationOptions": { "type": "object", "description": "Options for duplicating saleschannel settings.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether saleschannel settings should be duplicated." }, "considerHighlightOptions": { "type": "boolean", "description": "Indicates whether item highlight options should be considered during duplication. When true, special highlighting and promotional settings for sales channels will be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateSalesPricesDuplicationOptions": { "type": "object", "description": "Options for duplicating sales prices.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether sales prices should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateScxDuplicationOptions": { "type": "object", "description": "Options for duplicating SCX data.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether SCX data should be duplicated." }, "considerCategoryMappings": { "type": "boolean", "description": "Indicates whether assigned categories should be considered during duplication. When true, category assignments for sales channels will be duplicated." }, "considerSalesChannelFieldValues": { "type": "boolean", "description": "Indicates whether custom field values should be considered during duplication. When true, sales channel-specific custom field values will be duplicated." }, "considerEveryShop": { "type": "boolean", "description": "Indicates whether all shops should be considered during duplication. When true, SCX data will be duplicated for all configured sales channels." }, "shopsToConsider": { "type": "array", "description": "List of sales channel keys for which the SCX data should be duplicated. Only data for the specified sales channels will be copied to the new item.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateSpecialPricesDuplicationOptions": { "type": "object", "description": "Options for duplicating special prices.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether special prices should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateSuppliersDuplicationOptions": { "type": "object", "description": "Options for duplicating supplier data.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether supplier data should be duplicated." }, "keepItemNumber": { "type": "boolean", "description": "Indicates whether the supplier-specific item SKU (article number) should be kept during duplication. When true, the SKU used by the supplier will be duplicated." }, "keepItemName": { "type": "boolean", "description": "Indicates whether the supplier-specific item name should be kept during duplication. When true, the item name used by the supplier will be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateUploadFilesDuplicationOptions": { "type": "object", "description": "Options for duplicating upload files.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether upload files should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateVariationsDuplicationOptions": { "type": "object", "description": "Options for duplicating variations.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether variations should be duplicated." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.DuplicateItemsCommandRequest": { "type": "object", "description": "Creates one or more duplicates of an existing item with specified duplication options. - Request", "additionalProperties": false, "required": [ "DuplicateItemId", "DuplicatesToCreate", "ExecuteItemCreatedWorkflowOnCreation", "ItemDuplicationOptions" ], "properties": { "duplicateItemId": { "description": "The unique identifier of the source item to be duplicated.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "duplicatesToCreate": { "type": "array", "description": "The basic information (SKU and name) for the items to be created as duplicates.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateItemDuplicate" } }, "executeItemCreatedWorkflowOnCreation": { "type": "boolean", "description": "Indicates whether the item creation workflow should be executed after creating the duplicates." }, "itemDuplicationOptions": { "description": "Specifies which properties and aspects of the source item should be duplicated to the new items.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.DuplicateItem.CreateItemDuplicationOptions" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.AddItemSupplierCommandRequest": { "type": "object", "description": "Adds supplier information to an existing regular item. This command allows the association of suppliers with the item, including details such as purchase prices, delivery times, and order intervals. - Request", "additionalProperties": false, "required": [ "ItemId", "ItemSupplier" ], "properties": { "itemId": { "description": "Unique ID of the item to be modified - this key is used for all further operations with the item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "itemSupplier": { "description": "Supplier information to be added to the item.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemSupplier" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.AddItemVariationCommandRequest": { "type": "object", "description": "Adds a new variation (e.g., color, size) to an existing item. Variations allow customers to select different product options. - Request", "additionalProperties": false, "required": [ "ItemId", "Variation" ], "properties": { "itemId": { "description": "Unique ID of the item to be modified - this key is used for all further operations with the item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "variation": { "description": "The variation to add including type (selectbox, radio, etc.), descriptions in multiple languages, and optional variation values.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateVariation" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.AddItemVariationValueCommandRequest": { "type": "object", "description": "Adds a new value to an existing item variation. - Request", "additionalProperties": false, "required": [ "VariationId", "VariationValue" ], "properties": { "variationId": { "description": "Unique ID of the variation to which the value should be added.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey" }, "variationValue": { "description": "The variation value to add including descriptions in multiple languages, surcharges, GTIN, item number, and weight offset.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateVariationValue" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.ChangeItemCommandRequest": { "type": "object", "description": "Modifies an existing regular item with all specified properties. This command enables complete reconfiguration of an item including identifiers, descriptions, prices, measurements, and miscellaneous information. - Request", "additionalProperties": false, "required": [ "ItemId" ], "properties": { "itemId": { "description": "Unique ID of the item to be modified - this key is used for all further operations with the item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "productGroupId": { "description": "The ID of the product group to which the item should be assigned. Product groups serve for categorical classification of items for reports and analyses.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarengruppeKey" }, "shippingClassId": { "description": "The ID of the shipping class to which the item should be assigned.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandklasseKey" }, "manufacturerId": { "description": "The ID of the manufacturer to which the item should be assigned.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.HerstellerKey" }, "categories": { "description": "Category assignments of the item. Defines all categories to which the item should be assigned for better organization and navigation.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemCategories" }, "identifiers": { "description": "Identifiers of the item with all relevant markings and numbers for unique identification of the item in various systems.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemIdentifiers" }, "descriptions": { "description": "Descriptions of the item in different languages and for different platforms/sales channels. Includes names, short and long descriptions as well as SEO-relevant information.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemDescriptions" }, "prices": { "description": "Price structures of the item for different sales channels, customer groups and individual customers. Includes sales prices, purchase prices and tier prices.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemPrices" }, "measurements": { "description": "Physical dimensions and weight specifications of the item for storage, shipping and product presentation. Important for shipping cost calculations and storage space optimization.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemMeasurements" }, "images": { "description": "tbd", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemImages" }, "customFields": { "description": "Custom fields defined for the item to store additional information. Useful for special requirements or integrations.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemCustomFields" }, "suppliers": { "description": "Suppliers associated with the item including supplier-specific information such as purchase prices, delivery times and order intervals.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemSuppliers" }, "variations": { "description": "Variations of an item", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemVariations" }, "deliveryStatusId": { "description": "Delivery status id determining the availability display of the item (e.g. 'immediately available', '2-3 days'). Tab 'Sonstiges'.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferstatusKey" }, "includeInPriceList": { "type": "boolean", "description": "Indicates whether the item can be included in exported price lists. Tab 'Sonstiges'." }, "ignoreOrderSuggestions": { "type": "boolean", "description": "Indicates whether order suggestions should be ignored for this item. If true, the item will not appear in automatic order suggestions. Tab 'Sonstiges'." }, "ignoreDiscounts": { "type": "boolean", "description": "Indicates whether the item is not eligible for discounts (Rabatte ignorieren / Nicht Rabattfähig). Tab 'Sonstiges'." }, "countryOfOrigin": { "type": "string", "description": "Country of origin (Herkunftsland) - ISO code or country name. Max length 64. Tab 'Sonstiges'." }, "notes": { "type": "string", "description": "Additional notes (Anmerkung) for the item - unlimited length. Tab 'Sonstiges'." }, "features": { "description": "Features of an item", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemFeatures" }, "attributes": { "description": "Attributes of an item", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemAttributes" }, "unitPricing": { "description": "UnitPricing information of an item", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemUnitPricing" }, "specialPrices": { "description": "SpecialPrices information of an item", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemSpecialPrices" }, "storageConstraints": { "description": "ItemStorageConstraints information of an item", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemStorageConstraints" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateAttributeSalesChannelValues": { "type": "object", "description": "Model Class: CreateAttributeSalesChannelValues ", "additionalProperties": false, "required": [ "SalesChannelId" ], "properties": { "salesChannelId": { "description": "Identifies the saleschannel for this attributevalue", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.SalesChannelId" }, "values": { "type": "array", "description": "Contains the values for a saleschannel", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateAttributeValue" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateAttributeValue": { "type": "object", "description": "Model Class: CreateAttributeValue ", "additionalProperties": false, "required": [ "LanguageIso", "Value" ], "properties": { "languageIso": { "type": "string", "description": "ISO2 language code that determines the language for this item description (e.g., \"DE\" for German, \"EN\" for English)." }, "value": { "type": "string", "description": "Value of this attribute as string. Please consider the Attribute Type for correct formatting." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateAttributeValues": { "type": "object", "description": "Model Class: CreateAttributeValues ", "additionalProperties": false, "required": [ "AttributeId" ], "properties": { "attributeId": { "description": "Identifies the attribute", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AttributKey" }, "defaultValues": { "type": "array", "description": "Defines the default values for the attribute and item in different languages.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateAttributeValue" } }, "salesChannelValues": { "type": "array", "description": "Contains all values for saleschannels for this attribute and item", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateAttributeSalesChannelValues" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateCustomerGroupSurcharge": { "type": "object", "description": "Model Class: CreateCustomerGroupSurcharge ", "additionalProperties": false, "required": [ "CustomerGroupId" ], "properties": { "customerGroupId": { "description": "Id of the customergroup", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "surcharge": { "type": "number", "description": "Surcharge for that customergroup", "format": "decimal" }, "isActive": { "type": "boolean", "description": "Defines if the surcharges will be synchronized to online saleschannels. Does not apply for the default customer group surcharges, which are always synchronized when not overriden." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateDefaultDescription": { "type": "object", "description": "Defines a default description of an item in a specific language. This description is used as a fallback when no more specific platform or sales channel descriptions are available.", "additionalProperties": false, "required": [ "LanguageIso", "DescriptionData" ], "properties": { "languageIso": { "type": "string", "description": "ISO2 language code that determines the language for this item description (e.g., \"DE\" for German, \"EN\" for English)." }, "descriptionData": { "description": "Contains the actual description data such as name, short and long description as well as SEO-relevant information.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateDescriptionData" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateDescription": { "type": "object", "description": "Model Class: CreateDescription ", "additionalProperties": false, "required": [ "LanguageIso", "Name" ], "properties": { "languageIso": { "type": "string", "description": "ISO2 language code that determines the language for this item description (e.g., \"DE\" for German, \"EN\" for English)." }, "name": { "type": "string", "description": "Name of the Variation in the specific language" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateDescriptionData": { "type": "object", "description": "Defines the actual description data of an item. This structure contains all textual information of an item including SEO-relevant metadata for online shops.", "additionalProperties": false, "properties": { "itemName": { "type": "string", "description": "The name of the item as displayed in the user interface or shop." }, "shortDescription": { "type": "string", "description": "Short description of the item for overview displays and search results." }, "description": { "type": "string", "description": "Detailed description of the item with comprehensive product information and properties." }, "metaDescription": { "type": "string", "description": "Meta description for search engine optimization (SEO) that is displayed in search results." }, "metaKeywords": { "type": "string", "description": "Meta keywords for search engine optimization to improve discoverability of the item." }, "titleTag": { "type": "string", "description": "HTML title tag for the item that is displayed in the browser tab and search results." }, "urlPath": { "type": "string", "description": "URL path for the item to create SEO-friendly and speaking URLs." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateEbayImages": { "type": "object", "description": "Model Class: CreateEbayImages ", "additionalProperties": false, "required": [ "EbayAccountId" ], "properties": { "ebayAccountId": { "description": "Unique ID to identify an ebay account.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EbayUserKey" }, "images": { "type": "array", "description": "List of images assigned to the platform.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemImage" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemAttributes": { "type": "object", "description": "Model Class: CreateItemAttributes ", "additionalProperties": false, "properties": { "values": { "type": "array", "description": "Contains all attribute values assigned to the item", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateAttributeValues" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCategories": { "type": "object", "description": "Defines the category assignments of an item for creation. This structure manages all categories to which an item can be assigned and enables hierarchical classification for better organization and navigation.", "additionalProperties": false, "required": [ "Categories" ], "properties": { "categories": { "type": "array", "description": "Contains all categories to which the item is assigned. An item can be assigned to multiple categories simultaneously to enable flexible categorization and better discoverability.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCategory" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCategory": { "type": "object", "description": "Defines a single category assignment for an item. This structure represents the link between an item and a specific category in the hierarchical category system of the ERP system.", "additionalProperties": false, "required": [ "CategoryId" ], "properties": { "categoryId": { "description": "Unique key of the category that identifies the specific category to which the item should be assigned. This key establishes the connection to the category data.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCommandRequest": { "type": "object", "description": "Creates a new regular item with all specified properties. This command enables complete configuration of an item including identifiers, descriptions, prices, and measurements. - Request", "additionalProperties": false, "required": [ "Categories", "Identifiers", "Descriptions" ], "properties": { "productGroupId": { "description": "The ID of the product group to which the item should be assigned. Product groups serve for categorical classification of items for reports and analyses.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarengruppeKey" }, "shippingClassId": { "description": "The ID of the shipping class to which the item should be assigned.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandklasseKey" }, "manufacturerId": { "description": "The ID of the manufacturer to which the item should be assigned.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.HerstellerKey" }, "categories": { "description": "Category assignments of the item. Defines all categories to which the item should be assigned for better organization and navigation.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCategories" }, "identifiers": { "description": "Identifiers of the item with all relevant markings and numbers for unique identification of the item in various systems.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemIdentifiers" }, "descriptions": { "description": "Descriptions of the item in different languages and for different platforms/sales channels. Includes names, short and long descriptions as well as SEO-relevant information.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemDescriptions" }, "prices": { "description": "Price structures of the item for different sales channels, customer groups and individual customers. Includes sales prices, purchase prices and tier prices.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemPrices" }, "suppliers": { "description": "Suppliers associated with the item including supplier-specific information such as purchase prices, delivery times and order intervals.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemSuppliers" }, "measurements": { "description": "Physical dimensions and weight specifications of the item for storage, shipping and product presentation. Important for shipping cost calculations and storage space optimization.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemMeasurements" }, "images": { "description": "tbd", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemImages" }, "customFields": { "description": "Custom fields defined for the item to store additional information. Useful for special requirements or integrations.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCustomFields" }, "variations": { "description": "Variations of an item", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemVariations" }, "features": { "description": "Features of an item", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemFeatures" }, "attributes": { "description": "Attributes of an item", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemAttributes" }, "unitPricing": { "description": "UnitPricing information of an item", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemUnitPricing" }, "specialPrices": { "description": "SpecialPrices information of an item", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemSpecialPrices" }, "storageConstraints": { "description": "ItemStorageConstraints information of an item", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemStorageConstraints" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCustomerGroupPrices": { "type": "object", "description": "Defines customer group-specific prices for an item. This structure enables differentiated pricing by customer groups, allowing different price levels for different customer segments.", "additionalProperties": false, "required": [ "CustomerGroupId", "Prices" ], "properties": { "customerGroupId": { "description": "Key of the customer group that identifies the specific customer group (e.g., end customers, resellers, wholesalers).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "prices": { "type": "array", "description": "List of prices for this customer group - can contain different tier prices or volume discounts.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemPrice" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCustomerGroupSpecialPrice": { "type": "object", "description": "Defines a customer group-specific special price for an item. This structure represents a single promotional price for a specific customer group in a sales channel.", "additionalProperties": false, "required": [ "CustomerGroupId" ], "properties": { "customerGroupId": { "description": "Key of the customer group that identifies the specific customer group (e.g., end customers, resellers, wholesalers) for which this special price applies.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "netPrice": { "type": "number", "description": "Net special price for this customer group without taxes. Setting this to null will deactivate the special price for this customer group.", "format": "decimal" }, "isActive": { "type": "boolean", "description": "Indicates whether this special price is active for this customer group. Automatically set to false when NetPrice is set to null." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCustomerPrices": { "type": "object", "description": "Defines customer-specific prices for an item. This structure enables individual price agreements for specific customers that can deviate from standard or customer group prices.", "additionalProperties": false, "required": [ "CustomerId", "Prices" ], "properties": { "customerId": { "description": "Key of the customer that identifies the specific customer for whom these individual prices apply.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "prices": { "type": "array", "description": "List of individual prices for this customer - can contain different tier prices or special conditions.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemPrice" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCustomFields": { "type": "object", "description": "Defines custom fields for an item to store additional, user-defined information. Custom fields allow flexible extension of item data beyond standard properties and can be used for special business requirements, integrations, or custom workflows.", "additionalProperties": false, "required": [ "FieldValues" ], "properties": { "fieldValues": { "type": "array", "description": "List of custom field values assigned to the item. Each entry represents a custom field with its corresponding value.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCustomFieldValue" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCustomFieldValue": { "type": "object", "description": "Defines a single custom field value for an item. This structure connects a custom field definition with its actual value for a specific item.", "additionalProperties": false, "required": [ "FieldId", "Value", "ValueCultureName" ], "properties": { "fieldId": { "description": "Unique identifier of the custom field definition. References the custom field that was previously created in the system.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EigenesFeldKey" }, "value": { "type": "string", "description": "The actual value stored in this custom field. The format and content depend on the custom field type definition (text, number, date, etc.)." }, "valueCultureName": { "type": "string", "description": "The culture name (e.g., \"en-US\", \"de-DE\") associated with the custom field value. This is important for localized fields where the value may vary based on the user's language or region. When returning those values from the server side this Format is always InvariantCulture. When sending values to the server side the culture name is optional and if not provided, it will be treated as InvariantCulture. Otherwise this value initializes a CultureInfo Object." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemDescriptions": { "type": "object", "description": "Defines the collection of all descriptions of an item for creation. This structure manages default, platform, and sales channel-specific item descriptions for different languages and distribution channels.", "additionalProperties": false, "required": [ "DefaultDescriptions" ], "properties": { "defaultDescriptions": { "type": "array", "description": "Default descriptions of the item. This is used when no more specific platform or sales channel descriptions are available and serves as a fallback description.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateDefaultDescription" } }, "salesChannelDescriptions": { "type": "array", "description": "List of sales channel-specific descriptions for sales platforms like JTL-Shop. Enables individual customization of item descriptions for specific sales channels.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateSalesChannelDescription" } }, "platformDescriptions": { "type": "array", "description": "List of platform-specific descriptions for non-sales platforms like print. Allows different descriptions for various output platforms.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreatePlatformDescription" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemFeature": { "type": "object", "description": "Defines a single feature assignment for an item. This structure represents the link between an item and a specific feature value from the feature system, allowing detailed product characterization.", "additionalProperties": false, "required": [ "FeatureId" ], "properties": { "featureId": { "description": "Unique key of the feature value that identifies the specific feature characteristic to be assigned to the item. This key establishes the connection to a predefined feature value in the feature system.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalWertKey" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemFeatures": { "type": "object", "description": "Defines the feature assignments of an item. This structure manages all features (characteristics/attributes) that describe specific properties or attributes of an item, such as color, size, material, or other custom characteristics used for product differentiation and filtering.", "additionalProperties": false, "required": [ "Features" ], "properties": { "features": { "type": "array", "description": "Contains all features assigned to the item. Each feature represents a specific characteristic or attribute that describes the item in more detail, enabling better product differentiation and advanced filtering capabilities.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemFeature" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemIdentifiers": { "type": "object", "description": "Defines various identifiers of an item for creation. This structure includes all relevant markings and numbers used for unique identification of an item.", "additionalProperties": false, "properties": { "sku": { "type": "string", "description": "Unique item number (Stock Keeping Unit) - the user-assigned main identification of the item." }, "amazonFnsku": { "type": "string", "description": "Amazon FNSKU (Fulfillment Network Stock Keeping Unit) - used by Amazon for inventory management." }, "gtin": { "type": "string", "description": "GTIN (Global Trade Item Number, formerly EAN) - internationally standardized product identification for global trade." }, "manufacturerNumber": { "type": "string", "description": "Manufacturer's item number - the official product number assigned by the manufacturer." }, "isbn": { "type": "string", "description": "ISBN (International Standard Book Number) - mainly used for books and other publications." }, "tariccode": { "type": "string", "description": "Taric code - customs tariff number for international trade and customs processing." }, "upc": { "type": "string", "description": "UPC (Universal Product Code) - barcode standard mainly used in North America." }, "unNumber": { "type": "string", "description": "UN number - used for marking dangerous goods in transport." }, "hazardNumber": { "type": "string", "description": "Hazard number - identifies the type of danger for hazardous goods in transport." }, "ownIdentifier": { "type": "string", "description": "Own identifier - user-defined internal identification for company-specific purposes." }, "defaultAsin": { "type": "string", "description": "Default ASIN (Amazon Standard Identification Number) - primary Amazon product identification." }, "jfsku": { "type": "string", "description": "JTL-Fulfillment-SKU (JFSKU) - unique identifier in the JTL Fulfillment Network (FFN) for item identification." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemImage": { "type": "object", "description": "Model Class: CreateItemImage ", "additionalProperties": false, "required": [ "BlobIdentifier", "SortNumber", "IsMainImage" ], "properties": { "blobIdentifier": { "type": "string", "description": "Unique ID to identify an image.", "format": "uuid" }, "sortNumber": { "type": "integer", "description": "Sortnumber of the image.", "format": "int32" }, "isMainImage": { "type": "boolean", "description": "Declares the main image of the item. Typically it is the image with sortnumber 1." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemImages": { "type": "object", "description": "Model Class: CreateItemImages ", "additionalProperties": false, "properties": { "defaultImages": { "type": "array", "description": "List of default images assigned to the item.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemImage" } }, "platformImages": { "type": "array", "description": "List of images assigned to different platforms.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreatePlatformImages" } }, "saleschannelImages": { "type": "array", "description": "List of images assigned to different saleschannels.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateSaleschannelImages" } }, "ebayImages": { "type": "array", "description": "List of images assigned to different eBay accounts.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateEbayImages" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemMeasurements": { "type": "object", "description": "Defines the physical dimensions and weight specifications of an item for creation. This structure includes all relevant measurements for storage, shipping and product presentation and is used for shipping cost calculations and storage space optimizations.", "additionalProperties": false, "properties": { "height": { "type": "number", "description": "Height of the item in the configured unit of measurement (usually centimeters or millimeters).", "format": "decimal" }, "length": { "type": "number", "description": "Length of the item in the configured unit of measurement (usually centimeters or millimeters).", "format": "decimal" }, "shippingWeight": { "type": "number", "description": "Shipping weight of the item for shipping cost calculation in the configured weight unit (usually kilograms or grams). May differ from the actual item weight.", "format": "decimal" }, "weight": { "type": "number", "description": "Actual weight of the item without packaging in the configured weight unit (usually kilograms or grams).", "format": "decimal" }, "width": { "type": "number", "description": "Width of the item in the configured unit of measurement (usually centimeters or millimeters).", "format": "decimal" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemPrice": { "type": "object", "description": "Defines a single price with tiering options and discount possibilities. This structure forms the basis for complex price structures with volume discounts and percentage price reductions from the standard price.", "additionalProperties": false, "required": [ "FromQuantity" ], "properties": { "fromQuantity": { "type": "integer", "description": "Minimum quantity from which this price applies - enables tier prices based on order quantity (e.g., from 10 pieces).", "format": "int32" }, "netPrice": { "type": "number", "description": "Net price for this price tier without taxes - the actual selling price for the specified quantity tier.", "format": "decimal" }, "reduceStandardPriceByPercent": { "type": "number", "description": "Percentage discount on the standard price - indicates by what percentage the standard price is reduced for this price tier. Used as an alternative to NetPrice.", "format": "decimal" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemPrices": { "type": "object", "description": "Defines the complete price structure of an item for creation. This structure includes all price information for different sales channels, customer groups and individual customer prices as well as basic price information.", "additionalProperties": false, "properties": { "ignoreDiscounts": { "type": "boolean", "description": "Indicates whether discounts should be ignored for this item. When set to true, no automatic discounts will be applied to the item prices." }, "salesPriceNet": { "type": "number", "description": "Net sales price of the item without taxes and discounts - the basic selling price of the item.", "format": "decimal" }, "suggestedRetailPrice": { "type": "number", "description": "Manufacturer's suggested retail price (MSRP) - the selling price recommended by the manufacturer.", "format": "decimal" }, "purchasePriceNet": { "type": "number", "description": "Net purchase price without taxes - the price at which the item was purchased.", "format": "decimal" }, "ebayPrice": { "type": "number", "description": "eBay-specific selling price - special price for eBay sales.", "format": "decimal" }, "amazonPrice": { "type": "number", "description": "Amazon-specific selling price - special price for Amazon sales.", "format": "decimal" }, "salesChannelPrices": { "type": "array", "description": "List of sales channel-specific prices - enables different pricing for various sales channels or shops.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemSaleschannelPrices" } }, "customerPrices": { "type": "array", "description": "List of customer-specific prices - allows individual price agreements for specific customers.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCustomerPrices" } }, "defaultPrices": { "type": "array", "description": "List of default prices for different customer groups - these prices serve as fallback when no more specific prices are defined.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCustomerGroupPrices" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemSaleschannelPrices": { "type": "object", "description": "Defines sales channel-specific prices for an item. This structure enables different pricing for various sales channels or shops with customer group-related price structures.", "additionalProperties": false, "required": [ "SaleschannelId", "CustomerGroupPrices" ], "properties": { "saleschannelId": { "description": "Key of the sales channel that identifies the specific sales channel or shop for which this price structure applies.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" }, "customerGroupPrices": { "type": "array", "description": "List of prices for different customer groups within this sales channel - enables differentiated pricing by customer groups.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCustomerGroupPrices" } }, "isActive": { "type": "boolean", "description": "Indicates whether this sales channel is active for the item - determines whether the item can be sold in this sales channel." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemSalesChannelSpecialPrices": { "type": "object", "description": "Defines sales channel-specific special prices for an item. This structure enables different promotional pricing for a specific sales channel or shop with customer group-related special price structures.", "additionalProperties": false, "required": [ "SalesChannelId", "SpecialPrices" ], "properties": { "salesChannelId": { "description": "Key of the sales channel that identifies the specific sales channel or shop for which this special price structure applies.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.SalesChannelId" }, "specialPrices": { "type": "array", "description": "List of special prices for different customer groups within this sales channel - enables differentiated promotional pricing by customer groups.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemCustomerGroupSpecialPrice" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemSpecialPrices": { "type": "object", "description": "Defines the special prices (promotional prices) structure of an item. This structure includes time-based and stock-based special pricing for different sales channels and customer groups, as well as Amazon-specific special prices.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether special prices are active for this item. When set to true, the special price rules defined below will be applied according to their conditions." }, "startDate": { "type": "string", "description": "Date from which the special price becomes active. The special price will only be valid from this date onwards.", "format": "date-time" }, "endDate": { "type": "string", "description": "Date until which the special price remains active. The special price will expire after this date. Only evaluated if IsEndDateActive is true.", "format": "date-time" }, "isEndDateActive": { "type": "boolean", "description": "Indicates whether the end date should be considered. If false, the special price has no expiration date." }, "minimumStockQuantity": { "type": "integer", "description": "Minimum stock quantity that must be available for the special price to remain active. Only evaluated if IsStockRestrictionActive is true.", "format": "int32" }, "isStockRestrictionActive": { "type": "boolean", "description": "Indicates whether the stock restriction should be applied. When true, the special price is only active if the stock level is greater than or equal to MinimumStockQuantity. Can only be activated for items that use stock management." }, "salesChannelSpecialPrices": { "type": "array", "description": "List of sales channel-specific special prices - enables different promotional pricing for various sales channels or shops with customer group differentiation.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemSalesChannelSpecialPrices" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemStorageConstraints": { "type": "object", "description": "Defines the storage and inventory management constraints of an item. This structure includes settings for negative stock handling, inventory management, serial numbers, batch tracking, and best-before date management.", "additionalProperties": false, "properties": { "allowNegativeStock": { "type": "boolean", "description": "Allows selling a higher quantity of the item than is actually in stock. This global setting must be activated first before platform-specific or sales channel-specific negative stock settings can be enabled." }, "itemPlatformNegativeStocks": { "type": "array", "description": "List of platform-specific negative stock settings. Activates the ability to sell a higher quantity of the item for specific platforms (e.g., eBay, Amazon). AllowNegativeStock must be activated as well for these settings to take effect.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateNegativeStockPlatform" } }, "itemSalesChannelNegativeStocks": { "type": "array", "description": "List of sales channel-specific negative stock settings. Activates the ability to sell a higher quantity of the item for specific sales channels or shops. AllowNegativeStock must be activated as well for these settings to take effect.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateNegativeStockSalesChannel" } }, "buffer": { "type": "integer", "description": "Item buffer quantity - defines a safety stock buffer that is reserved and not available for sale. This helps prevent overselling and ensures availability for important orders.", "format": "int32" }, "globalMinimumStockLevel": { "type": "number", "description": "Global minimum stock level across all warehouses. When the total stock falls below this value, the item is flagged for reordering. Used for automatic order suggestions and low-stock warnings.", "format": "decimal" }, "hasBatch": { "type": "boolean", "description": "Indicates whether the item uses batch management. When enabled, the item requires batch numbers to be assigned for each stock movement to enable tracking and traceability." }, "isInventoryManagementActive": { "type": "boolean", "description": "Determines if the item is working with inventory management. When active, stock levels are tracked and managed; when inactive, the item is treated as always available regardless of stock levels." }, "isBestBeforeManaged": { "type": "boolean", "description": "Determines if the item is working with best-before date (MHD - Mindesthaltbarkeitsdatum) management. When enabled, stock items must have an assigned best-before date for tracking perishable goods." }, "isStockDivisible": { "type": "boolean", "description": "Determines if the item can be sold in split quantities (fractional units). When enabled, stock can be managed in decimal quantities (e.g., 2.5 pieces) instead of only whole numbers." }, "serialNumberType": { "type": "integer", "description": "Determines the type of serial number processing. Defines whether serial numbers are inactive, active, or tracked for this item.", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.SerialNumberType" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemSupplier": { "type": "object", "description": "Model Class: CreateItemSupplier ", "additionalProperties": false, "required": [ "SupplierId" ], "properties": { "supplierId": { "description": "Id of the supplier", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "supplierItemName": { "type": "string", "description": "Name of the item at the supplier (max 255 characters)." }, "supplierItemNumber": { "type": "string", "description": "Item number at the supplier (max 255 characters)." }, "stockLevel": { "type": "number", "description": "Stock level of the item at the supplier.", "format": "decimal" }, "netPurchasePrice": { "type": "number", "description": "Net purchase price of the item at the supplier.", "format": "decimal" }, "minimumPurchaseQuantity": { "type": "integer", "description": "Minimum purchase quantity of the item at the supplier.", "format": "int32" }, "deliveryTimeInDays": { "type": "integer", "description": "Delivery time for this item at the supplier (in days).", "format": "int32" }, "isDropshippingActive": { "type": "boolean", "description": "Indicates if this item uses dropshipping from the supplier." }, "packageUnitDescription": { "type": "string", "description": "Description of the packaging unit." }, "packageUnitQuantity": { "type": "number", "description": "Quantity per packaging unit.", "format": "decimal" }, "notes": { "type": "string", "description": "Additional notes (max 512 characters)." }, "vatRate": { "type": "number", "description": "VAT rate of the item at the supplier.", "format": "decimal" }, "useSupplierDeliveryTime": { "type": "boolean", "description": "Whether to use the supplier's delivery time directly." }, "includeSupplierStock": { "type": "boolean", "description": "Whether to include the supplier's stock in own inventory." }, "purchaseInterval": { "type": "number", "description": "Purchase interval for this item at the supplier.", "format": "decimal" }, "scalePrices": { "type": "array", "description": "Scale prices defined by the supplier for this item.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateSupplierPrice" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemSuppliers": { "type": "object", "description": "Model Class: CreateItemSuppliers ", "additionalProperties": false, "properties": { "defaultSupplier": { "description": "Sets the default supplier for the item.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "defaultDropshippingSupplier": { "description": "Sets the default supplier for dropshipping for the item.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "suppliers": { "type": "array", "description": "Assigned suppliers for the item", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemSupplier" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemUnitPricing": { "type": "object", "description": "Defines the item unit pricing settings for creation and modification. This structure includes all relevant information about the sales unit, packaging unit, inner quantity and base price details for an item.", "additionalProperties": false, "properties": { "salesUnitId": { "description": "Id of the sales unit in which the item is sold (e.g. piece or box).", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EinheitKey" }, "packagingUnitId": { "description": "Id of the packaging unit of the item.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EinheitKey" }, "innerQuantity": { "type": "number", "description": "The amount of content for one piece of the sales unit, relative to the inner quantity unit.", "format": "decimal" }, "innerQuantityUnitId": { "description": "The measurement unit for the inner quantity (e.g. kg or liter).", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MassEinheitKey" }, "isBasePriceDeclared": { "type": "boolean", "description": "Indicates whether the base price should be automatically calculated and displayed." }, "basePriceReferenceUnitId": { "description": "The measurement unit to which the base price refers (e.g. per liter or per 100 grams).", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MassEinheitKey" }, "basePriceReferenceAmount": { "type": "number", "description": "The reference amount used when calculating the base price (e.g. 1 for per liter, 100 for per 100 grams).", "format": "decimal" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemVariations": { "type": "object", "description": "Model Class: CreateItemVariations ", "additionalProperties": false, "properties": { "variations": { "type": "array", "description": "Contains all Variations", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateVariation" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateNegativeStockPlatform": { "type": "object", "description": "Defines negative stock settings for a specific platform. This structure enables individual configuration of negative stock handling per platform (e.g., eBay, Amazon), allowing overselling for specific marketplaces when the global AllowNegativeStock is enabled.", "additionalProperties": false, "required": [ "PlatformId", "IsNegativeStockAllowed" ], "properties": { "platformId": { "description": "Key of the platform that identifies the specific marketplace or platform (e.g., eBay, Amazon) for which this negative stock setting applies.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PlattformKey" }, "isNegativeStockAllowed": { "type": "boolean", "description": "Determines if negative stock is allowed for this platform. When true, orders can be accepted even when the item is out of stock on this specific marketplace." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateNegativeStockSalesChannel": { "type": "object", "description": "Defines negative stock settings for a specific sales channel. This structure enables individual configuration of negative stock handling per sales channel, allowing overselling for specific online shops when the global AllowNegativeStock is enabled.", "additionalProperties": false, "required": [ "SalesChannelId", "IsNegativeStockAllowed" ], "properties": { "salesChannelId": { "description": "Key of the sales channel that identifies the specific shop or sales channel for which this negative stock setting applies.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.SalesChannelId" }, "isNegativeStockAllowed": { "type": "boolean", "description": "Determines if negative stock is allowed for this sales channel. When true, orders can be accepted even when the item is out of stock in this specific channel." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreatePlatformDescription": { "type": "object", "description": "Defines a platform-specific description of an item. This enables different descriptions for various output platforms like print or other non-sales platforms.", "additionalProperties": false, "required": [ "PlatformId", "LanguageIso", "DescriptionData" ], "properties": { "platformId": { "description": "Unique key of the platform for which this description is intended (e.g., print, labels).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PlattformKey" }, "languageIso": { "type": "string", "description": "ISO2 language code that determines the language for this item description (e.g., \"DE\" for German, \"EN\" for English)." }, "descriptionData": { "description": "Contains the platform-specific description data with all relevant texts and SEO information.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateDescriptionData" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreatePlatformImages": { "type": "object", "description": "Model Class: CreatePlatformImages ", "additionalProperties": false, "required": [ "PlatformId" ], "properties": { "platformId": { "description": "Unique ID to identify a platform.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PlattformKey" }, "images": { "type": "array", "description": "List of images assigned to the platform.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemImage" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateSalesChannelDescription": { "type": "object", "description": "Defines a sales channel-specific description of an item. This enables individual customization of item descriptions for specific sales channels or shops.", "additionalProperties": false, "required": [ "SalesChannelId", "LanguageIso", "DescriptionData" ], "properties": { "salesChannelId": { "description": "Unique key of the sales channel or shop for which this description is intended.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.SalesChannelId" }, "languageIso": { "type": "string", "description": "ISO2 language code that determines the language for this sales channel-specific description." }, "descriptionData": { "description": "Contains the sales channel-specific description data with all relevant texts and SEO information.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateDescriptionData" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateSaleschannelImages": { "type": "object", "description": "Model Class: CreateSaleschannelImages ", "additionalProperties": false, "required": [ "SaleschannelId" ], "properties": { "saleschannelId": { "description": "Unique ID to identify a saleschannel.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.SalesChannelId" }, "images": { "type": "array", "description": "List of images assigned to the platform.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateItemImage" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateSalesChannelSurcharge": { "type": "object", "description": "Model Class: CreateSalesChannelSurcharge ", "additionalProperties": false, "required": [ "SalesChannelId", "Surcharges" ], "properties": { "salesChannelId": { "description": "Id of the saleschannel", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.SalesChannelId" }, "surcharges": { "type": "array", "description": "Contains the surcharges for that saleschannel and customergroup", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateCustomerGroupSurcharge" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateSupplierPrice": { "type": "object", "description": "Model Class: CreateSupplierPrice ", "additionalProperties": false, "required": [ "FromQuantity", "UsePercentageDiscount" ], "properties": { "fromQuantity": { "type": "number", "description": "Quantity from which the price applies. This value is not editable. To change it, a new scale must be created.", "format": "decimal" }, "netPrice": { "type": "number", "description": "Net price for this scale.", "format": "decimal" }, "usePercentageDiscount": { "type": "boolean", "description": "Indicates whether the scale uses a percentage discount of the NetPurchasePrice." }, "percentageDiscount": { "type": "number", "description": "The percentage discount applied in this scale.", "format": "decimal" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateVariation": { "type": "object", "description": "Model Class: CreateVariation ", "additionalProperties": false, "required": [ "Descriptions", "VariationType" ], "properties": { "variationId": { "description": "Id of the Variation", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey" }, "position": { "type": "integer", "description": "Position of this Variation in the List", "format": "int32" }, "descriptions": { "type": "array", "description": "Descriptions of this Variation in multiple Languages", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateDescription" } }, "values": { "type": "array", "description": "Values for this Variation", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateVariationValue" } }, "variationType": { "description": "Type of the Variation", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.VariationType" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateVariationValue": { "type": "object", "description": "Model Class: CreateVariationValue ", "additionalProperties": false, "required": [ "Descriptions" ], "properties": { "variationValueId": { "description": "Id of the VariationValue", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationWertKey" }, "itemNumber": { "type": "string", "description": "Itemnumber for this variationvalue" }, "gTIN": { "type": "string", "description": "GTIN for this variationvalue" }, "weightOffset": { "type": "number", "description": "Offset for the weight of this variationvalue", "format": "decimal" }, "descriptions": { "type": "array", "description": "Descriptions of this VariationValue in multiple Languages", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateDescription" } }, "surcharges": { "description": "Surcharges of this VariationValue", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateVariationValueSurcharges" }, "position": { "type": "integer", "description": "Position of this VariationValue in the List", "format": "int32" }, "image": { "description": "Image for this variation value. This image will be used as the main image for the variation combination if this variation value is part of it and the variation combination doesn't have its own image.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.BildKey" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateVariationValueSurcharges": { "type": "object", "description": "Model Class: CreateVariationValueSurcharges ", "additionalProperties": false, "properties": { "defaultSurchargeNet": { "type": "number", "description": "Default Surcharge if there is none specified for a specific saleschannel + customergroup", "format": "decimal" }, "customerGroupSurcharges": { "type": "array", "description": "Default Surcharges for specific customergroups in general, independent of saleschannel", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateCustomerGroupSurcharge" } }, "salesChannelSurcharges": { "type": "array", "description": "Surcharge for specific saleschannels + customergroups", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.CreateSalesChannelSurcharge" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.DeleteItemVariationCommandRequest": { "type": "object", "description": "Removes an existing variation from an item. All associated variation values and combinations will also be removed. - Request", "additionalProperties": false, "required": [ "VariationId" ], "properties": { "variationId": { "description": "Unique ID of the variation to be deleted.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.DeleteItemVariationValueCommandRequest": { "type": "object", "description": "Removes a specific value from an item variation. - Request", "additionalProperties": false, "required": [ "VariationValueId" ], "properties": { "variationValueId": { "description": "Unique ID of the variation value to be deleted.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationWertKey" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.SerialNumberType": { "type": "integer", "description": "0 = NoSerialNumbers, 1 = SerialNumbersActive, 2 = SerialNumbersTracking", "format": "int32", "x-enumNames": [ "NoSerialNumbers", "SerialNumbersActive", "SerialNumbersTracking" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateAttributeSalesChannelValues": { "type": "object", "description": "Model Class: UpdateAttributeSalesChannelValues ", "additionalProperties": false, "required": [ "SalesChannelId" ], "properties": { "salesChannelId": { "description": "Identifies the saleschannel for this attributevalue", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.SalesChannelId" }, "values": { "type": "array", "description": "Contains the values for a saleschannel", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateAttributeValue" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateAttributeValue": { "type": "object", "description": "Model Class: UpdateAttributeValue ", "additionalProperties": false, "required": [ "LanguageIso", "Value" ], "properties": { "languageIso": { "type": "string", "description": "ISO2 language code that determines the language for this item description (e.g., \"DE\" for German, \"EN\" for English)." }, "value": { "type": "string", "description": "Value of this attribute as string. Please consider the Attribute Type for correct formatting." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateAttributeValues": { "type": "object", "description": "Model Class: UpdateAttributeValues ", "additionalProperties": false, "required": [ "AttributeId" ], "properties": { "attributeId": { "description": "Identifies the attribute", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AttributKey" }, "defaultValues": { "type": "array", "description": "Defines the default values for the attribute and item in different languages.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateAttributeValue" } }, "salesChannelValues": { "type": "array", "description": "Contains all values for saleschannels for this attribute and item", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateAttributeSalesChannelValues" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateCustomerGroupSurcharge": { "type": "object", "description": "Model Class: UpdateCustomerGroupSurcharge ", "additionalProperties": false, "required": [ "CustomerGroupId" ], "properties": { "customerGroupId": { "description": "Id of the customergroup", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "surcharge": { "type": "number", "description": "Surcharge for that customergroup", "format": "decimal" }, "isActive": { "type": "boolean", "description": "Defines if the surcharges will be synchronized to online saleschannels. Does not apply for the default customer group surcharges, which are always synchronized when not overriden." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateDefaultDescription": { "type": "object", "description": "Defines a default description of an item in a specific language. This description is used as a fallback when no more specific platform or sales channel descriptions are available.", "additionalProperties": false, "required": [ "LanguageIso", "DescriptionData" ], "properties": { "languageIso": { "type": "string", "description": "ISO2 language code that determines the language for this item description (e.g., \"DE\" for German, \"EN\" for English)." }, "descriptionData": { "description": "Contains the actual description data such as name, short and long description as well as SEO-relevant information.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateDescriptionData" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateDescription": { "type": "object", "description": "Model Class: UpdateDescription ", "additionalProperties": false, "required": [ "LanguageIso", "Name" ], "properties": { "languageIso": { "type": "string", "description": "ISO2 language code that determines the language for this item description (e.g., \"DE\" for German, \"EN\" for English)." }, "name": { "type": "string", "description": "Name of the Variation in the specific language" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateDescriptionData": { "type": "object", "description": "Defines the actual description data of an item. This structure contains all textual information of an item including SEO-relevant metadata for online shops.", "additionalProperties": false, "properties": { "itemName": { "type": "string", "description": "The name of the item as displayed in the user interface or shop." }, "shortDescription": { "type": "string", "description": "Short description of the item for overview displays and search results." }, "description": { "type": "string", "description": "Detailed description of the item with comprehensive product information and properties." }, "metaDescription": { "type": "string", "description": "Meta description for search engine optimization (SEO) that is displayed in search results." }, "metaKeywords": { "type": "string", "description": "Meta keywords for search engine optimization to improve discoverability of the item." }, "titleTag": { "type": "string", "description": "HTML title tag for the item that is displayed in the browser tab and search results." }, "urlPath": { "type": "string", "description": "URL path for the item to create SEO-friendly and speaking URLs." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateEbayImages": { "type": "object", "description": "Model Class: UpdateEbayImages ", "additionalProperties": false, "required": [ "EbayAccountId" ], "properties": { "ebayAccountId": { "description": "Unique ID to identify an ebay account.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EbayUserKey" }, "images": { "type": "array", "description": "List of images assigned to the platform.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemImage" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemAttributes": { "type": "object", "description": "Model Class: UpdateItemAttributes ", "additionalProperties": false, "properties": { "values": { "type": "array", "description": "Contains all attribute values assigned to the item", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateAttributeValues" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemCategories": { "type": "object", "description": "Defines the category assignments of an item for creation. This structure manages all categories to which an item can be assigned and enables hierarchical classification for better organization and navigation.", "additionalProperties": false, "properties": { "categories": { "type": "array", "description": "Contains all categories to which the item is assigned. An item can be assigned to multiple categories simultaneously to enable flexible categorization and better discoverability.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemCategory" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemCategory": { "type": "object", "description": "Defines a single category assignment for an item. This structure represents the link between an item and a specific category in the hierarchical category system of the ERP system.", "additionalProperties": false, "required": [ "CategoryId" ], "properties": { "categoryId": { "description": "Unique key of the category that identifies the specific category to which the item should be assigned. This key establishes the connection to the category data.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemCustomerGroupPrices": { "type": "object", "description": "Defines customer group-specific prices for an item. This structure enables differentiated pricing by customer groups, allowing different price levels for different customer segments.", "additionalProperties": false, "required": [ "CustomerGroupId", "Prices" ], "properties": { "customerGroupId": { "description": "Key of the customer group that identifies the specific customer group (e.g., end customers, resellers, wholesalers).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "prices": { "type": "array", "description": "List of prices for this customer group - can contain different tier prices or volume discounts.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemPrice" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemCustomerGroupSpecialPrice": { "type": "object", "description": "Defines a customer group-specific special price for an item. This structure represents a single promotional price for a specific customer group in a sales channel.", "additionalProperties": false, "required": [ "CustomerGroupId" ], "properties": { "customerGroupId": { "description": "Key of the customer group that identifies the specific customer group (e.g., end customers, resellers, wholesalers) for which this special price applies.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "netPrice": { "type": "number", "description": "Net special price for this customer group without taxes. Setting this to null will deactivate the special price for this customer group.", "format": "decimal" }, "isActive": { "type": "boolean", "description": "Indicates whether this special price is active for this customer group. Automatically set to false when NetPrice is set to null." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemCustomerPrices": { "type": "object", "description": "Defines customer-specific prices for an item. This structure enables individual price agreements for specific customers that can deviate from standard or customer group prices.", "additionalProperties": false, "required": [ "CustomerId", "Prices" ], "properties": { "customerId": { "description": "Key of the customer that identifies the specific customer for whom these individual prices apply.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "prices": { "type": "array", "description": "List of individual prices for this customer - can contain different tier prices or special conditions.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemPrice" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemCustomFields": { "type": "object", "description": "Defines custom fields for an item to store additional, user-defined information. Custom fields allow flexible extension of item data beyond standard properties and can be used for special business requirements, integrations, or custom workflows.", "additionalProperties": false, "required": [ "FieldValues" ], "properties": { "fieldValues": { "type": "array", "description": "List of custom field values assigned to the item. Each entry represents a custom field with its corresponding value.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemCustomFieldValue" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemCustomFieldValue": { "type": "object", "description": "Defines a single custom field value for an item. This structure connects a custom field definition with its actual value for a specific item.", "additionalProperties": false, "required": [ "FieldId", "Value", "ValueCultureName" ], "properties": { "fieldId": { "description": "Unique identifier of the custom field definition. References the custom field that was previously created in the system.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EigenesFeldKey" }, "value": { "type": "string", "description": "The actual value stored in this custom field. The format and content depend on the custom field type definition (text, number, date, etc.)." }, "valueCultureName": { "type": "string", "description": "The culture name (e.g., \"en-US\", \"de-DE\") associated with the custom field value. This is important for localized fields where the value may vary based on the user's language or region. When returning those values from the server side this Format is always InvariantCulture. When sending values to the server side the culture name is optional and if not provided, it will be treated as InvariantCulture. Otherwise this value initializes a CultureInfo Object." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemDescriptions": { "type": "object", "description": "Defines the collection of all descriptions of an item for creation. This structure manages default, platform, and sales channel-specific item descriptions for different languages and distribution channels.", "additionalProperties": false, "properties": { "defaultDescriptions": { "type": "array", "description": "Default descriptions of the item. This is used when no more specific platform or sales channel descriptions are available and serves as a fallback description.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateDefaultDescription" } }, "salesChannelDescriptions": { "type": "array", "description": "List of sales channel-specific descriptions for sales platforms like JTL-Shop. Enables individual customization of item descriptions for specific sales channels.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateSalesChannelDescription" } }, "platformDescriptions": { "type": "array", "description": "List of platform-specific descriptions for non-sales platforms like print. Allows different descriptions for various output platforms.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdatePlatformDescription" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemFeature": { "type": "object", "description": "Defines a single feature assignment for an item. This structure represents the link between an item and a specific feature value from the feature system, allowing detailed product characterization.", "additionalProperties": false, "required": [ "FeatureId" ], "properties": { "featureId": { "description": "Unique key of the feature value that identifies the specific feature characteristic to be assigned to the item. This key establishes the connection to a predefined feature value in the feature system.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalWertKey" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemFeatures": { "type": "object", "description": "Defines the feature assignments of an item. This structure manages all features (characteristics/attributes) that describe specific properties or attributes of an item, such as color, size, material, or other custom characteristics used for product differentiation and filtering.", "additionalProperties": false, "properties": { "features": { "type": "array", "description": "Contains all features assigned to the item. Each feature represents a specific characteristic or attribute that describes the item in more detail, enabling better product differentiation and advanced filtering capabilities.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemFeature" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemIdentifiers": { "type": "object", "description": "Defines various identifiers of an item for creation. This structure includes all relevant markings and numbers used for unique identification of an item.", "additionalProperties": false, "properties": { "sku": { "type": "string", "description": "Unique item number (Stock Keeping Unit) - the user-assigned main identification of the item." }, "amazonFnsku": { "type": "string", "description": "Amazon FNSKU (Fulfillment Network Stock Keeping Unit) - used by Amazon for inventory management." }, "gtin": { "type": "string", "description": "GTIN (Global Trade Item Number, formerly EAN) - internationally standardized product identification for global trade." }, "manufacturerNumber": { "type": "string", "description": "Manufacturer's item number - the official product number assigned by the manufacturer." }, "isbn": { "type": "string", "description": "ISBN (International Standard Book Number) - mainly used for books and other publications." }, "tariccode": { "type": "string", "description": "Taric code - customs tariff number for international trade and customs processing." }, "upc": { "type": "string", "description": "UPC (Universal Product Code) - barcode standard mainly used in North America." }, "unNumber": { "type": "string", "description": "UN number - used for marking dangerous goods in transport." }, "hazardNumber": { "type": "string", "description": "Hazard number - identifies the type of danger for hazardous goods in transport." }, "ownIdentifier": { "type": "string", "description": "Own identifier - user-defined internal identification for company-specific purposes." }, "defaultAsin": { "type": "string", "description": "Default ASIN (Amazon Standard Identification Number) - primary Amazon product identification." }, "jfsku": { "type": "string", "description": "JTL-Fulfillment-SKU (JFSKU) - unique identifier in the JTL Fulfillment Network (FFN) for item identification." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemImage": { "type": "object", "description": "Model Class: UpdateItemImage ", "additionalProperties": false, "required": [ "BlobIdentifier", "SortNumber", "IsMainImage" ], "properties": { "blobIdentifier": { "type": "string", "description": "Unique ID to identify an image.", "format": "uuid" }, "sortNumber": { "type": "integer", "description": "Sortnumber of the image.", "format": "int32" }, "isMainImage": { "type": "boolean", "description": "Declares the main image of the item. Typically it is the image with sortnumber 1." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemImages": { "type": "object", "description": "Model Class: UpdateItemImages ", "additionalProperties": false, "properties": { "defaultImages": { "type": "array", "description": "List of default images assigned to the item.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemImage" } }, "platformImages": { "type": "array", "description": "List of images assigned to different platforms.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdatePlatformImages" } }, "saleschannelImages": { "type": "array", "description": "List of images assigned to different saleschannels.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateSaleschannelImages" } }, "ebayImages": { "type": "array", "description": "List of images assigned to different eBay accounts.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateEbayImages" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemMeasurements": { "type": "object", "description": "Defines the physical dimensions and weight specifications of an item for creation. This structure includes all relevant measurements for storage, shipping and product presentation and is used for shipping cost calculations and storage space optimizations.", "additionalProperties": false, "properties": { "height": { "type": "number", "description": "Height of the item in the configured unit of measurement (usually centimeters or millimeters).", "format": "decimal" }, "length": { "type": "number", "description": "Length of the item in the configured unit of measurement (usually centimeters or millimeters).", "format": "decimal" }, "shippingWeight": { "type": "number", "description": "Shipping weight of the item for shipping cost calculation in the configured weight unit (usually kilograms or grams). May differ from the actual item weight.", "format": "decimal" }, "weight": { "type": "number", "description": "Actual weight of the item without packaging in the configured weight unit (usually kilograms or grams).", "format": "decimal" }, "width": { "type": "number", "description": "Width of the item in the configured unit of measurement (usually centimeters or millimeters).", "format": "decimal" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemPrice": { "type": "object", "description": "Defines a single price with tiering options and discount possibilities. This structure forms the basis for complex price structures with volume discounts and percentage price reductions from the standard price.", "additionalProperties": false, "required": [ "FromQuantity" ], "properties": { "fromQuantity": { "type": "integer", "description": "Minimum quantity from which this price applies - enables tier prices based on order quantity (e.g., from 10 pieces).", "format": "int32" }, "netPrice": { "type": "number", "description": "Net price for this price tier without taxes - the actual selling price for the specified quantity tier.", "format": "decimal" }, "reduceStandardPriceByPercent": { "type": "number", "description": "Percentage discount on the standard price - indicates by what percentage the standard price is reduced for this price tier. Used as an alternative to NetPrice.", "format": "decimal" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemPrices": { "type": "object", "description": "Defines the complete price structure of an item for creation. This structure includes all price information for different sales channels, customer groups and individual customer prices as well as basic price information.", "additionalProperties": false, "properties": { "ignoreDiscounts": { "type": "boolean", "description": "Indicates whether discounts should be ignored for this item. When set to true, no automatic discounts will be applied to the item prices." }, "salesPriceNet": { "type": "number", "description": "Net sales price of the item without taxes and discounts - the basic selling price of the item.", "format": "decimal" }, "suggestedRetailPrice": { "type": "number", "description": "Manufacturer's suggested retail price (MSRP) - the selling price recommended by the manufacturer.", "format": "decimal" }, "purchasePriceNet": { "type": "number", "description": "Net purchase price without taxes - the price at which the item was purchased.", "format": "decimal" }, "ebayPrice": { "type": "number", "description": "eBay-specific selling price - special price for eBay sales.", "format": "decimal" }, "amazonPrice": { "type": "number", "description": "Amazon-specific selling price - special price for Amazon sales.", "format": "decimal" }, "salesChannelPrices": { "type": "array", "description": "List of sales channel-specific prices - enables different pricing for various sales channels or shops.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemSaleschannelPrices" } }, "customerPrices": { "type": "array", "description": "List of customer-specific prices - allows individual price agreements for specific customers.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemCustomerPrices" } }, "defaultPrices": { "type": "array", "description": "List of default prices for different customer groups - these prices serve as fallback when no more specific prices are defined.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemCustomerGroupPrices" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemSaleschannelPrices": { "type": "object", "description": "Defines sales channel-specific prices for an item. This structure enables different pricing for various sales channels or shops with customer group-related price structures.", "additionalProperties": false, "required": [ "SaleschannelId", "CustomerGroupPrices" ], "properties": { "saleschannelId": { "description": "Key of the sales channel that identifies the specific sales channel or shop for which this price structure applies.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" }, "customerGroupPrices": { "type": "array", "description": "List of prices for different customer groups within this sales channel - enables differentiated pricing by customer groups.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemCustomerGroupPrices" } }, "isActive": { "type": "boolean", "description": "Indicates whether this sales channel is active for the item - determines whether the item can be sold in this sales channel." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemSalesChannelSpecialPrices": { "type": "object", "description": "Defines sales channel-specific special prices for an item. This structure enables different promotional pricing for a specific sales channel or shop with customer group-related special price structures.", "additionalProperties": false, "required": [ "SalesChannelId", "SpecialPrices" ], "properties": { "salesChannelId": { "description": "Key of the sales channel that identifies the specific sales channel or shop for which this special price structure applies.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.SalesChannelId" }, "specialPrices": { "type": "array", "description": "List of special prices for different customer groups within this sales channel - enables differentiated promotional pricing by customer groups.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemCustomerGroupSpecialPrice" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemSpecialPrices": { "type": "object", "description": "Defines the special prices (promotional prices) structure of an item. This structure includes time-based and stock-based special pricing for different sales channels and customer groups, as well as Amazon-specific special prices.", "additionalProperties": false, "properties": { "isActive": { "type": "boolean", "description": "Indicates whether special prices are active for this item. When set to true, the special price rules defined below will be applied according to their conditions." }, "startDate": { "type": "string", "description": "Date from which the special price becomes active. The special price will only be valid from this date onwards.", "format": "date-time" }, "endDate": { "type": "string", "description": "Date until which the special price remains active. The special price will expire after this date. Only evaluated if IsEndDateActive is true.", "format": "date-time" }, "isEndDateActive": { "type": "boolean", "description": "Indicates whether the end date should be considered. If false, the special price has no expiration date." }, "minimumStockQuantity": { "type": "integer", "description": "Minimum stock quantity that must be available for the special price to remain active. Only evaluated if IsStockRestrictionActive is true.", "format": "int32" }, "isStockRestrictionActive": { "type": "boolean", "description": "Indicates whether the stock restriction should be applied. When true, the special price is only active if the stock level is greater than or equal to MinimumStockQuantity. Can only be activated for items that use stock management." }, "salesChannelSpecialPrices": { "type": "array", "description": "List of sales channel-specific special prices - enables different promotional pricing for various sales channels or shops with customer group differentiation.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemSalesChannelSpecialPrices" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemStorageConstraints": { "type": "object", "description": "Defines the storage and inventory management constraints of an item. This structure includes settings for negative stock handling, inventory management, serial numbers, batch tracking, and best-before date management.", "additionalProperties": false, "properties": { "allowNegativeStock": { "type": "boolean", "description": "Allows selling a higher quantity of the item than is actually in stock. This global setting must be activated first before platform-specific or sales channel-specific negative stock settings can be enabled." }, "itemPlatformNegativeStocks": { "type": "array", "description": "List of platform-specific negative stock settings. Activates the ability to sell a higher quantity of the item for specific platforms (e.g., eBay, Amazon). AllowNegativeStock must be activated as well for these settings to take effect.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateNegativeStockPlatform" } }, "itemSalesChannelNegativeStocks": { "type": "array", "description": "List of sales channel-specific negative stock settings. Activates the ability to sell a higher quantity of the item for specific sales channels or shops. AllowNegativeStock must be activated as well for these settings to take effect.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateNegativeStockSalesChannel" } }, "buffer": { "type": "integer", "description": "Item buffer quantity - defines a safety stock buffer that is reserved and not available for sale. This helps prevent overselling and ensures availability for important orders.", "format": "int32" }, "globalMinimumStockLevel": { "type": "number", "description": "Global minimum stock level across all warehouses. When the total stock falls below this value, the item is flagged for reordering. Used for automatic order suggestions and low-stock warnings.", "format": "decimal" }, "hasBatch": { "type": "boolean", "description": "Indicates whether the item uses batch management. When enabled, the item requires batch numbers to be assigned for each stock movement to enable tracking and traceability." }, "isInventoryManagementActive": { "type": "boolean", "description": "Determines if the item is working with inventory management. When active, stock levels are tracked and managed; when inactive, the item is treated as always available regardless of stock levels." }, "isBestBeforeManaged": { "type": "boolean", "description": "Determines if the item is working with best-before date (MHD - Mindesthaltbarkeitsdatum) management. When enabled, stock items must have an assigned best-before date for tracking perishable goods." }, "isStockDivisible": { "type": "boolean", "description": "Determines if the item can be sold in split quantities (fractional units). When enabled, stock can be managed in decimal quantities (e.g., 2.5 pieces) instead of only whole numbers." }, "serialNumberType": { "type": "integer", "description": "Determines the type of serial number processing. Defines whether serial numbers are inactive, active, or tracked for this item.", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.SerialNumberType" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemSupplier": { "type": "object", "description": "Model Class: UpdateItemSupplier ", "additionalProperties": false, "required": [ "SupplierId" ], "properties": { "supplierId": { "description": "Id of the supplier", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "supplierItemName": { "type": "string", "description": "Name of the item at the supplier (max 255 characters)." }, "supplierItemNumber": { "type": "string", "description": "Item number at the supplier (max 255 characters)." }, "stockLevel": { "type": "number", "description": "Stock level of the item at the supplier.", "format": "decimal" }, "netPurchasePrice": { "type": "number", "description": "Net purchase price of the item at the supplier.", "format": "decimal" }, "minimumPurchaseQuantity": { "type": "integer", "description": "Minimum purchase quantity of the item at the supplier.", "format": "int32" }, "deliveryTimeInDays": { "type": "integer", "description": "Delivery time for this item at the supplier (in days).", "format": "int32" }, "isDropshippingActive": { "type": "boolean", "description": "Indicates if this item uses dropshipping from the supplier." }, "packageUnitDescription": { "type": "string", "description": "Description of the packaging unit." }, "packageUnitQuantity": { "type": "number", "description": "Quantity per packaging unit.", "format": "decimal" }, "notes": { "type": "string", "description": "Additional notes (max 512 characters)." }, "vatRate": { "type": "number", "description": "VAT rate of the item at the supplier.", "format": "decimal" }, "useSupplierDeliveryTime": { "type": "boolean", "description": "Whether to use the supplier's delivery time directly." }, "includeSupplierStock": { "type": "boolean", "description": "Whether to include the supplier's stock in own inventory." }, "purchaseInterval": { "type": "number", "description": "Purchase interval for this item at the supplier.", "format": "decimal" }, "scalePrices": { "type": "array", "description": "Scale prices defined by the supplier for this item.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateSupplierPrice" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemSuppliers": { "type": "object", "description": "Model Class: UpdateItemSuppliers ", "additionalProperties": false, "properties": { "defaultSupplier": { "description": "Sets the default supplier for the item.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "defaultDropshippingSupplier": { "description": "Sets the default supplier for dropshipping for the item.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "suppliers": { "type": "array", "description": "Assigned suppliers for the item", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemSupplier" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemUnitPricing": { "type": "object", "description": "Defines the item unit pricing settings for creation and modification. This structure includes all relevant information about the sales unit, packaging unit, inner quantity and base price details for an item.", "additionalProperties": false, "properties": { "salesUnitId": { "description": "Id of the sales unit in which the item is sold (e.g. piece or box).", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EinheitKey" }, "packagingUnitId": { "description": "Id of the packaging unit of the item.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EinheitKey" }, "innerQuantity": { "type": "number", "description": "The amount of content for one piece of the sales unit, relative to the inner quantity unit.", "format": "decimal" }, "innerQuantityUnitId": { "description": "The measurement unit for the inner quantity (e.g. kg or liter).", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MassEinheitKey" }, "isBasePriceDeclared": { "type": "boolean", "description": "Indicates whether the base price should be automatically calculated and displayed." }, "basePriceReferenceUnitId": { "description": "The measurement unit to which the base price refers (e.g. per liter or per 100 grams).", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MassEinheitKey" }, "basePriceReferenceAmount": { "type": "number", "description": "The reference amount used when calculating the base price (e.g. 1 for per liter, 100 for per 100 grams).", "format": "decimal" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemVariations": { "type": "object", "description": "Model Class: UpdateItemVariations ", "additionalProperties": false, "properties": { "variations": { "type": "array", "description": "Contains all Variations", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateVariation" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateNegativeStockPlatform": { "type": "object", "description": "Defines negative stock settings for a specific platform. This structure enables individual configuration of negative stock handling per platform (e.g., eBay, Amazon), allowing overselling for specific marketplaces when the global AllowNegativeStock is enabled.", "additionalProperties": false, "required": [ "PlatformId", "IsNegativeStockAllowed" ], "properties": { "platformId": { "description": "Key of the platform that identifies the specific marketplace or platform (e.g., eBay, Amazon) for which this negative stock setting applies.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PlattformKey" }, "isNegativeStockAllowed": { "type": "boolean", "description": "Determines if negative stock is allowed for this platform. When true, orders can be accepted even when the item is out of stock on this specific marketplace." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateNegativeStockSalesChannel": { "type": "object", "description": "Defines negative stock settings for a specific sales channel. This structure enables individual configuration of negative stock handling per sales channel, allowing overselling for specific online shops when the global AllowNegativeStock is enabled.", "additionalProperties": false, "required": [ "SalesChannelId", "IsNegativeStockAllowed" ], "properties": { "salesChannelId": { "description": "Key of the sales channel that identifies the specific shop or sales channel for which this negative stock setting applies.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.SalesChannelId" }, "isNegativeStockAllowed": { "type": "boolean", "description": "Determines if negative stock is allowed for this sales channel. When true, orders can be accepted even when the item is out of stock in this specific channel." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdatePlatformDescription": { "type": "object", "description": "Defines a platform-specific description of an item. This enables different descriptions for various output platforms like print or other non-sales platforms.", "additionalProperties": false, "required": [ "PlatformId", "LanguageIso", "DescriptionData" ], "properties": { "platformId": { "description": "Unique key of the platform for which this description is intended (e.g., print, labels).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PlattformKey" }, "languageIso": { "type": "string", "description": "ISO2 language code that determines the language for this item description (e.g., \"DE\" for German, \"EN\" for English)." }, "descriptionData": { "description": "Contains the platform-specific description data with all relevant texts and SEO information.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateDescriptionData" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdatePlatformImages": { "type": "object", "description": "Model Class: UpdatePlatformImages ", "additionalProperties": false, "required": [ "PlatformId" ], "properties": { "platformId": { "description": "Unique ID to identify a platform.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PlattformKey" }, "images": { "type": "array", "description": "List of images assigned to the platform.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemImage" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateSalesChannelDescription": { "type": "object", "description": "Defines a sales channel-specific description of an item. This enables individual customization of item descriptions for specific sales channels or shops.", "additionalProperties": false, "required": [ "SalesChannelId", "LanguageIso", "DescriptionData" ], "properties": { "salesChannelId": { "description": "Unique key of the sales channel or shop for which this description is intended.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.SalesChannelId" }, "languageIso": { "type": "string", "description": "ISO2 language code that determines the language for this sales channel-specific description." }, "descriptionData": { "description": "Contains the sales channel-specific description data with all relevant texts and SEO information.", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateDescriptionData" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateSaleschannelImages": { "type": "object", "description": "Model Class: UpdateSaleschannelImages ", "additionalProperties": false, "required": [ "SaleschannelId" ], "properties": { "saleschannelId": { "description": "Unique ID to identify a saleschannel.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.SalesChannelId" }, "images": { "type": "array", "description": "List of images assigned to the platform.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateItemImage" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateSalesChannelSurcharge": { "type": "object", "description": "Model Class: UpdateSalesChannelSurcharge ", "additionalProperties": false, "required": [ "SalesChannelId", "Surcharges" ], "properties": { "salesChannelId": { "description": "Id of the saleschannel", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.SalesChannelId" }, "surcharges": { "type": "array", "description": "Contains the surcharges for that saleschannel and customergroup", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateCustomerGroupSurcharge" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateSupplierPrice": { "type": "object", "description": "Model Class: UpdateSupplierPrice ", "additionalProperties": false, "required": [ "FromQuantity", "UsePercentageDiscount" ], "properties": { "fromQuantity": { "type": "number", "description": "Quantity from which the price applies. This value is not editable. To change it, a new scale must be created.", "format": "decimal" }, "netPrice": { "type": "number", "description": "Net price for this scale.", "format": "decimal" }, "usePercentageDiscount": { "type": "boolean", "description": "Indicates whether the scale uses a percentage discount of the NetPurchasePrice." }, "percentageDiscount": { "type": "number", "description": "The percentage discount applied in this scale.", "format": "decimal" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateVariation": { "type": "object", "description": "Model Class: UpdateVariation ", "additionalProperties": false, "required": [ "VariationId" ], "properties": { "variationId": { "description": "Id of the Variation", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey" }, "position": { "type": "integer", "description": "Position of this Variation in the List", "format": "int32" }, "descriptions": { "type": "array", "description": "Descriptions of this Variation in multiple Languages", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateDescription" } }, "values": { "type": "array", "description": "Values for this Variation", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateVariationValue" } }, "variationType": { "type": "integer", "description": "Type of the Variation", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.VariationType" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateVariationValue": { "type": "object", "description": "Model Class: UpdateVariationValue ", "additionalProperties": false, "required": [ "VariationValueId" ], "properties": { "variationValueId": { "description": "Id of the VariationValue", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationWertKey" }, "itemNumber": { "type": "string", "description": "Itemnumber for this variationvalue" }, "gTIN": { "type": "string", "description": "GTIN for this variationvalue" }, "weightOffset": { "type": "number", "description": "Offset for the weight of this variationvalue", "format": "decimal" }, "descriptions": { "type": "array", "description": "Descriptions of this VariationValue in multiple Languages", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateDescription" } }, "surcharges": { "description": "Surcharges of this VariationValue", "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateVariationValueSurcharges" }, "position": { "type": "integer", "description": "Position of this VariationValue in the List", "format": "int32" }, "image": { "description": "Image for this variation value. This image will be used as the main image for the variation combination if this variation value is part of it and the variation combination doesn't have its own image.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.BildKey" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateVariationValueSurcharges": { "type": "object", "description": "Model Class: UpdateVariationValueSurcharges ", "additionalProperties": false, "properties": { "defaultSurchargeNet": { "type": "number", "description": "Default Surcharge if there is none specified for a specific saleschannel + customergroup", "format": "decimal" }, "customerGroupSurcharges": { "type": "array", "description": "Default Surcharges for specific customergroups in general, independent of saleschannel", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateCustomerGroupSurcharge" } }, "salesChannelSurcharges": { "type": "array", "description": "Surcharge for specific saleschannels + customergroups", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.UpdateSalesChannelSurcharge" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.Itemdetails.VariationType": { "type": "integer", "description": "0 = Unknown, 1 = Selectbox, 2 = Radiobutton, 3 = Swatches, 4 = Textbox, 5 = FreeText, 6 = MandatoryFreeText", "format": "int32", "x-enumNames": [ "Unknown", "Selectbox", "Radiobutton", "Swatches", "Textbox", "FreeText", "MandatoryFreeText" ], "enum": [ 0, 1, 2, 3, 4, 5, 6 ] }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.ProductGroups.AddProductGroupsCommandRequest": { "type": "object", "description": "Add new product groups. - Request", "additionalProperties": false, "required": [ "Names" ], "properties": { "names": { "type": "array", "description": "The names of the product groups.", "items": { "type": "string" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.ProductGroups.DeleteProductGroupsCommandRequest": { "type": "object", "description": "Delete existing product groups. - Request", "additionalProperties": false, "properties": { "ids": { "type": "array", "description": "IDs of the product groups to delete.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarengruppeKey" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.ProductGroups.UpdateProductGroup": { "type": "object", "description": "Defines a product group", "additionalProperties": false, "required": [ "Id", "Name" ], "properties": { "id": { "description": "The id of the product group", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarengruppeKey" }, "name": { "type": "string", "description": "The new name of the product group" } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.ProductGroups.UpdateProductGroupsCommandRequest": { "type": "object", "description": "Update the properties of product groups. - Request", "additionalProperties": false, "required": [ "ProductGroups" ], "properties": { "productGroups": { "type": "array", "description": "Product groups to update.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.ProductGroups.UpdateProductGroup" } } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.SalesChannels.UpdateItemSalesChannelsCommandRequest": { "type": "object", "description": "Updates the active sales channels for a set of items - Request", "additionalProperties": false, "required": [ "ItemKeys" ], "properties": { "itemKeys": { "type": "array", "description": "The items to update.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" } }, "activateSalesChannels": { "type": "array", "description": "The sales channels to activate for the item set.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" } }, "deactivateSalesChannels": { "type": "array", "description": "The sales channels to deactivate for the item set.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" } }, "applyToChildItems": { "type": "boolean", "description": "Should sales channel update be applied to child items." } } }, "JTL.Wawi.Item.PublicApi.DataTransferObjects.V2.ShippingClass.CreateShippingClassCommandRequest": { "type": "object", "description": "Creates a new shipping class - Request", "additionalProperties": false, "required": [ "Name" ], "properties": { "name": { "type": "string", "description": "The name of the shipping class." } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Invoicing.ExcludeMarketplaceInvoiceCorrectionFromUploadCommandRequest": { "type": "object", "description": "Exclude marketplace invoice corrections from upload. - Request", "additionalProperties": false, "required": [ "OrderKeys" ], "properties": { "orderKeys": { "type": "array", "description": "Marketplace order keys of invoice corrections to exclude from upload.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOrderKey" } } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Invoicing.ExcludeMarketplaceInvoiceCorrectionPdfFromUploadCommandRequest": { "type": "object", "description": "Exclude marketplace invoice correction PDFs from upload. - Request", "additionalProperties": false, "required": [ "DocumentUploadQueueKeys" ], "properties": { "documentUploadQueueKeys": { "type": "array", "description": "Upload document IDs of invoice correction PDFs to exclude from upload.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxBelegUploadQueueKey" } } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Invoicing.ExcludeMarketplaceInvoicePdfFromUploadCommandRequest": { "type": "object", "description": "Exclude marketplace invoice PDFs from upload. - Request", "additionalProperties": false, "required": [ "DocumentUploadQueueKeys" ], "properties": { "documentUploadQueueKeys": { "type": "array", "description": "Upload document IDs of invoice PDFs to exclude from upload.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxBelegUploadQueueKey" } } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Invoicing.ResetMarketplaceInvoiceCorrectionPdfUploadCounterCommandRequest": { "type": "object", "description": "Reset the upload counter for marketplace invoice correction PDFs. - Request", "additionalProperties": false, "required": [ "DocumentUploadQueueKeys" ], "properties": { "documentUploadQueueKeys": { "type": "array", "description": "The invoice correction PDF upload queue entries for which the upload counter should be reset.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxBelegUploadQueueKey" } } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Invoicing.ResetMarketplaceInvoiceCorrectionUploadCounterCommandRequest": { "type": "object", "description": "Reset the upload counter for marketplace invoice corrections. - Request", "additionalProperties": false, "required": [ "OrderKeys" ], "properties": { "orderKeys": { "type": "array", "description": "The invoice corrections for which the upload counter should be reset.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOrderKey" } } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Invoicing.ResetMarketplaceInvoicePdfPrintingCommandRequest": { "type": "object", "description": "Resets PDF generation for marketplace invoices/invoice corrections so they can be reprinted and uploaded again. - Request", "additionalProperties": false, "required": [ "DocumentUploadQueueKeys" ], "properties": { "documentUploadQueueKeys": { "type": "array", "description": "Upload document IDs of the invoices/invoice corrections to reset PDF generation.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxBelegUploadQueueKey" } } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Offers.DeleteMarketplaceOfferCommandRequest": { "type": "object", "description": "Deletes the specified marketplace offers. - Request", "additionalProperties": false, "required": [ "OfferKeys", "RemoveDataFromItem" ], "properties": { "offerKeys": { "type": "array", "description": "Marketplace offer keys to delete.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOfferKey" } }, "removeDataFromItem": { "type": "boolean", "description": "If true, related marketplace assignment data is removed from items as well." } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Offers.RemoveItemFromMarketplaceOfferCommandRequest": { "type": "object", "description": "Removes the item assignment from the specified marketplace offers. - Request", "additionalProperties": false, "required": [ "OfferKeys", "RemoveDataFromItem" ], "properties": { "offerKeys": { "type": "array", "description": "Marketplace offer keys identifying the offers from which the item assignment should be removed.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOfferKey" } }, "removeDataFromItem": { "type": "boolean", "description": "If true, related marketplace assignment data is removed from items as well." } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Offers.SetMarketplaceOfferMaxQuantityCommandRequest": { "type": "object", "description": "Sets the maximum stock quantity for the specified marketplace offers. - Request", "additionalProperties": false, "required": [ "OfferKeys", "MaxQuantity" ], "properties": { "offerKeys": { "type": "array", "description": "Marketplace offer keys to update.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOfferKey" } }, "maxQuantity": { "type": "number", "description": "Maximum stock quantity to set for each specified marketplace offer.", "format": "decimal" } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Offers.SetMarketplaceOfferMinQuantityCommandRequest": { "type": "object", "description": "Sets the minimum stock quantity for the specified marketplace offers. - Request", "additionalProperties": false, "required": [ "OfferKeys", "MinQuantity" ], "properties": { "offerKeys": { "type": "array", "description": "Marketplace offer keys to update.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOfferKey" } }, "minQuantity": { "type": "number", "description": "Minimum stock quantity to set for each specified marketplace offer.", "format": "decimal" } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Offers.TriggerMarketplaceStockSynchronisationCommandRequest": { "type": "object", "description": "Triggers stock synchronisation for the specified marketplace offers. - Request", "additionalProperties": false, "required": [ "OfferKeys" ], "properties": { "offerKeys": { "type": "array", "description": "Marketplace offer keys to include in the next stock synchronisation.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOfferKey" } } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.CancelMarketplaceOrderCancellationRequestUploadCommandRequest": { "type": "object", "description": "Cancel marketplace order cancellation request uploads. - Request", "additionalProperties": false, "required": [ "OrderCancellationEventKeys" ], "properties": { "orderCancellationEventKeys": { "type": "array", "description": "Marketplace order cancellation event keys whose upload should be cancelled.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOrderCancellationEventKey" } } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.ExcludeMarketplaceOrderCancellationUploadFromUploadCommandRequest": { "type": "object", "description": "Exclude marketplace order cancellation uploads from upload. - Request", "additionalProperties": false, "required": [ "OrderKeys" ], "properties": { "orderKeys": { "type": "array", "description": "Marketplace order keys of cancellation uploads to exclude from upload.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOrderKey" } } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.ExcludeMarketplacePaymentUploadFromUploadCommandRequest": { "type": "object", "description": "Exclude marketplace payment uploads from upload. - Request", "additionalProperties": false, "required": [ "OrderKeys" ], "properties": { "orderKeys": { "type": "array", "description": "Marketplace order keys of payment uploads to exclude from upload.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOrderKey" } } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.ExcludeMarketplaceReturnUploadFromUploadCommandRequest": { "type": "object", "description": "Exclude marketplace return uploads from upload. - Request", "additionalProperties": false, "required": [ "OrderKeys" ], "properties": { "orderKeys": { "type": "array", "description": "Marketplace order keys of return uploads to exclude from upload.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOrderKey" } } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.ExcludeMarketplaceShippingInformationUploadFromUploadCommandRequest": { "type": "object", "description": "Exclude marketplace shipping information uploads from upload. - Request", "additionalProperties": false, "required": [ "OrderShippingKeys" ], "properties": { "orderShippingKeys": { "type": "array", "description": "Marketplace order shipping keys of shipping information uploads to exclude from upload.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOrderShippingKey" } } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.ResetMarketplaceOrderCancellationUploadCounterCommandRequest": { "type": "object", "description": "Reset the upload counter for marketplace order cancellation uploads. - Request", "additionalProperties": false, "required": [ "OrderKeys" ], "properties": { "orderKeys": { "type": "array", "description": "Marketplace order keys of cancellation uploads whose counter should be reset.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOrderKey" } } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.ResetMarketplacePaymentUploadCounterCommandRequest": { "type": "object", "description": "Reset the upload counter for marketplace payment uploads. - Request", "additionalProperties": false, "required": [ "OrderKeys" ], "properties": { "orderKeys": { "type": "array", "description": "Marketplace order keys of payment uploads whose counter should be reset.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOrderKey" } } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.ResetMarketplaceReturnUploadCounterCommandRequest": { "type": "object", "description": "Reset the upload counter for marketplace return uploads. - Request", "additionalProperties": false, "required": [ "OrderKeys" ], "properties": { "orderKeys": { "type": "array", "description": "Marketplace order keys of return uploads whose counter should be reset.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOrderKey" } } } }, "JTL.Wawi.Marketplace.Scx.PublicApi.DataTransferObjects.V2.Orders.ResetMarketplaceShippingInformationUploadCounterCommandRequest": { "type": "object", "description": "Reset the upload counter for marketplace shipping information uploads. - Request", "additionalProperties": false, "required": [ "OrderShippingKeys" ], "properties": { "orderShippingKeys": { "type": "array", "description": "Marketplace order shipping keys of shipping information uploads whose counter should be reset.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOrderShippingKey" } } } }, "JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxBelegUploadQueueKey": { "type": "string", "description": "Represents the key for the ScxBelegUploadQueue entity.", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxChannelKey": { "type": "string", "description": "Represents a key for a SCX channel.", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOfferKey": { "type": "string", "description": "Represents a key for an SCX offer, used for identification and comparison.", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOrderCancellationEventKey": { "type": "string", "description": "Represents a key for the Scx order cancellation event.", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOrderKey": { "type": "string", "description": "Represents a key for an SCX order.", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Wawi.Marktplatz.Scx.Types.Keys.ScxOrderShippingKey": { "type": "string", "description": "Represents a key for identifying an order shipping entity in the SCX context.", "format": "uuid", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "additionalProperties": false }, "JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse": { "type": "object", "description": "Represents an error response returned by the system in case of a failure or exception.", "additionalProperties": false, "properties": { "errorCode": { "type": "string", "description": "Gets or sets the error code that identifies the type of error encountered." }, "validationErrors": { "type": "object", "description": "Gets or sets a dictionary containing validation errors associated with the request.", "deprecated": true, "x-deprecatedMessage": "Use Errors", "additionalProperties": { "type": "string" } }, "errors": { "type": "object", "description": "Gets or sets a collection of errors associated with the response.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "errorMessage": { "type": "string", "description": "Gets or sets the error message that provides details about the error encountered." }, "stacktrace": { "type": "string", "description": "Gets or sets the stack trace associated with the error, providing detailed\ninformation about the sequence of method calls that led to the exception." } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Customer.Customer": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.Customer" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Delivery.PicklistReservations": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.PicklistReservations" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.DeliveryNote.DeliveryNote": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.DeliveryNote.DeliveryNote" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Extensibility.Extension": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Extensibility.Extension" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Invoice.Invoice": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Invoice.Invoice" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Property.Property": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Property.Property" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Property.PropertyGroup": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Property.PropertyGroup" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Return.Return": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Return.Return" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrder": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrder" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Stock.SerialNumber": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Stock.SerialNumber" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Stock.Stock": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Stock.Stock" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Stock.StockChange": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Stock.StockChange" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Supplier.Supplier": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Supplier.Supplier" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Warehouse.StorageLocation": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Warehouse.StorageLocation" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Warehouse.Warehouse": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Warehouse.Warehouse" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.WMS.PickList": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.WMS.PickList" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.WMS.PickListTemplate": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.WMS.PickListTemplate" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V2.AccountingData.AccountingData": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.AccountingData.AccountingData" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V2.UnitsOfMeasure.SalesUnit": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.UnitsOfMeasure.SalesUnit" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V2.UnitsOfMeasure.UnitOfMeasurement": { "type": "object", "description": "Represents a paginated list of items", "additionalProperties": false, "required": [ "TotalItems", "PageNumber", "PageSize", "Items" ], "properties": { "totalItems": { "type": "integer", "description": "Gets or sets the total number of items available in the data source.", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Gets or sets the current page number in the paginated list.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Gets or sets the number of items per page in the paginated list.", "format": "int32" }, "items": { "type": "array", "description": "Gets or sets the collection of items contained in the paged list.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.UnitsOfMeasure.UnitOfMeasurement" } }, "totalPages": { "type": "integer", "description": "Gets the total number of pages based on the total number of items and the page size.", "format": "int32" }, "hasPreviousPage": { "type": "boolean", "description": "Gets a value indicating whether there is a previous page available in the paginated list." }, "hasNextPage": { "type": "boolean", "description": "Gets a value indicating whether there is a next page available." }, "nextPageNumber": { "type": "integer", "description": "Gets the number of the next page if there is one; otherwise, returns the total number of pages.", "format": "int32" }, "previousPageNumber": { "type": "integer", "description": "Gets the number of the previous page. If there is no previous page, it returns 1.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.SalesChannelId": { "type": "string", "description": "Represents a unique identifier for a sales channel, encapsulating various platform-specific keys such as shop,\nuser, or channel identifiers.", "additionalProperties": false }, "JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.Country": { "type": "object", "description": "Model Class: Country ", "additionalProperties": false, "required": [ "CountryISO", "StateISO" ], "properties": { "countryISO": { "type": "string", "description": "ISO code of the country." }, "stateISO": { "type": "string", "description": "ISO code of the state within the country." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.LineItemType": { "type": "integer", "description": "0 = CustomLineItem, 1 = Item, 2 = ShippingItem, 3 = Coupon, 4 = Voucher, 5 = PaymentMethod, 6 = ShippingSurcharge, 7 = NewCustomerCoupon, 8 = CashOnDeliveryFee, 9 = ItemShippingSurcharge, 10 = GiftWrapping, 11 = FreeGift, 12 = TrustedShopsFee, 13 = InterestSurcharge, 14 = HandlingFee, 15 = CardboardBoxes, 16 = Return, 17 = MultiPurposeVoucher, 18 = MultiPurposeDigitalVoucher, 19 = SinglePurposeVoucher, 20 = SinglePurposeDigitalVoucher, 21 = SinglePurposeVoucherRedemption", "format": "int32", "x-enumNames": [ "CustomLineItem", "Item", "ShippingItem", "Coupon", "Voucher", "PaymentMethod", "ShippingSurcharge", "NewCustomerCoupon", "CashOnDeliveryFee", "ItemShippingSurcharge", "GiftWrapping", "FreeGift", "TrustedShopsFee", "InterestSurcharge", "HandlingFee", "CardboardBoxes", "Return", "MultiPurposeVoucher", "MultiPurposeDigitalVoucher", "SinglePurposeVoucher", "SinglePurposeDigitalVoucher", "SinglePurposeVoucherRedemption" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.Authentication.AppToken": { "type": "object", "description": "Model Class: AppToken ", "additionalProperties": false, "required": [ "ApiKey" ], "properties": { "apiKey": { "type": "string", "description": "Generated unique API key of the token" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Authentication.CreateAppRegistrationRequest": { "type": "object", "description": "Model Class: CreateAppRegistrationRequest ", "additionalProperties": false, "required": [ "AppId", "DisplayName", "Description", "Version", "ProviderName", "ProviderWebsite", "MandatoryApiScopes", "AppIcon" ], "properties": { "appId": { "type": "string", "description": "Unique identifier of the application" }, "displayName": { "type": "string", "description": "Default display name of the application" }, "description": { "type": "string", "description": "Default description of the application" }, "localizedDisplayNames": { "type": "array", "description": "Localized display names of the application", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateTranslation" } }, "localizedDescriptions": { "type": "array", "description": "Localized descriptions of the application", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateTranslation" } }, "version": { "type": "string", "description": "Version of the application to be registered" }, "providerName": { "type": "string", "description": "Name of the application's provider" }, "providerWebsite": { "type": "string", "description": "Website of the application's provider" }, "mandatoryApiScopes": { "type": "array", "description": "Mandatory required API scopes for the application to work", "items": { "type": "string" } }, "optionalApiScopes": { "type": "array", "description": "Optional (recommended) API scopes for the application", "items": { "type": "string" } }, "appIcon": { "type": "string", "description": "Base64 encoded data of an image.", "format": "byte" }, "registrationType": { "type": "integer", "description": "multiple instances of the application possible", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Authentication.RegistrationType" }, "signature": { "type": "string", "description": "The Signature of the App, it combines AppId.SignatureData like myApp/v1.2025-08-03T25:48:00 in UTC Time", "format": "byte" }, "signatureData": { "type": "string", "description": "The Data as DateTimeOffset must be in a range from 10 Minutes equals, and is base for the Signature and must be in UTC Time", "format": "date-time" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Authentication.CreateLogin": { "type": "object", "description": "Model Class: CreateLogin ", "additionalProperties": false, "required": [ "UserName", "Password" ], "properties": { "userName": { "type": "string", "description": "Username of the WAWI user" }, "password": { "type": "string", "description": "Password of the WAWI user" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Authentication.Login": { "type": "object", "description": "Model Class: Login ", "additionalProperties": false, "required": [ "SessionId" ], "properties": { "sessionId": { "type": "string", "description": "Unique identifier of the current session" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Authentication.RegistrationInformation": { "type": "object", "description": "Model Class: RegistrationInformation ", "additionalProperties": false, "required": [ "RequestStatusInfo" ], "properties": { "requestStatusInfo": { "description": "Status of the registration process (including the unique identifiers for application and registration request)", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Authentication.RegistrationRequestStatusInfo" }, "token": { "description": "Generated token for the application to access the API", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Authentication.AppToken" }, "grantedScopes": { "type": "array", "description": "API scopes (both mandatory and optional) granted to the application", "items": { "type": "string" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Authentication.RegistrationRequestStatusInfo": { "type": "object", "description": "Model Class: RegistrationRequestStatusInfo ", "additionalProperties": false, "required": [ "AppId", "RegistrationRequestId", "Status" ], "properties": { "appId": { "type": "string", "description": "Unique identifier of the application" }, "registrationRequestId": { "type": "string", "description": "Unique identifier of the registration request" }, "status": { "description": "Status of the registration process", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Authentication.RegistrationStatus" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Authentication.RegistrationStatus": { "type": "integer", "description": "0 = Pending, 1 = Rejected, 2 = Accepted", "format": "int32", "x-enumNames": [ "Pending", "Rejected", "Accepted" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.Authentication.RegistrationType": { "type": "integer", "description": "0 = OneInstance, 1 = MultiInstance, 2 = PerUserInstance, 3 = PerUserLoginInstance", "format": "int32", "x-enumNames": [ "OneInstance", "MultiInstance", "PerUserInstance", "PerUserLoginInstance" ], "enum": [ 0, 1, 2, 3 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.Authentication.UpdateAppRegistrationRequest": { "type": "object", "description": "Model Class: UpdateAppRegistrationRequest ", "additionalProperties": false, "properties": { "appId": { "type": "string", "description": "Unique identifier of the application" }, "displayName": { "type": "string", "description": "Default display name of the application" }, "description": { "type": "string", "description": "Default description of the application" }, "localizedDisplayNames": { "type": "array", "description": "Localized display names of the application", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateTranslation" } }, "localizedDescriptions": { "type": "array", "description": "Localized descriptions of the application", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateTranslation" } }, "version": { "type": "string", "description": "Version of the application to be registered" }, "providerName": { "type": "string", "description": "Name of the application's provider" }, "providerWebsite": { "type": "string", "description": "Website of the application's provider" }, "mandatoryApiScopes": { "type": "array", "description": "Mandatory required API scopes for the application to work", "items": { "type": "string" } }, "optionalApiScopes": { "type": "array", "description": "Optional (recommended) API scopes for the application", "items": { "type": "string" } }, "appIcon": { "type": "string", "description": "Base64 encoded data of an image.", "format": "byte" }, "registrationType": { "type": "integer", "description": "multiple instances of the application possible", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Authentication.RegistrationType" }, "signature": { "type": "string", "description": "The Signature of the App, it combines AppId.SignatureData like myApp/v1.2025-08-03T25:48:00 in UTC Time", "format": "byte" }, "signatureData": { "type": "string", "description": "The Data as DateTimeOffset must be in a range from 10 Minutes equals, and is base for the Signature and must be in UTC Time", "format": "date-time" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Availability.Availability": { "type": "object", "description": "Model Class: Availability ", "additionalProperties": false, "required": [ "Id", "Name" ], "properties": { "id": { "description": "Unique ID to identify the availability state of an item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferstatusKey" }, "name": { "type": "string", "description": "The name of the availability state." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.CancellationReason.CancellationReason": { "type": "object", "description": "Model Class: CancellationReason ", "additionalProperties": false, "required": [ "Id", "Name", "IsCommentRequired" ], "properties": { "id": { "description": "Unique ID to identify a cancellation reason", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AuftragStornogrundKey" }, "name": { "type": "string", "description": "Name of the cancellation reason" }, "isCommentRequired": { "type": "boolean", "description": "Indicates if a comment is required when this cancellation reason is used" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.ColorCode.ColorCode": { "type": "object", "description": "Model Class: ColorCode ", "additionalProperties": false, "required": [ "Id", "Name", "Code" ], "properties": { "id": { "description": "Unique ID to identify a colour code.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FarbeKey" }, "name": { "type": "string", "description": "Name of the colour code." }, "code": { "type": "string", "description": "Hexadecimal color code (e.g., \"#00FF00\" for green)." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.Address": { "type": "object", "description": "Model Class: Address ", "additionalProperties": false, "required": [ "Id", "Company", "Company2", "FormOfAddress", "Title", "FirstName", "LastName", "Street", "Address2", "PostalCode", "City", "State", "CountryIso", "VatID", "PhoneNumber", "MobilePhoneNumber", "EmailAddress", "Fax" ], "properties": { "id": { "description": "Unique ID to identify an address", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AdresseKey" }, "company": { "type": "string", "description": "Description of the Company." }, "company2": { "type": "string", "description": "Additional company information" }, "formOfAddress": { "type": "string", "description": "Customer form of address" }, "title": { "type": "string", "description": "Official title" }, "firstName": { "type": "string", "description": "Customer first name" }, "lastName": { "type": "string", "description": "Customer last name" }, "street": { "type": "string", "description": "Street name in the customer's address" }, "address2": { "type": "string", "description": "Additional address information" }, "postalCode": { "type": "string", "description": "Postal code of the customer's address" }, "city": { "type": "string", "description": "Name of city in the customer's address" }, "state": { "type": "string", "description": "Name of state in the customer's address" }, "countryIso": { "type": "string", "description": "Country ISO code" }, "vatID": { "type": "string", "description": "Supplier VAT ID number" }, "phoneNumber": { "type": "string", "description": "Landline phone number" }, "mobilePhoneNumber": { "type": "string", "description": "Mobile phone number" }, "emailAddress": { "type": "string", "description": "Email address" }, "fax": { "type": "string", "description": "Fax number" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.Config": { "type": "object", "description": "Model Class: Config ", "additionalProperties": false, "required": [ "Identifier", "DisplayName", "DisplayDescription", "Type", "CurrentValue", "IsRequired" ], "properties": { "identifier": { "description": "The Unique Identifier of a Config", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ConfigKey" }, "displayName": { "type": "string", "description": "The Display Name of a Setting" }, "displayDescription": { "type": "string", "description": "The Display Description of a Setting" }, "type": { "type": "string", "description": "The Type of the Setting" }, "currentValue": { "type": "string", "description": "The Current Value of the Setting" }, "isRequired": { "type": "boolean", "description": "If the Setting is Required" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateAddress": { "type": "object", "description": "Model Class: CreateAddress ", "additionalProperties": false, "required": [ "City", "CountryIso" ], "properties": { "company": { "type": "string", "description": "Description of the Company." }, "company2": { "type": "string", "description": "Additional company information" }, "formOfAddress": { "type": "string", "description": "Customer form of address" }, "title": { "type": "string", "description": "Official title" }, "firstName": { "type": "string", "description": "Customer first name" }, "lastName": { "type": "string", "description": "Customer last name" }, "street": { "type": "string", "description": "Street name in the customer's address" }, "address2": { "type": "string", "description": "Additional address information" }, "postalCode": { "type": "string", "description": "Postal code of the customer's address" }, "city": { "type": "string", "description": "Name of city in the customer's address", "maxLength": 255 }, "state": { "type": "string", "description": "Name of state in the customer's address" }, "countryIso": { "type": "string", "description": "Country ISO code", "maxLength": 5 }, "vatID": { "type": "string", "description": "Supplier VAT ID number" }, "phoneNumber": { "type": "string", "description": "Landline phone number" }, "mobilePhoneNumber": { "type": "string", "description": "Mobile phone number" }, "emailAddress": { "type": "string", "description": "Email address" }, "fax": { "type": "string", "description": "Fax number" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateConfigItem": { "type": "object", "description": "Model Class: CreateConfigItem ", "additionalProperties": false, "properties": { "identifier": { "description": "The Unique Identifier of a Config", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ConfigKey" }, "value": { "type": "string", "description": "The Serialized Configuration Value to set." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateFile": { "type": "object", "description": "Model Class: CreateFile ", "additionalProperties": false, "required": [ "FileData", "FileDataType", "FileName" ], "properties": { "fileData": { "type": "string", "description": "Base64 encoded data of the file.", "format": "byte" }, "fileDataType": { "type": "string", "description": "Type of file.", "maxLength": 2147483647 }, "fileName": { "type": "string", "description": "name of the file.", "maxLength": 2147483647 } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateNote": { "type": "object", "description": "Model Class: CreateNote ", "additionalProperties": false, "required": [ "NoteBody" ], "properties": { "noteBody": { "type": "string", "description": "The text in the customer note." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateTranslation": { "type": "object", "description": "Model Class: CreateTranslation ", "additionalProperties": false, "required": [ "LanguageIso", "Name" ], "properties": { "languageIso": { "type": "string", "description": "The language ISO code" }, "name": { "type": "string", "description": "The word in the corresponding language" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateWorkflowEvent": { "type": "object", "description": "Model Class: CreateWorkflowEvent ", "additionalProperties": false, "required": [ "Id" ], "properties": { "id": { "type": "integer", "description": "ID of the workflow event", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.CustomField": { "type": "object", "description": "Model Class: CustomField ", "additionalProperties": false, "required": [ "CustomFieldId", "GroupName", "Name", "Type", "PossibleValues" ], "properties": { "attribut": { "$ref": "#/components/schemas/JTL.Entities.dbo.Table.AttributEntity" }, "customFieldId": { "description": "Unique ID to identify a custom field.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EigenesFeldKey" }, "groupName": { "type": "string", "description": "The group name for this custom field." }, "name": { "type": "string", "description": "The custom field name." }, "type": { "description": "The custom field type.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CustomFieldType" }, "possibleValues": { "type": "array", "description": "The possible values, when the custom field is a list.", "items": { "type": "string" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.CustomFieldType": { "type": "integer", "description": "0 = None, 1 = Integer, 2 = Decimal, 3 = Text, 4 = Checkbox, 5 = List, 6 = Url, 7 = Email, 8 = PhoneNumber, 9 = CountryIso, 10 = Price, 11 = Date, 12 = ShortText", "format": "int32", "x-enumNames": [ "None", "Integer", "Decimal", "Text", "Checkbox", "List", "Url", "Email", "PhoneNumber", "CountryIso", "Price", "Date", "ShortText" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.CustomFieldValue": { "type": "object", "description": "Model Class: CustomFieldValue ", "additionalProperties": false, "required": [ "CustomFieldId", "Value" ], "properties": { "customFieldId": { "description": "Unique ID to identifify a custom field.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EigenesFeldKey" }, "value": { "type": "object", "description": "The custom field value. The object should match the custom field type." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.Dimensions": { "type": "object", "description": "Model Class: Dimensions ", "additionalProperties": false, "required": [ "Length", "Width", "Height" ], "properties": { "length": { "type": "number", "description": "Length", "format": "decimal" }, "width": { "type": "number", "description": "Width", "format": "decimal" }, "height": { "type": "number", "description": "Height", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.Note": { "type": "object", "description": "Model Class: Note ", "additionalProperties": false, "required": [ "NoteId", "NoteBody" ], "properties": { "noteId": { "description": "Unique ID to identify a customer note. A customer note always has a customer reference and may have a sales order reference as well.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.NotizKey" }, "noteBody": { "type": "string", "description": "The text in the customer note." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.Translation": { "type": "object", "description": "Model Class: Translation ", "additionalProperties": false, "required": [ "LanguageIso", "Name" ], "properties": { "languageIso": { "type": "string", "description": "The language ISO code" }, "name": { "type": "string", "description": "The word in the corresponding language" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateAddress": { "type": "object", "description": "Model Class: UpdateAddress ", "additionalProperties": false, "properties": { "company": { "type": "string", "description": "Description of the Company." }, "company2": { "type": "string", "description": "Additional company information" }, "formOfAddress": { "type": "string", "description": "Customer form of address" }, "title": { "type": "string", "description": "Official title" }, "firstName": { "type": "string", "description": "Customer first name" }, "lastName": { "type": "string", "description": "Customer last name" }, "street": { "type": "string", "description": "Street name in the customer's address" }, "address2": { "type": "string", "description": "Additional address information" }, "postalCode": { "type": "string", "description": "Postal code of the customer's address" }, "city": { "type": "string", "description": "Name of city in the customer's address" }, "state": { "type": "string", "description": "Name of state in the customer's address" }, "countryIso": { "type": "string", "description": "Country ISO code" }, "vatID": { "type": "string", "description": "Supplier VAT ID number" }, "phoneNumber": { "type": "string", "description": "Landline phone number" }, "mobilePhoneNumber": { "type": "string", "description": "Mobile phone number" }, "emailAddress": { "type": "string", "description": "Email address" }, "fax": { "type": "string", "description": "Fax number" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateCustomFieldValue": { "type": "object", "description": "Model Class: UpdateCustomFieldValue ", "additionalProperties": false, "required": [ "Value" ], "properties": { "value": { "type": "object", "description": "The custom field value. The object should match the custom field type." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateFile": { "type": "object", "description": "Model Class: UpdateFile ", "additionalProperties": false, "properties": { "fileData": { "type": "string", "description": "Base64 encoded data of the file.", "format": "byte" }, "fileDataType": { "type": "string", "description": "Type of file." }, "fileName": { "type": "string", "description": "name of the file." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateNote": { "type": "object", "description": "Model Class: UpdateNote ", "additionalProperties": false, "required": [ "NoteBody" ], "properties": { "noteBody": { "type": "string", "description": "The text in the customer note." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateTranslation": { "type": "object", "description": "Model Class: UpdateTranslation ", "additionalProperties": false, "required": [ "LanguageIso", "Name" ], "properties": { "languageIso": { "type": "string", "description": "The language ISO code" }, "name": { "type": "string", "description": "The word in the corresponding language" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Common.WorkflowEvent": { "type": "object", "description": "Model Class: WorkflowEvent ", "additionalProperties": false, "required": [ "Id", "Name" ], "properties": { "id": { "type": "integer", "description": "ID of the workflow event", "format": "int32" }, "name": { "type": "string", "description": "Name of the workflow event" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Company.Company": { "type": "object", "description": "Model Class: Company ", "additionalProperties": false, "required": [ "Id", "Name" ], "properties": { "id": { "description": "Unique ID to identify a company.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "name": { "type": "string", "description": "Name of the company." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Condition.Condition": { "type": "object", "description": "Model Class: Condition ", "additionalProperties": false, "required": [ "Id", "Names" ], "properties": { "id": { "description": "Unique ID to identify a condition.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZustandKey" }, "names": { "type": "array", "description": "The list of the condition names.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Condition.ConditionNames" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Condition.ConditionNames": { "type": "object", "description": "Model Class: ConditionNames ", "additionalProperties": false, "required": [ "Name", "LanguageIso" ], "properties": { "name": { "type": "string", "description": "Name of a condition." }, "languageIso": { "type": "string", "description": "ISO code of the language of a condition." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.CreateCustomer": { "type": "object", "description": "Model Class: CreateCustomer ", "additionalProperties": false, "required": [ "CustomerGroupId", "BillingAddress", "LanguageIso", "InternalCompanyId" ], "properties": { "number": { "type": "string", "description": "The customer's number." }, "customerGroupId": { "description": "The customer group ID.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "billingAddress": { "description": "The customer's default billing address.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateAddress" }, "shipmentaddress": { "description": "The customer's default shipping address.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateAddress" }, "customAddress": { "description": "The customer's default non-billing and non-shipping address.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateAddress" }, "otherAddresses": { "description": "All other non-default addresses of the customer.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.CreateOtherAddresses" }, "paymentSettings": { "description": "The payment settings for the customer.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.CreatePaymentSettings" }, "customerSince": { "type": "string", "description": "Date since they have been a customer.", "format": "date-time" }, "lastChange": { "type": "string", "description": "Date of the last customer's data change.", "format": "date-time" }, "languageIso": { "type": "string", "description": "The customer's language." }, "internalCompanyId": { "description": "The internal ID of the company associated with the customer. This is configured in the company and email settings in JTL-Wawi", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "customerCategoryId": { "description": "The customer category ID.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenKategorieKey" }, "taxIdentificationNumber": { "type": "string", "description": "The customer's tax identification number." }, "accountsReceivableNumber": { "type": "integer", "description": "The customer's accounts receivable number.", "format": "int32" }, "commercialRegisterNumber": { "type": "string", "description": "The customer's commercial register number." }, "website": { "type": "string", "description": "The customer's website." }, "initialContact": { "type": "string", "description": "The source of initial contact. This could be for example a specific sales channel, a convention or a marketing campaign." }, "ebayUsername": { "type": "string", "description": "The customer's eBay username." }, "birthday": { "type": "string", "description": "The customer's date of birth.", "format": "date-time" }, "isLocked": { "type": "boolean", "description": "The customer's locked status for online shop sales channels." }, "isCashRegisterBased": { "type": "boolean", "description": "States if a customer is from a cash-register or point of sale and if their data should be synchronized with JTL-POS, for example." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.CreateCustomerBankAccount": { "type": "object", "description": "Model Class: CreateCustomerBankAccount ", "additionalProperties": false, "required": [ "AccountHolder" ], "properties": { "accountHolder": { "type": "string", "description": "Name of the account holder of the customer's bank account.", "maxLength": 255 }, "bankName": { "type": "string", "description": "Name of the bank." }, "accountNumber": { "type": "string", "description": "Account number of the customer's bank account." }, "bankCode": { "type": "string", "description": "Bank code of the customer bank's account." }, "iBAN": { "type": "string", "description": "International bank account number of the customer's bank account." }, "bIC": { "type": "string", "description": "Bank identification code of the customer's bank account." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.CreateCustomerContact": { "type": "object", "description": "Model Class: CreateCustomerContact ", "additionalProperties": false, "properties": { "department": { "type": "string", "description": "The contact person's department." }, "honorific": { "type": "string", "description": "The contact person's form of address." }, "firstName": { "type": "string", "description": "The contact person's first name." }, "lastName": { "type": "string", "description": "The contact person's last name." }, "phoneNumber": { "type": "string", "description": "The contact person's landline phone number." }, "mobilePhoneNumber": { "type": "string", "description": "The contact person's mobile number." }, "emailAddress": { "type": "string", "description": "The contact person's email address." }, "fax": { "type": "string", "description": "The contact person's fax number." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.CreateOtherAddresses": { "type": "object", "description": "Model Class: CreateOtherAddresses ", "additionalProperties": false, "properties": { "otherBillingAddresses": { "type": "array", "description": "All other non-default billing addresses of the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateAddress" } }, "otherShippingAddresses": { "type": "array", "description": "All other non-default shipping addresses of the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateAddress" } }, "otherCustomerAddresses": { "type": "array", "description": "All other non-billing and non-shipping addresses of the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateAddress" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.CreatePaymentSettings": { "type": "object", "description": "Model Class: CreatePaymentSettings ", "additionalProperties": false, "properties": { "paymentMethodId": { "description": "The unique ID to identify a payment method.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "discount": { "type": "number", "description": "The indicated discount, if any.", "format": "decimal" }, "paymentTarget": { "type": "integer", "description": "The payment target in days.", "format": "int32" }, "creditLimit": { "type": "integer", "description": "The customer's credit limit.", "format": "int32" }, "stopPaymentRequest": { "type": "boolean", "description": "Option to stop payment requests." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.Customer": { "type": "object", "description": "Model Class: Customer ", "additionalProperties": false, "required": [ "Id", "Number", "CustomerGroupId", "BillingAddress", "Shipmentaddress", "CustomAddress", "OtherAddresses", "PaymentSettings", "CustomerSince", "LastChange", "LanguageIso", "InternalCompanyId", "CustomerCategoryId", "TaxIdentificationNumber", "AccountsReceivableNumber", "CommercialRegisterNumber", "Website", "InitialContact", "EbayUsername", "Birthday", "IsLocked", "IsCashRegisterBased" ], "properties": { "id": { "description": "Unique ID to identify a customer.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "number": { "type": "string", "description": "The customer's number." }, "customerGroupId": { "description": "The customer group ID.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "billingAddress": { "description": "The customer's default billing address.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address" }, "shipmentaddress": { "description": "The customer's default shipping address.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address" }, "customAddress": { "description": "The customer's default non-billing and non-shipping address.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address" }, "otherAddresses": { "description": "All other non-default addresses of the customer.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.OtherAddresses" }, "paymentSettings": { "description": "The payment settings for the customer.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.PaymentSettings" }, "customerSince": { "type": "string", "description": "Date since they have been a customer.", "format": "date-time" }, "lastChange": { "type": "string", "description": "Date of the last customer's data change.", "format": "date-time" }, "languageIso": { "type": "string", "description": "The customer's language." }, "internalCompanyId": { "description": "The internal ID of the company associated with the customer. This is configured in the company and email settings in JTL-Wawi", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "customerCategoryId": { "description": "The customer category ID.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenKategorieKey" }, "taxIdentificationNumber": { "type": "string", "description": "The customer's tax identification number." }, "accountsReceivableNumber": { "type": "integer", "description": "The customer's accounts receivable number.", "format": "int32" }, "commercialRegisterNumber": { "type": "string", "description": "The customer's commercial register number." }, "website": { "type": "string", "description": "The customer's website." }, "initialContact": { "type": "string", "description": "The source of initial contact. This could be for example a specific sales channel, a convention or a marketing campaign." }, "ebayUsername": { "type": "string", "description": "The customer's eBay username." }, "birthday": { "type": "string", "description": "The customer's date of birth.", "format": "date-time" }, "isLocked": { "type": "boolean", "description": "The customer's locked status for online shop sales channels." }, "isCashRegisterBased": { "type": "boolean", "description": "States if a customer is from a cash-register or point of sale and if their data should be synchronized with JTL-POS, for example." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.CustomerBankAccount": { "type": "object", "description": "Model Class: CustomerBankAccount ", "additionalProperties": false, "required": [ "Id", "AccountHolder", "BankName", "AccountNumber", "BankCode", "IBAN", "BIC" ], "properties": { "id": { "description": "The unique ID to identify a customer's bank account.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KontoDatenKey" }, "accountHolder": { "type": "string", "description": "Name of the account holder of the customer's bank account." }, "bankName": { "type": "string", "description": "Name of the bank." }, "accountNumber": { "type": "string", "description": "Account number of the customer's bank account." }, "bankCode": { "type": "string", "description": "Bank code of the customer bank's account." }, "iBAN": { "type": "string", "description": "International bank account number of the customer's bank account." }, "bIC": { "type": "string", "description": "Bank identification code of the customer's bank account." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.CustomerContact": { "type": "object", "description": "Model Class: CustomerContact ", "additionalProperties": false, "required": [ "Id", "Department", "Honorific", "FirstName", "LastName", "PhoneNumber", "MobilePhoneNumber", "EmailAddress", "Fax" ], "properties": { "id": { "description": "The unique ID to identify a customer's main contact person.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AnsprechpartnerKey" }, "department": { "type": "string", "description": "The contact person's department." }, "honorific": { "type": "string", "description": "The contact person's form of address." }, "firstName": { "type": "string", "description": "The contact person's first name." }, "lastName": { "type": "string", "description": "The contact person's last name." }, "phoneNumber": { "type": "string", "description": "The contact person's landline phone number." }, "mobilePhoneNumber": { "type": "string", "description": "The contact person's mobile number." }, "emailAddress": { "type": "string", "description": "The contact person's email address." }, "fax": { "type": "string", "description": "The contact person's fax number." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.CustomerWorkflowEvent": { "type": "integer", "description": "1 = Created, 2 = Changed", "format": "int32", "x-enumNames": [ "Created", "Changed" ], "enum": [ 1, 2 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.LastChange": { "type": "object", "description": "Model Class: LastChange ", "additionalProperties": false, "required": [ "Id", "LastChangeDate" ], "properties": { "id": { "description": "Unique internal ID of the customer.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "lastChangeDate": { "type": "string", "description": "Length", "format": "date-time" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.OtherAddresses": { "type": "object", "description": "Model Class: OtherAddresses ", "additionalProperties": false, "required": [ "OtherBillingAddresses", "OtherShippingAddresses", "OtherCustomerAddresses" ], "properties": { "otherBillingAddresses": { "type": "array", "description": "All other non-default billing addresses of the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address" } }, "otherShippingAddresses": { "type": "array", "description": "All other non-default shipping addresses of the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address" } }, "otherCustomerAddresses": { "type": "array", "description": "All other non-billing and non-shipping addresses of the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.PaymentSettings": { "type": "object", "description": "Model Class: PaymentSettings ", "additionalProperties": false, "required": [ "PaymentMethodId", "Discount", "PaymentTarget", "CreditLimit", "StopPaymentRequest" ], "properties": { "paymentMethodId": { "description": "The unique ID to identify a payment method.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "discount": { "type": "number", "description": "The indicated discount, if any.", "format": "decimal" }, "paymentTarget": { "type": "integer", "description": "The payment target in days.", "format": "int32" }, "creditLimit": { "type": "integer", "description": "The customer's credit limit.", "format": "int32" }, "stopPaymentRequest": { "type": "boolean", "description": "Option to stop payment requests." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.UpdateCustomer": { "type": "object", "description": "Model Class: UpdateCustomer ", "additionalProperties": false, "properties": { "number": { "type": "string", "description": "The customer's number." }, "customerGroupId": { "description": "The customer group ID.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "billingAddress": { "description": "The customer's default billing address.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateAddress" }, "shipmentaddress": { "description": "The customer's default shipping address.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateAddress" }, "customAddress": { "description": "The customer's default non-billing and non-shipping address.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateAddress" }, "otherAddresses": { "description": "All other non-default addresses of the customer.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.UpdateOtherAddresses" }, "paymentSettings": { "description": "The payment settings for the customer.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Customer.UpdatePaymentSettings" }, "customerSince": { "type": "string", "description": "Date since they have been a customer.", "format": "date-time" }, "lastChange": { "type": "string", "description": "Date of the last customer's data change.", "format": "date-time" }, "languageIso": { "type": "string", "description": "The customer's language." }, "internalCompanyId": { "description": "The internal ID of the company associated with the customer. This is configured in the company and email settings in JTL-Wawi", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "customerCategoryId": { "description": "The customer category ID.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenKategorieKey" }, "taxIdentificationNumber": { "type": "string", "description": "The customer's tax identification number." }, "accountsReceivableNumber": { "type": "integer", "description": "The customer's accounts receivable number.", "format": "int32" }, "commercialRegisterNumber": { "type": "string", "description": "The customer's commercial register number." }, "website": { "type": "string", "description": "The customer's website." }, "initialContact": { "type": "string", "description": "The source of initial contact. This could be for example a specific sales channel, a convention or a marketing campaign." }, "ebayUsername": { "type": "string", "description": "The customer's eBay username." }, "birthday": { "type": "string", "description": "The customer's date of birth.", "format": "date-time" }, "isLocked": { "type": "boolean", "description": "The customer's locked status for online shop sales channels." }, "isCashRegisterBased": { "type": "boolean", "description": "States if a customer is from a cash-register or point of sale and if their data should be synchronized with JTL-POS, for example." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.UpdateCustomerBankAccount": { "type": "object", "description": "Model Class: UpdateCustomerBankAccount ", "additionalProperties": false, "properties": { "accountHolder": { "type": "string", "description": "Name of the account holder of the customer's bank account." }, "bankName": { "type": "string", "description": "Name of the bank." }, "accountNumber": { "type": "string", "description": "Account number of the customer's bank account." }, "bankCode": { "type": "string", "description": "Bank code of the customer bank's account." }, "iBAN": { "type": "string", "description": "International bank account number of the customer's bank account." }, "bIC": { "type": "string", "description": "Bank identification code of the customer's bank account." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.UpdateCustomerContact": { "type": "object", "description": "Model Class: UpdateCustomerContact ", "additionalProperties": false, "properties": { "department": { "type": "string", "description": "The contact person's department." }, "honorific": { "type": "string", "description": "The contact person's form of address." }, "firstName": { "type": "string", "description": "The contact person's first name." }, "lastName": { "type": "string", "description": "The contact person's last name." }, "phoneNumber": { "type": "string", "description": "The contact person's landline phone number." }, "mobilePhoneNumber": { "type": "string", "description": "The contact person's mobile number." }, "emailAddress": { "type": "string", "description": "The contact person's email address." }, "fax": { "type": "string", "description": "The contact person's fax number." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.UpdateOtherAddresses": { "type": "object", "description": "Model Class: UpdateOtherAddresses ", "additionalProperties": false, "properties": { "otherBillingAddresses": { "type": "array", "description": "All other non-default billing addresses of the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateAddress" } }, "otherShippingAddresses": { "type": "array", "description": "All other non-default shipping addresses of the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateAddress" } }, "otherCustomerAddresses": { "type": "array", "description": "All other non-billing and non-shipping addresses of the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateAddress" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Customer.UpdatePaymentSettings": { "type": "object", "description": "Model Class: UpdatePaymentSettings ", "additionalProperties": false, "properties": { "paymentMethodId": { "description": "The unique ID to identify a payment method.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "discount": { "type": "number", "description": "The indicated discount, if any.", "format": "decimal" }, "paymentTarget": { "type": "integer", "description": "The payment target in days.", "format": "int32" }, "creditLimit": { "type": "integer", "description": "The customer's credit limit.", "format": "int32" }, "stopPaymentRequest": { "type": "boolean", "description": "Option to stop payment requests." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.CustomerCategory.CreateCustomerCategory": { "type": "object", "description": "Model Class: CreateCustomerCategory ", "additionalProperties": false, "required": [ "Name" ], "properties": { "name": { "type": "string", "description": "The customer category name.", "maxLength": 128 } } }, "JTL.Wawi.Rest.Contracts.Models.V1.CustomerCategory.CustomerCategory": { "type": "object", "description": "Model Class: CustomerCategory ", "additionalProperties": false, "required": [ "Id", "Name" ], "properties": { "id": { "description": "Unique internal ID of the customer category.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenKategorieKey" }, "name": { "type": "string", "description": "The customer category name." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.CustomerCategory.UpdateCustomerCategory": { "type": "object", "description": "Model Class: UpdateCustomerCategory ", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The customer category name." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.CustomerGroup.CreateCustomerGroup": { "type": "object", "description": "Model Class: CreateCustomerGroup ", "additionalProperties": false, "required": [ "Name" ], "properties": { "name": { "type": "string", "description": "The name of the customer group.", "maxLength": 255 }, "isDefault": { "type": "boolean", "description": "Indicates if the customer group is the default group. Only one group can be selected as the default group." }, "discount": { "type": "number", "description": "The discounted percentage for the customer group.", "format": "decimal" }, "isNetPrice": { "type": "boolean", "description": "Indicates if the customer group sees the net price in the online shop." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.CustomerGroup.CustomerGroup": { "type": "object", "description": "Model Class: CustomerGroup ", "additionalProperties": false, "required": [ "Id", "Name", "IsDefault", "Discount", "IsNetPrice" ], "properties": { "id": { "description": "Unique internal ID of the customer group.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "name": { "type": "string", "description": "The name of the customer group." }, "isDefault": { "type": "boolean", "description": "Indicates if the customer group is the default group. Only one group can be selected as the default group." }, "discount": { "type": "number", "description": "The discounted percentage for the customer group.", "format": "decimal" }, "isNetPrice": { "type": "boolean", "description": "Indicates if the customer group sees the net price in the online shop." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.CustomerGroup.UpdateCustomerGroup": { "type": "object", "description": "Model Class: UpdateCustomerGroup ", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The name of the customer group." }, "isDefault": { "type": "boolean", "description": "Indicates if the customer group is the default group. Only one group can be selected as the default group." }, "discount": { "type": "number", "description": "The discounted percentage for the customer group.", "format": "decimal" }, "isNetPrice": { "type": "boolean", "description": "Indicates if the customer group sees the net price in the online shop." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateCancelReservationRequest": { "type": "object", "description": "Model Class: CreateCancelReservationRequest ", "additionalProperties": false, "required": [ "PicklistIds" ], "properties": { "picklistIds": { "type": "array", "description": "Pick list IDs to cancel", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PicklisteKey" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateDeliverOptions": { "type": "object", "description": "Model Class: CreateDeliverOptions ", "additionalProperties": false, "properties": { "isDelilveryNotePerWarehouse": { "type": "boolean", "description": "Create a deliverynote for each Warehouse" }, "isSetDispatch": { "type": "boolean", "description": "Change the status of the salesorder to dispatched" }, "isCreateInvoice": { "type": "boolean", "description": "Create an invoice for the salesorder" }, "isInvoiceForOnlySendItems": { "type": "boolean", "description": "Create an invoice only for send items" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateDeliverRequest": { "type": "object", "description": "Model Class: CreateDeliverRequest ", "additionalProperties": false, "required": [ "PicklistIds", "DeliveryPackage", "IsPartialDelivery" ], "properties": { "picklistIds": { "type": "array", "description": "Picklist IDs", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PicklisteKey" } }, "deliveryPackage": { "type": "array", "description": "List of Packages", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateDeliveryPackage" } }, "isPartialDelivery": { "type": "boolean", "description": "deliver the sales order partially" }, "deliverOptions": { "description": "Options for the delivery", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateDeliverOptions" }, "deliveryPositionNotes": { "type": "array", "description": "the note for the delivery position", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateDeliveryPositionNotes" } }, "deliverySerialNumbers": { "type": "array", "description": "the serialNumbers of the items", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateDeliverySerialNumber" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateDeliveryPackage": { "type": "object", "description": "Model Class: CreateDeliveryPackage ", "additionalProperties": false, "required": [ "SalesOrderId", "ShippingMethodId", "Weight" ], "properties": { "salesOrderId": { "description": "Sales Order Id", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "shippingMethodId": { "description": "Id of the shipping method", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey" }, "weight": { "type": "number", "description": "the weight of the package", "format": "decimal" }, "shippingDate": { "type": "string", "description": "The shipping date", "format": "date-time" }, "trackingId": { "type": "string", "description": "The tracking id of the package" }, "enclosedReturnIdentCode": { "type": "string", "description": "idk" }, "note": { "type": "string", "description": "A note in the package" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateDeliveryPositionNotes": { "type": "object", "description": "Model Class: CreateDeliveryPositionNotes ", "additionalProperties": false, "properties": { "salesOrderPositionId": { "description": "Id of the sales order position", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "note": { "type": "string", "description": "the note to the sales order position" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateDeliverySerialNumber": { "type": "object", "description": "Model Class: CreateDeliverySerialNumber ", "additionalProperties": false, "properties": { "serialNumber": { "type": "string", "description": "The serial number" }, "pickpositionId": { "description": "The ID of the pick position with the serial number item", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PicklistePosKey" }, "description1": { "type": "string", "description": "Primary description of the serial number item" }, "description2": { "type": "string", "description": "Secondary description of the serial number item" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateDeliverySource": { "type": "object", "description": "Delivery Source Object", "additionalProperties": false, "required": [ "Type", "Priority" ], "properties": { "type": { "description": "Type of the Delivery source (Warehouse, Supplier, Cheapest Supplier, Fastest Supplier, Standard Supplier", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.DeliverySourceType" }, "id": { "type": "integer", "description": "Id of the Delivery Source", "format": "int32" }, "contactPersonId": { "type": "integer", "description": "Id of the Contact Person for the Supplier", "format": "int32" }, "priority": { "type": "integer", "description": "Priority of the DeliverySource", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreatePicklistReserveOptions": { "type": "object", "description": "Model Class: CreatePicklistReserveOptions ", "additionalProperties": false, "required": [ "PicklistPerOrder" ], "properties": { "picklistPerOrder": { "type": "boolean", "description": "Pick list per order" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateReassignRequest": { "type": "object", "description": "Model Class: CreateReassignRequest ", "additionalProperties": false, "required": [ "DeliverySources", "SalesOrderPositions", "PicklistReserveOptions" ], "properties": { "deliverySources": { "type": "array", "description": "DeliverySource to consider", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateDeliverySource" } }, "salesOrderPositions": { "type": "array", "description": "Positions to reassign", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateSalesOrderPosition" } }, "picklistReserveOptions": { "description": "Reservation options", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreatePicklistReserveOptions" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateReserveRequest": { "type": "object", "description": "Model Class: CreateReserveRequest ", "additionalProperties": false, "required": [ "SalesOrders", "DeliverySources", "PicklistReserveOptions" ], "properties": { "salesOrders": { "type": "array", "description": "List of sales orders", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateSalesOrder" } }, "deliverySources": { "type": "array", "description": "List of preferred warehouses and suppliers", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateDeliverySource" } }, "picklistReserveOptions": { "description": "Reservation options", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreatePicklistReserveOptions" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateSalesOrder": { "type": "object", "description": "Model Class: CreateSalesOrder ", "additionalProperties": false, "required": [ "SalesOrderId" ], "properties": { "salesOrderId": { "description": "Sales order ID", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.CreateSalesOrderPosition": { "type": "object", "description": "Model Class: CreateSalesOrderPosition ", "additionalProperties": false, "required": [ "SalesOrderPositionId", "Amount" ], "properties": { "salesOrderPositionId": { "description": "Position ID", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "amount": { "type": "number", "description": "Quantity", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.DeliverResponse": { "type": "object", "description": "Model Class: DeliverResponse ", "additionalProperties": false, "required": [ "SplitOrders", "NewOrders", "NewPicklists", "NewDeliveryNotes", "ProcessedPicklists", "DeliveredOrders", "NewSupplierOrders", "NewFulfillmentOrders" ], "properties": { "splitOrders": { "type": "array", "description": "Orders that has been splitted", "items": { "type": "integer", "format": "int32" } }, "newOrders": { "type": "array", "description": "Newly created orders", "items": { "type": "integer", "format": "int32" } }, "newPicklists": { "type": "array", "description": "Newly created orders", "items": { "type": "integer", "format": "int32" } }, "newDeliveryNotes": { "type": "array", "description": "Newly created orders", "items": { "type": "integer", "format": "int32" } }, "processedPicklists": { "type": "array", "description": "Newly created orders", "items": { "type": "integer", "format": "int32" } }, "deliveredOrders": { "type": "array", "description": "Newly created orders", "items": { "type": "integer", "format": "int32" } }, "newSupplierOrders": { "type": "array", "description": "Newly created orders", "items": { "type": "integer", "format": "int32" } }, "newFulfillmentOrders": { "type": "array", "description": "Newly created orders", "items": { "type": "integer", "format": "int32" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.DeliverySourceType": { "type": "integer", "description": "0 = Warehouse, 1 = Supplier, 2 = CheapestSupplier, 3 = FastestSupplier, 4 = StandardSupplier", "format": "int32", "x-enumNames": [ "Warehouse", "Supplier", "CheapestSupplier", "FastestSupplier", "StandardSupplier" ], "enum": [ 0, 1, 2, 3, 4 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.OrderReservation": { "type": "object", "description": "Model Class: OrderReservation ", "additionalProperties": false, "required": [ "SalesOrderId", "CompletelyReserved", "Reservations" ], "properties": { "salesOrderId": { "description": "Sales order ID", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "completelyReserved": { "type": "boolean", "description": "True if fully reserved" }, "reservations": { "type": "array", "description": "Assigned reservations", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.Reservation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.Picklist": { "type": "object", "description": "Model Class: Picklist ", "additionalProperties": false, "required": [ "PicklistId" ], "properties": { "picklistId": { "description": "ID of the pick list", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PicklisteKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.PicklistReservationOrder": { "type": "object", "description": "Model Class: PicklistReservationOrder ", "additionalProperties": false, "required": [ "SalesOrderId", "Reservations" ], "properties": { "salesOrderId": { "description": "Sales order ID", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "reservations": { "type": "array", "description": "Assigned reservations", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.PicklistReservationOrderPosition" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.PicklistReservationOrderPosition": { "type": "object", "description": "Model Class: PicklistReservationOrderPosition ", "additionalProperties": false, "required": [ "SalesOrderPositionId", "PickPositionId", "ItemId", "Amount" ], "properties": { "salesOrderPositionId": { "description": "Position ID", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "pickPositionId": { "description": "PickPosition ID", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PicklistePosKey" }, "itemId": { "description": "The reserved item Id", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "amount": { "type": "number", "description": "Reserved quantity", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.PicklistReservations": { "type": "object", "description": "Model Class: PicklistReservations ", "additionalProperties": false, "required": [ "PicklistId", "WarehouseId", "SessionId", "Timestamp", "SupplierId", "ContactPersonId", "Orders" ], "properties": { "picklistId": { "description": "Sales order ID", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PicklisteKey" }, "warehouseId": { "description": "Warehouse ID", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "sessionId": { "type": "integer", "description": "Session Id of the Picklist", "format": "int32" }, "timestamp": { "type": "string", "description": "Reservation timestamp", "format": "date-time" }, "supplierId": { "description": "Supplier Id", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "contactPersonId": { "description": "Contact Person Id", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AnsprechpartnerKey" }, "orders": { "type": "array", "description": "List of reserved orders", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.PicklistReservationOrder" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.ReassignResponse": { "type": "object", "description": "Model Class: ReassignResponse ", "additionalProperties": false, "required": [ "Picklists", "SalesOrderPositions" ], "properties": { "picklists": { "type": "array", "description": "Updated pick lists", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.Picklist" } }, "salesOrderPositions": { "type": "array", "description": "New reservations", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.SalesOrderPositionReservation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.Reservation": { "type": "object", "description": "Model Class: Reservation ", "additionalProperties": false, "required": [ "SalesOrderPositionId", "WarehouseId", "Amount", "SupplierId", "ContactPersonId" ], "properties": { "salesOrderPositionId": { "description": "Position ID", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "warehouseId": { "description": "Warehouse ID", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "amount": { "type": "number", "description": "Reserved quantity", "format": "decimal" }, "supplierId": { "description": "Supplier Id", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "contactPersonId": { "type": "integer", "description": "Contact Person Id", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.ReserveResponse": { "type": "object", "description": "Model Class: ReserveResponse ", "additionalProperties": false, "required": [ "Picklists", "OrderReservations" ], "properties": { "picklists": { "type": "array", "description": "Generated pick lists", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.Picklist" } }, "orderReservations": { "type": "array", "description": "Reservation results", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.OrderReservation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Delivery.SalesOrderPositionReservation": { "type": "object", "description": "Model Class: SalesOrderPositionReservation ", "additionalProperties": false, "required": [ "SalesOrderPositionId", "Reservations" ], "properties": { "salesOrderPositionId": { "description": "Position ID", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "reservations": { "type": "array", "description": "Reassigned reservations", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Delivery.Reservation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.DeliveryNote.CreateDeliveryNotePackagePosting": { "type": "object", "description": "Model Class: CreateDeliveryNotePackagePosting ", "additionalProperties": false, "required": [ "TrackingID" ], "properties": { "shippedDate": { "type": "string", "description": "The date when the package was shipped.", "format": "date-time" }, "trackingID": { "type": "string", "description": "The tracking Id of the package." }, "comment": { "type": "string", "description": "The comment of the package." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.DeliveryNote.DeliveryNote": { "type": "object", "description": "Model Class: DeliveryNote ", "additionalProperties": false, "required": [ "Id", "Number", "DeliveryNoteDate", "Packages" ], "properties": { "id": { "description": "Unique ID to identify a delivery note.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferscheinKey" }, "number": { "type": "string", "description": "The number of the delivery note." }, "deliveryNoteDate": { "type": "string", "description": "The date when the delivery note was created.", "format": "date-time" }, "packages": { "type": "array", "description": "All packages that are created with the delivery note.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.DeliveryNote.DeliveryNotePackage" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.DeliveryNote.DeliveryNotePackage": { "type": "object", "description": "Model Class: DeliveryNotePackage ", "additionalProperties": false, "required": [ "Id", "PackageDate", "TrackingID", "Weights", "ShippingMethodId", "ShippedDate", "TrackingUrl", "Comment" ], "properties": { "id": { "description": "The id of the package.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandKey" }, "packageDate": { "type": "string", "description": "The date when the package was created.", "format": "date-time" }, "trackingID": { "type": "string", "description": "The tracking Id of the package." }, "weights": { "type": "number", "description": "The weight of the package.", "format": "decimal" }, "shippingMethodId": { "description": "The shipping method of the package.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey" }, "shippedDate": { "type": "string", "description": "The date when the package was shipped.", "format": "date-time" }, "trackingUrl": { "type": "string", "description": "The tracking url of the package." }, "comment": { "type": "string", "description": "The comment of the package." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.DeliveryNote.DeliveryNoteWorkflowEvent": { "type": "integer", "description": "1 = Created, 2 = Deleted, 3 = Shipped", "format": "int32", "x-enumNames": [ "Created", "Deleted", "Shipped" ], "enum": [ 1, 2, 3 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.DeliveryNote.UpdateDeliveryNotePackagePosting": { "type": "object", "description": "Model Class: UpdateDeliveryNotePackagePosting ", "additionalProperties": false, "required": [ "TrackingID" ], "properties": { "shippedDate": { "type": "string", "description": "The date when the package was shipped.", "format": "date-time" }, "trackingID": { "type": "string", "description": "The tracking Id of the package." }, "comment": { "type": "string", "description": "The comment of the package." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Extensibility.CreateExtension": { "type": "object", "description": "Model Class: CreateExtension ", "additionalProperties": false, "required": [ "ExtensionId", "Version", "ManifestHash" ], "properties": { "extensionId": { "type": "string", "description": "The Unique Identifier of the Extension" }, "version": { "type": "string", "description": "The Version of Extension." }, "manifestHash": { "type": "string", "description": "The Hash of the Manifest Hexadeimcal Sha512" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Extensibility.Extension": { "type": "object", "description": "Model Class: Extension ", "additionalProperties": false, "required": [ "Id", "ExtensionId", "Version", "Created", "LastChanged", "ManifestHash", "Status" ], "properties": { "id": { "description": "The Identifier of the Extension.", "$ref": "#/components/schemas/JTL.Wawi.Extensibility.Core.Contracts.Domain.Keys.ExtensionKey" }, "extensionId": { "type": "string", "description": "The Unique Identifier of the Extension" }, "version": { "type": "string", "description": "The Version of Extension." }, "created": { "type": "string", "description": "The Date of Creation the Extension in the Wawi", "format": "date-time" }, "lastChanged": { "type": "string", "description": "The Date of the last changeof the Extension information", "format": "date-time" }, "manifestHash": { "type": "string", "description": "The Hash of the Manifest Hexadeimcal Sha512" }, "status": { "description": "The status of the Extension", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Extensibility.ExtensionRegistrationStatus" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Extensibility.ExtensionRegistrationStatus": { "type": "integer", "description": "0 = Disabled, 1 = Pending, 2 = Active", "format": "int32", "x-enumNames": [ "Disabled", "Pending", "Active" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.Extensibility.PutExtensionManifest": { "type": "object", "description": "Model Class: PutExtensionManifest ", "additionalProperties": false, "required": [ "Manifest", "Signature" ], "properties": { "manifest": { "type": "string", "description": "The Data of the Extension Manifest", "format": "byte" }, "signature": { "type": "string", "description": "The Signature of the Manifest", "format": "byte" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Extensibility.UpdateExtension": { "type": "object", "description": "Model Class: UpdateExtension ", "additionalProperties": false, "properties": { "version": { "type": "string", "description": "The Version of Extension." }, "manifestHash": { "type": "string", "description": "The Hash of the Manifest Hexadeimcal Sha512" }, "status": { "type": "integer", "description": "The status of the Extension", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Extensibility.ExtensionRegistrationStatus" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Features.FeatureInfo": { "type": "object", "description": "Model Class: FeatureInfo ", "additionalProperties": false, "required": [ "Feature", "Version", "Release", "IsUsable" ], "properties": { "feature": { "type": "string", "description": "The Identifier of the Feature." }, "version": { "type": "integer", "description": "The Version of API.", "format": "int32" }, "release": { "type": "string", "description": "The releasestate of the Feature" }, "isUsable": { "type": "boolean", "description": "The endpoint is possible to use" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Info.Status": { "type": "object", "description": "Model Class: Status ", "additionalProperties": false, "required": [ "Version", "Timestamp", "Tenant", "Type" ], "properties": { "version": { "type": "string", "description": "The Version of Wawi." }, "timestamp": { "type": "string", "description": "The current Server Time", "format": "date-time" }, "tenant": { "type": "string", "description": "The name of the current Database Tenant" }, "type": { "type": "string", "description": "Constant Identifier of API" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Invoice.CreateInvoiceCancellationDetails": { "type": "object", "description": "Model Class: CreateInvoiceCancellationDetails ", "additionalProperties": false, "required": [ "CancellationReasonId" ], "properties": { "cancellationReasonId": { "description": "The ID of the reason for cancelling the invoice.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungStornogrundKey" }, "cancellationComment": { "type": "string", "description": "A comment that adds further information to the cancellation." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Invoice.Invoice": { "type": "object", "description": "Model Class: Invoice ", "additionalProperties": false, "required": [ "Id", "Number", "ExternalNumber", "CompanyId", "DepartureCountry", "CustomerId", "BillingAddress", "ShipmentAddress", "InvoiceDate", "InvoicePaymentDetails", "ColorcodeId", "DunningBlock", "IsExternalInvoice", "Comment", "CustomerComment", "IsCancelled", "LanguageIso", "CancellationDetails" ], "properties": { "id": { "description": "Unique ID to identify an invoice.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungKey" }, "number": { "type": "string", "description": "The number of the invoice." }, "externalNumber": { "type": "string", "description": "The external number of the sales order." }, "companyId": { "description": "The company ID on the invoice.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "departureCountry": { "description": "The departure country information on the invoice. If none is indicated, it will be determined from the company's information.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceDepartureCountry" }, "customerId": { "description": "The customer ID.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "billingAddress": { "description": "The address to which the invoice is issued.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address" }, "shipmentAddress": { "description": "The adress to which the goods are shipped.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address" }, "invoiceDate": { "type": "string", "description": "The date when the invoice was created.", "format": "date-time" }, "invoicePaymentDetails": { "description": "Payment-specific information of the sales invoice.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoicePaymentDetail" }, "colorcodeId": { "description": "The colour code of the invoice.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FarbeKey" }, "dunningBlock": { "type": "boolean", "description": "The creation of dunning letters is blocked." }, "isExternalInvoice": { "type": "boolean", "description": "Indicates if the invoice of the sales order was created in an external system like Amazon VCS." }, "comment": { "type": "string", "description": "A comment on the sales order." }, "customerComment": { "type": "string", "description": "A customer comment on the sales order." }, "isCancelled": { "type": "boolean", "description": "Indicates if the invoice has been cancelled." }, "languageIso": { "type": "string", "description": "The language of the invoice." }, "cancellationDetails": { "description": "The cancellation details in case the invoice has been cancelled.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceCancellationDetails" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceCancellationDetails": { "type": "object", "description": "Model Class: InvoiceCancellationDetails ", "additionalProperties": false, "required": [ "CancellationReasonId", "CancellationComment", "Date" ], "properties": { "cancellationReasonId": { "description": "The ID of the reason for cancelling the invoice.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungStornogrundKey" }, "cancellationComment": { "type": "string", "description": "A comment that adds further information to the cancellation." }, "date": { "type": "string", "description": "The DateTime of Cancellation.", "format": "date-time" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceCancellationReason": { "type": "object", "description": "Model Class: InvoiceCancellationReason ", "additionalProperties": false, "required": [ "Id", "Name", "IsCommentRequired" ], "properties": { "id": { "description": "Unique ID to identify a cancellation reason", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungStornogrundKey" }, "name": { "type": "string", "description": "Name of the cancellation reason" }, "isCommentRequired": { "type": "boolean", "description": "Indicates if a comment is required when this cancellation reason is used" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceDepartureCountry": { "type": "object", "description": "Model Class: InvoiceDepartureCountry ", "additionalProperties": false, "required": [ "CountryISO", "State", "CurrencyIso", "CurrencyFactor" ], "properties": { "countryISO": { "type": "string", "description": "ISO code of the departure country." }, "state": { "type": "string", "description": "Name of the state in the departure country." }, "currencyIso": { "type": "string", "description": "ISO code of the currency of the departure country." }, "currencyFactor": { "type": "number", "description": "The currency factor of the departure country.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceLineItem": { "type": "object", "description": "Model Class: InvoiceLineItem ", "additionalProperties": false, "required": [ "Id", "InvoiceId", "SalesOrderId", "SalesOrderLineItemId", "ItemId", "Name", "SKU", "Type", "Quantity", "SalesUnit", "SalesPriceNet", "SalesPriceGross", "Discount", "PurchasePriceNet", "TaxRate" ], "properties": { "id": { "description": "Unique ID to identify an invoice line item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungPositionKey" }, "invoiceId": { "description": "Unique ID to identify an invoice.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungKey" }, "salesOrderId": { "description": "Unique ID to identify a sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "salesOrderLineItemId": { "description": "Unique ID to identify a sales order line item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "itemId": { "description": "Unique ID to identify an item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "name": { "type": "string", "description": "Name of the item." }, "sKU": { "type": "string", "description": "SKU of the sales invoice item." }, "type": { "description": "Type of the sales invoice item.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceLineItemType" }, "quantity": { "type": "number", "description": "The quantity of the line item.", "format": "decimal" }, "salesUnit": { "type": "string", "description": "The measurement unit in which the line item is sold." }, "salesPriceNet": { "type": "number", "description": "The net sales price of the line item.", "format": "decimal" }, "salesPriceGross": { "type": "number", "description": "The gross sales price of the line item.", "format": "decimal" }, "discount": { "type": "number", "description": "The discount applied to the line item.", "format": "decimal" }, "purchasePriceNet": { "type": "number", "description": "The price for which the merchant has bought the item.", "format": "decimal" }, "taxRate": { "type": "number", "description": "The tax rate of the line item.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceLineItemType": { "type": "integer", "description": "0 = CustomLineItem, 1 = Item, 2 = Shipping, 3 = Coupon, 4 = Voucher, 5 = Payment, 6 = ShippingSurcharge, 7 = NewCustomerCoupon, 8 = CashOnDelivery, 9 = ShippingSurchargeItem, 10 = GiftWrapping, 11 = GiftForFree, 12 = TrustedShops, 13 = InterestPremium, 14 = ProcessingFee, 15 = Carton, 16 = ReturnDelivery, 17 = MultiPurposeVoucher, 18 = MultiPurposeVoucherDigital, 19 = SinglePurposeVoucher, 20 = SinglePurposeVoucherDigital, 21 = SinglePurposeVoucherRedemption", "format": "int32", "x-enumNames": [ "CustomLineItem", "Item", "Shipping", "Coupon", "Voucher", "Payment", "ShippingSurcharge", "NewCustomerCoupon", "CashOnDelivery", "ShippingSurchargeItem", "GiftWrapping", "GiftForFree", "TrustedShops", "InterestPremium", "ProcessingFee", "Carton", "ReturnDelivery", "MultiPurposeVoucher", "MultiPurposeVoucherDigital", "SinglePurposeVoucher", "SinglePurposeVoucherDigital", "SinglePurposeVoucherRedemption" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoicePaymentDetail": { "type": "object", "description": "Model Class: InvoicePaymentDetail ", "additionalProperties": false, "required": [ "PaymentMethodId", "PaymentStatus", "TotalGrossAmount", "CurrencyIso", "CurrencyFactor", "StillToPay", "PaymentTarget", "CashDiscount", "CashDiscountDays", "StopPaymentRequest", "DunningLevel", "NextDueDate" ], "properties": { "paymentMethodId": { "description": "The payment method whith which the invoice was paid.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "paymentStatus": { "description": "The payment status of the invoice.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoicePaymentStatus" }, "totalGrossAmount": { "type": "number", "description": "The total gross amount of the invoice.", "format": "decimal" }, "currencyIso": { "type": "string", "description": "ISO code of the currency of the invoice." }, "currencyFactor": { "type": "number", "description": "The currency factor for the sales order at the time the sales order has been created.", "format": "decimal" }, "stillToPay": { "type": "number", "description": "The amount that is left to pay for this invoice.", "format": "decimal" }, "paymentTarget": { "type": "integer", "description": "The due date for payment of the sales order in days.", "format": "int32" }, "cashDiscount": { "type": "number", "description": "The cash discount of the sales order.", "format": "decimal" }, "cashDiscountDays": { "type": "integer", "description": "The days that the cash discount is valid.", "format": "int32" }, "stopPaymentRequest": { "type": "boolean", "description": "The creation of dunning letters is blocked." }, "dunningLevel": { "type": "integer", "description": "The stage at which dunning currently is", "format": "int32" }, "nextDueDate": { "type": "string", "description": "The next due date", "format": "date-time" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoicePaymentStatus": { "type": "integer", "description": "0 = UnPayed, 1 = PartialPayed, 2 = Payed", "format": "int32", "x-enumNames": [ "UnPayed", "PartialPayed", "Payed" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.Invoice.InvoiceWorkflowEvent": { "type": "integer", "description": "1 = Created, 3 = CompletePaid, 6 = Canceled", "format": "int32", "x-enumNames": [ "Created", "CompletePaid", "Canceled" ], "enum": [ 1, 3, 6 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.NumberRanges.CreateNumberRangeItem": { "type": "object", "description": "A Individuel NumberRange", "additionalProperties": false, "required": [ "CompanyId" ], "properties": { "prefix": { "type": "string", "description": "The Number Prefix for the NumberRange" }, "currentNumber": { "type": "integer", "description": "The Current Number of the NumberRange", "format": "int32" }, "suffix": { "type": "string", "description": "The Number Suffix for the NumberRange" }, "companyId": { "description": "The internal ID of the company associated with the customer. This is configured in the company and email settings in JTL-Wawi", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.NumberRanges.NumberRangeCurrentNumberItem": { "type": "object", "description": "The CurrentValue of Individuel NumberRange", "additionalProperties": false, "required": [ "NextNumber", "IsPreview" ], "properties": { "nextNumber": { "type": "string", "description": "The Next Number of the NumberRange" }, "isPreview": { "type": "boolean", "description": "Can the Number is only a Preview Number" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.NumberRanges.NumberRangeItem": { "type": "object", "description": "A Individuel NumberRange", "additionalProperties": false, "required": [ "Identifier", "Name", "Description", "Prefix", "CurrentNumber", "Suffix", "MaxLength", "ExampleNumber", "IsDeletable" ], "properties": { "identifier": { "description": "The Unique Identifier of a Sync", "$ref": "#/components/schemas/JTL.Wawi.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey" }, "name": { "type": "string", "description": "The Name of the Number Range" }, "description": { "type": "string", "description": "The Name of the Number Range" }, "prefix": { "type": "string", "description": "The Number Prefix for the NumberRange" }, "currentNumber": { "type": "integer", "description": "The Current Number of the NumberRange", "format": "int32" }, "suffix": { "type": "string", "description": "The Number Suffix for the NumberRange" }, "maxLength": { "type": "integer", "description": "The Max Length of an Number Range", "format": "int32" }, "companyId": { "description": "The internal ID of the company associated with the customer. This is configured in the company and email settings in JTL-Wawi", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "exampleNumber": { "type": "string", "description": "The Example of a Number" }, "isDeletable": { "type": "boolean", "description": "Can the Number Range be deleted" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.NumberRanges.PutNumberRangeItem": { "type": "object", "description": "A Individuel NumberRange", "additionalProperties": false, "properties": { "prefix": { "type": "string", "description": "The Number Prefix for the NumberRange" }, "currentNumber": { "type": "integer", "description": "The Current Number of the NumberRange", "format": "int32" }, "suffix": { "type": "string", "description": "The Number Suffix for the NumberRange" }, "companyId": { "description": "The internal ID of the company associated with the customer. This is configured in the company and email settings in JTL-Wawi", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.OnHoldReason.OnHoldReason": { "type": "object", "description": "Model Class: OnHoldReason ", "additionalProperties": false, "required": [ "Id", "Name", "IsMergeable", "ItemsNotUsedForPurchaseList" ], "properties": { "id": { "description": "Unique ID to identify an on hold reason.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RueckhaltegrundKey" }, "name": { "type": "string", "description": "Name of the on hold reason." }, "isMergeable": { "type": "boolean", "description": "Indicates if orders with an on hold reason are allowed to be merged with other orders from the same customer." }, "itemsNotUsedForPurchaseList": { "type": "boolean", "description": "If this option is enabled, then the items in this order are not used for calculating the purchase list." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.PaymentMethod.PaymentMethod": { "type": "object", "description": "Model Class: PaymentMethod ", "additionalProperties": false, "required": [ "Id", "Name", "IsStandard", "IsActive" ], "properties": { "id": { "description": "Unique ID to identify a payment method.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "name": { "type": "string", "description": "Name of the payment method." }, "isStandard": { "type": "boolean", "description": "Indicates if the method is the default payment method. There is only one default method and if a new one is enabled, the previous method is no longer the default one." }, "isActive": { "type": "boolean", "description": "Indicates if the payment method is still active." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Property.CreateProperty": { "type": "object", "description": "Model Class: CreateProperty ", "additionalProperties": false, "required": [ "Name" ], "properties": { "name": { "type": "string", "description": "Name of the property in the standard language." }, "translations": { "type": "array", "description": "Different terms for the property in the non-default languages.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateTranslation" } }, "propertyGroups": { "type": "array", "description": "IDs of property groups.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalGruppeKey" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Property.CreatePropertyGroup": { "type": "object", "description": "Model Class: CreatePropertyGroup ", "additionalProperties": false, "required": [ "Name" ], "properties": { "name": { "type": "string", "description": "Name of the property group." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Property.CreatePropertyValue": { "type": "object", "description": "Model Class: CreatePropertyValue ", "additionalProperties": false, "required": [ "Name" ], "properties": { "name": { "type": "string", "description": "Name of the property value in the default language." }, "description": { "type": "string", "description": "Description of the property value in the default language." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Property.CreatePropertyValueDescription": { "type": "object", "description": "Model Class: CreatePropertyValueDescription ", "additionalProperties": false, "required": [ "PropertyValueId", "Name", "LanguageIso" ], "properties": { "propertyValueId": { "description": "Unique ID to identify a property value.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalWertKey" }, "name": { "type": "string", "description": "The property value name in the given language." }, "description": { "type": "string", "description": "The property value description in the given language." }, "seoPath": { "type": "string", "description": "The SEO path in the given language." }, "seoMetaDescription": { "type": "string", "description": "The SEO metadescription in the given language." }, "seoTitleTag": { "type": "string", "description": "The title tag (SEO) in the given language." }, "seoMetaKeywords": { "type": "string", "description": "The meta keywords in the given language." }, "languageIso": { "type": "string", "description": "The ISO code of the language of the description." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Property.Property": { "type": "object", "description": "Model Class: Property ", "additionalProperties": false, "required": [ "Id", "Name", "Translations", "PropertyGroups" ], "properties": { "id": { "description": "Unique ID to identify a property.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalKey" }, "name": { "type": "string", "description": "Name of the property in the standard language." }, "translations": { "type": "array", "description": "Different terms for the property in the non-default languages.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Translation" } }, "propertyGroups": { "type": "array", "description": "IDs of property groups.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalGruppeKey" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Property.PropertyGroup": { "type": "object", "description": "Model Class: PropertyGroup ", "additionalProperties": false, "required": [ "Id", "Name" ], "properties": { "id": { "description": "Unique ID to identify a property group.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalGruppeKey" }, "name": { "type": "string", "description": "Name of the property group." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Property.PropertyValue": { "type": "object", "description": "Model Class: PropertyValue ", "additionalProperties": false, "required": [ "Id", "Name", "Description" ], "properties": { "id": { "description": "Unique ID to identify the property value.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalWertKey" }, "name": { "type": "string", "description": "Name of the property value in the default language." }, "description": { "type": "string", "description": "Description of the property value in the default language." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Property.PropertyValueDescription": { "type": "object", "description": "Model Class: PropertyValueDescription ", "additionalProperties": false, "required": [ "PropertyValueId", "Name", "Description", "SeoPath", "SeoMetaDescription", "SeoTitleTag", "SeoMetaKeywords", "LanguageIso" ], "properties": { "propertyValueId": { "description": "Unique ID to identify a property value.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalWertKey" }, "name": { "type": "string", "description": "The property value name in the given language." }, "description": { "type": "string", "description": "The property value description in the given language." }, "seoPath": { "type": "string", "description": "The SEO path in the given language." }, "seoMetaDescription": { "type": "string", "description": "The SEO metadescription in the given language." }, "seoTitleTag": { "type": "string", "description": "The title tag (SEO) in the given language." }, "seoMetaKeywords": { "type": "string", "description": "The meta keywords in the given language." }, "languageIso": { "type": "string", "description": "The ISO code of the language of the description." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Property.UpdatePropertyValue": { "type": "object", "description": "Model Class: UpdatePropertyValue ", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Name of the property value in the default language." }, "description": { "type": "string", "description": "Description of the property value in the default language." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Property.UpdatePropertyValueDescription": { "type": "object", "description": "Model Class: UpdatePropertyValueDescription ", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The property value name in the given language." }, "description": { "type": "string", "description": "The property value description in the given language." }, "seoPath": { "type": "string", "description": "The SEO path in the given language." }, "seoMetaDescription": { "type": "string", "description": "The SEO metadescription in the given language." }, "seoTitleTag": { "type": "string", "description": "The title tag (SEO) in the given language." }, "seoMetaKeywords": { "type": "string", "description": "The meta keywords in the given language." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Refund.RefundCancellationReason": { "type": "object", "description": "Model Class: RefundCancellationReason ", "additionalProperties": false, "required": [ "Id", "Name", "IsCommentRequired" ], "properties": { "id": { "description": "Unique ID to identify a cancellation reason", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.GutschriftStornogrundKey" }, "name": { "type": "string", "description": "Name of the cancellation reason" }, "isCommentRequired": { "type": "boolean", "description": "Indicates if a comment is required when this cancellation reason is used" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.ResponsiblePerson.ResponsiblePerson": { "type": "object", "description": "Model Class: ResponsiblePerson ", "additionalProperties": false, "required": [ "Id", "Number", "Description", "Address", "Created", "LastChanged", "IsActive", "LanguageKey" ], "properties": { "id": { "description": "Unique ID to identify a Contact.", "$ref": "#/components/schemas/JTL.Wawi.ContactManagement.Core.Contracts.Domain.Keys.ContactKey" }, "number": { "type": "string", "description": "Unique Number of the ResponsiblePerson." }, "description": { "type": "string", "description": "Manufacturer description." }, "address": { "description": "The customer's default address.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address" }, "created": { "type": "string", "description": "The DateTime of Creation.", "format": "date-time" }, "lastChanged": { "type": "string", "description": "The DateTime of the Lastchange.", "format": "date-time" }, "isActive": { "type": "boolean", "description": "The ResponsiblePerson is active" }, "languageKey": { "description": "The Default Language of the ResponsiblePerson", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SpracheKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Return.CreateReturn": { "type": "object", "description": "Model Class: CreateReturn ", "additionalProperties": false, "required": [ "CompanyId", "SalesOrderId", "WarehouseId", "Items" ], "properties": { "returnDate": { "type": "string", "description": "The date when the return was created.", "format": "date-time" }, "externalNumber": { "type": "string", "description": "An arbitrary external reference number for identifying the return, provided only during creation and cannot be changed afterward." }, "companyId": { "description": "The company of the corresponding sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "salesOrderId": { "description": "The id of the sales order if the return has exactly on corresponding sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "warehouseId": { "description": "Id of the Warehouse.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "externalComment": { "type": "string", "description": "The external comment of the sales order." }, "internalComment": { "type": "string", "description": "The internal comment of the sales order." }, "contact": { "type": "string", "description": "The contact of the return." }, "items": { "type": "array", "description": "List of items included in the return.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Return.CreateReturnLineItem" } }, "packages": { "type": "array", "description": "List of packages included in the return.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Return.CreateReturnPackage" } }, "transmitToSalesChannel": { "type": "boolean", "description": "Indicates whether the return should be transmitted to the sales channel (e.g. SCX or Amazon)." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Return.CreateReturnLineItem": { "type": "object", "description": "Model Class: CreateReturnLineItem ", "additionalProperties": false, "required": [ "Quantity", "ReturnReasonId" ], "properties": { "quantity": { "type": "number", "description": "The quantity of the line item.", "format": "decimal", "maximum": 2147483647, "minimum": 0.000001 }, "returnReasonId": { "description": "Unique ID to identify a return reason.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RueckgabegrundKey" }, "returnReasonComment": { "type": "string", "description": "The comment corresponding to the return line item reason." }, "credit": { "type": "boolean", "description": "Indicates whether this return line item should be credited. If omitted on creation, defaults to false." }, "salesOrderLineItemId": { "description": "Unique ID to identify a sales order item.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "deliveryNoteLineItemId": { "description": "Unique ID to identify a delivery note item.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RetourenLieferscheinPositionKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Return.CreateReturnPackage": { "type": "object", "description": "Model Class: CreateReturnPackage ", "additionalProperties": false, "required": [ "TrackingID" ], "properties": { "trackingID": { "type": "string", "description": "The tracking Id of the package." }, "shippingMethodId": { "description": "The shipping method.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey" }, "shippingMethodCustom": { "type": "string", "description": "The custom shipping method name used for the return. This value may only be set if ShippingMethodId is not provided." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Return.Return": { "type": "object", "description": "Model Class: Return ", "additionalProperties": false, "required": [ "Id", "Number", "ReturnDate", "CustomerId", "ExternalNumber", "Origin", "CompanyId", "SalesOrderId", "StateId", "WarehouseId", "ExternalComment", "InternalComment", "Contact", "TransmitToSalesChannel" ], "properties": { "id": { "description": "Unique ID to identify a return.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RetoureKey" }, "number": { "type": "string", "description": "The number of the return." }, "returnDate": { "type": "string", "description": "The date when the return was created.", "format": "date-time" }, "customerId": { "description": "The customer ID.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "externalNumber": { "type": "string", "description": "An arbitrary external reference number for identifying the return, provided only during creation and cannot be changed afterward." }, "origin": { "description": "Indicates the origin of the return, specifying where or how the return was initiated.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Return.ReturnOrigin" }, "companyId": { "description": "The company of the corresponding sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "salesOrderId": { "description": "The id of the sales order if the return has exactly on corresponding sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "stateId": { "description": "The id of the return state.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RetoureStatusKey" }, "warehouseId": { "description": "Id of the Warehouse.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "externalComment": { "type": "string", "description": "The external comment of the sales order." }, "internalComment": { "type": "string", "description": "The internal comment of the sales order." }, "contact": { "type": "string", "description": "The contact of the return." }, "transmitToSalesChannel": { "type": "boolean", "description": "Indicates whether the return should be transmitted to the sales channel (e.g. SCX or Amazon)." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Return.ReturnLineItem": { "type": "object", "description": "Model Class: ReturnLineItem ", "additionalProperties": false, "required": [ "Id", "ReturnId", "StateId", "ItemId", "Name", "SKU", "Quantity", "ReturnReasonId", "ConditionId", "ConditionComment", "Credit", "SalesOrderId", "SalesOrderLineItemId", "DeliveryNoteLineItemId" ], "properties": { "id": { "description": "Unique ID to identify a return line item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RetourePosKey" }, "returnId": { "description": "Unique ID to identify a return.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RetoureKey" }, "stateId": { "description": "The id of the return line item state.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RetoureStatusKey" }, "itemId": { "description": "Unique ID to identify an item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "name": { "type": "string", "description": "Name of the position." }, "sKU": { "type": "string", "description": "SKU of the line item." }, "quantity": { "type": "number", "description": "The quantity of the line item.", "format": "decimal" }, "returnReasonId": { "description": "Unique ID to identify a return reason.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RueckgabegrundKey" }, "returnReasonComment": { "type": "string", "description": "The comment corresponding to the return line item reason." }, "conditionId": { "description": "Unique ID to identify a condition.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZustandKey" }, "conditionComment": { "type": "string", "description": "The comment corresponding to the return line item condition." }, "credit": { "type": "boolean", "description": "Indicates whether this return line item should be credited. If omitted on creation, defaults to false." }, "salesOrderId": { "description": "Unique ID to identify a sales order file.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "salesOrderLineItemId": { "description": "Unique ID to identify a sales order item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "deliveryNoteLineItemId": { "description": "Unique ID to identify a delivery note item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RetourenLieferscheinPositionKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Return.ReturnOrigin": { "type": "integer", "description": "0 = None, 1 = Email, 2 = Manual, 3 = Phone, 4 = Fax, 5 = FFN, 6 = SCX, 7 = RestAPI", "format": "int32", "x-enumNames": [ "None", "Email", "Manual", "Phone", "Fax", "FFN", "SCX", "RestAPI" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.Return.ReturnPackage": { "type": "object", "description": "Model Class: ReturnPackage ", "additionalProperties": false, "required": [ "Id", "ReturnId", "TrackingID" ], "properties": { "id": { "description": "Unique ID to identify a return package.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RetoureEtikettKey" }, "returnId": { "description": "Unique ID to identify a return.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RetoureKey" }, "trackingID": { "type": "string", "description": "The tracking Id of the package." }, "shippingMethodId": { "description": "The shipping method.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey" }, "shippingMethodCustom": { "type": "string", "description": "The custom shipping method name used for the return. This value may only be set if ShippingMethodId is not provided." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.ReturnReason.ReturnReason": { "type": "object", "description": "Model Class: ReturnReason ", "additionalProperties": false, "required": [ "Id", "Translations" ], "properties": { "id": { "description": "Unique ID to identify an return reason.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RueckgabegrundKey" }, "translations": { "type": "array", "description": "The list of the condition names.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Translation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.ReturnState.ReturnState": { "type": "object", "description": "Model Class: ReturnState ", "additionalProperties": false, "required": [ "Id", "IsActive", "Translations" ], "properties": { "id": { "description": "Unique ID to identify an return state.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RetoureStatusKey" }, "isActive": { "type": "boolean", "description": "Indicates if the state is active." }, "translations": { "type": "array", "description": "The list of the return state.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Translation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesChannel.CategoryCapabilities": { "type": "object", "description": "Model Class: CategoryCapabilities ", "additionalProperties": false, "required": [ "Descriptions", "OnlineShopActivation" ], "properties": { "descriptions": { "type": "boolean", "description": "Indicates if the category descriptions for this sales channel can be created or changed via REST-API." }, "onlineShopActivation": { "type": "boolean", "description": "Indicates if the category for this sales channel can be activated. Categories can only be activated for online shops or JTL-POS." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesChannel.ItemCapabilities": { "type": "object", "description": "Model Class: ItemCapabilities ", "additionalProperties": false, "required": [ "Descriptions", "OnlineShopActivation", "Prices", "SpecialPrices", "Images" ], "properties": { "descriptions": { "type": "boolean", "description": "Indicates if the category descriptions for this sales channel can be created or changed via REST-API." }, "onlineShopActivation": { "type": "boolean", "description": "Indicates if the category for this sales channel can be activated. Categories can only be activated for online shops or JTL-POS." }, "prices": { "type": "boolean", "description": "Indicates if the prices for this sales channel can be manipulated." }, "specialPrices": { "type": "boolean", "description": "Indicates if the prices for this sales channel can be manipulated." }, "images": { "type": "boolean", "description": "Indicates if the images for this sales channel can be manipulated." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesChannel.SalesChannel": { "type": "object", "description": "Model Class: SalesChannel ", "additionalProperties": false, "required": [ "Id", "Type", "Name", "ItemCapabilities", "CategoryCapabilities", "DocumentationUrl" ], "properties": { "id": { "type": "string", "description": "Unique ID to identify a sales channel." }, "type": { "description": "Type of the sales channel.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesChannel.SalesChannelType" }, "name": { "type": "string", "description": "Name of the sales channel, e.g. eBay.de, amazon.uk, myshop.de." }, "itemCapabilities": { "description": "Indicates which parts of items can be manipulated for a specific sales channel via REST-API.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesChannel.ItemCapabilities" }, "categoryCapabilities": { "description": "Indicates which parts of categories can be manipulated for a specific sales channel via REST-API.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesChannel.CategoryCapabilities" }, "documentationUrl": { "type": "string", "description": "URL for the documentation of the available endpoints for this specific sales channel." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesChannel.SalesChannelType": { "type": "integer", "description": "0 = JTL_Wawi, 1 = OnlineShop, 2 = JTL_POS, 3 = Ebay, 4 = Unicorn, 5 = SCX, 6 = JTL_Fulfillment_Network, 7 = REST_API, 8 = XML_Import, 9 = Amazon, 10 = JTL_BI", "format": "int32", "x-enumNames": [ "JTL_Wawi", "OnlineShop", "JTL_POS", "Ebay", "Unicorn", "SCX", "JTL_Fulfillment_Network", "REST_API", "XML_Import", "Amazon", "JTL_BI" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesInvoiceCorrection.SalesInvoiceCorrectionCancellationReason": { "type": "object", "description": "Model Class: SalesInvoiceCorrectionCancellationReason ", "additionalProperties": false, "required": [ "Id", "Name", "IsCommentRequired" ], "properties": { "id": { "description": "Unique ID to identify a cancellation reason", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.GutschriftStornogrundKey" }, "name": { "type": "string", "description": "Name of the cancellation reason" }, "isCommentRequired": { "type": "boolean", "description": "Indicates if a comment is required when this cancellation reason is used" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.CreateDepartureCountry": { "type": "object", "description": "Model Class: CreateDepartureCountry ", "additionalProperties": false, "properties": { "countryISO": { "type": "string", "description": "ISO code of the departure country." }, "state": { "type": "string", "description": "Name of the state in the departure country." }, "currencyIso": { "type": "string", "description": "ISO code of the currency of the departure country." }, "currencyFactor": { "type": "number", "description": "The currency factor of the departure country.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.CreateSalesInvoiceRequest": { "type": "object", "description": "Model Class: CreateSalesInvoiceRequest ", "additionalProperties": false, "properties": { "invoiceOnlyDeliveredQuantity": { "type": "boolean", "description": "If true, only the delivered quantities of the sales order line items are added to the new invoice." }, "asDraft": { "type": "boolean", "description": "If true, the invoice is created as draft. An invoice draft has no invoice number yet and can be edited until finalized." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.CreateSalesOrder": { "type": "object", "description": "Model Class: CreateSalesOrder ", "additionalProperties": false, "required": [ "CompanyId", "CustomerId" ], "properties": { "number": { "type": "string", "description": "The number of the sales order." }, "externalNumber": { "type": "string", "description": "The external number of the sales order." }, "billingNumber": { "type": "string", "description": "The number of the invoice." }, "companyId": { "description": "The company of the sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "departureCountry": { "description": "The departure country information of the sales order. If none is indicated, it will be determined from the company's information.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.CreateDepartureCountry" }, "customerId": { "description": "The customer ID.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "customerVatID": { "type": "string", "description": "The VAT ID of the customer." }, "billingAddress": { "description": "The billing address of the sales order.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateAddress" }, "shipmentaddress": { "description": "The shipping address of the sales order.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateAddress" }, "salesOrderDate": { "type": "string", "description": "The date when the order was created.", "format": "date-time" }, "salesOrderPaymentDetails": { "description": "Payment specific information of the sales order.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.CreateSalesOrderPaymentDetail" }, "salesOrderShippingDetail": { "description": "Shipping specific information of the sales order.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.CreateSalesOrderShippingDetail" }, "colorcodeId": { "description": "The colour code of the sales order.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FarbeKey" }, "comment": { "type": "string", "description": "A comment on the sales order." }, "customerComment": { "type": "string", "description": "A customer comment on the sales order." }, "languageIso": { "type": "string", "description": "The language of the order." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.CreateSalesOrderCancellationDetails": { "type": "object", "description": "Model Class: CreateSalesOrderCancellationDetails ", "additionalProperties": false, "required": [ "CancellationReasonId" ], "properties": { "cancellationReasonId": { "description": "The id of the reason for cancelling the sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AuftragStornogrundKey" }, "cancellationComment": { "type": "string", "description": "A comment that adds further information to the cancellation." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.CreateSalesOrderLineItem": { "type": "object", "description": "Model Class: CreateSalesOrderLineItem ", "additionalProperties": false, "required": [ "Quantity" ], "properties": { "itemId": { "description": "Unique ID to identify an item.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "name": { "type": "string", "description": "Name of the position." }, "sKU": { "type": "string", "description": "SKU of the sales order line item." }, "quantity": { "type": "number", "description": "The quantity of the line item.", "format": "decimal" }, "salesUnit": { "type": "string", "description": "The sales unit of the line item." }, "salesPriceNet": { "type": "number", "description": "The net sales price of the item. Only net or gross price can be entered. The other price will then be calculated.", "format": "decimal" }, "salesPriceGross": { "type": "number", "description": "The gross sales price of the item. Only net or gross price can be entered. The other price will then be calculated.", "format": "decimal" }, "discount": { "type": "number", "description": "The discount of the line item.", "format": "decimal" }, "purchasePriceNet": { "type": "number", "description": "The purchase price of the item.", "format": "decimal" }, "taxRate": { "type": "number", "description": "The tax rate of the line item.", "format": "decimal" }, "notice": { "type": "string", "description": "Notice for the line item." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.CreateSalesOrderPaymentDetail": { "type": "object", "description": "Model Class: CreateSalesOrderPaymentDetail ", "additionalProperties": false, "properties": { "paymentMethodId": { "description": "The payment method of the sales order.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "currencyIso": { "type": "string", "description": "ISO code of the currency of the sales order." }, "currencyFactor": { "type": "number", "description": "The currency factor in the order at the time the order is created.", "format": "decimal" }, "paymentTarget": { "type": "integer", "description": "The payment target of the sales order in days.", "format": "int32" }, "cashDiscount": { "type": "number", "description": "The cash discount of the sales order.", "format": "decimal" }, "cashDiscountDays": { "type": "integer", "description": "The days that the cash discount is valid.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.CreateSalesOrderShippingDetail": { "type": "object", "description": "Model Class: CreateSalesOrderShippingDetail ", "additionalProperties": false, "properties": { "shippingMethodId": { "description": "The shipping method of the sales order.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey" }, "shippingPriority": { "type": "integer", "description": "The shipping priority of the sales order.", "format": "int32" }, "shippingDate": { "type": "string", "description": "The notified shipping date of the sales order.", "format": "date-time" }, "estimatedDeliveryDate": { "type": "string", "description": "The estimated delivery date of the sales order.", "format": "date-time" }, "onHoldReasonId": { "description": "The ID of the on hold reason of the sales order.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RueckhaltegrundKey" }, "extraWeight": { "type": "number", "description": "The extra weight added to the sales order.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.DeliveryCompleteStatus": { "type": "integer", "description": "0 = DeliveryNotComplete, 1 = DeliveryComplete, 2 = DeliveryCompleteWithoutNote", "format": "int32", "x-enumNames": [ "DeliveryNotComplete", "DeliveryComplete", "DeliveryCompleteWithoutNote" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.DepartureCountry": { "type": "object", "description": "Model Class: DepartureCountry ", "additionalProperties": false, "required": [ "CountryISO", "State", "CurrencyIso", "CurrencyFactor" ], "properties": { "countryISO": { "type": "string", "description": "ISO code of the departure country." }, "state": { "type": "string", "description": "Name of the state in the departure country." }, "currencyIso": { "type": "string", "description": "ISO code of the currency of the departure country." }, "currencyFactor": { "type": "number", "description": "The currency factor of the departure country.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.PaymentStatus": { "type": "integer", "description": "0 = UnPayed, 1 = PartialPayed, 2 = Payed", "format": "int32", "x-enumNames": [ "UnPayed", "PartialPayed", "Payed" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.RecalculateTaxMode": { "type": "integer", "description": "0 = NoRecalculation, 1 = KeepNetPrices, 2 = KeepGrossPrices", "format": "int32", "x-enumNames": [ "NoRecalculation", "KeepNetPrices", "KeepGrossPrices" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesInvoiceResponse": { "type": "object", "description": "Model Class: SalesInvoiceResponse ", "additionalProperties": false, "required": [ "Id", "SalesInvoiceNumber" ], "properties": { "id": { "description": "Unique ID to identify an invoice.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungKey" }, "salesInvoiceNumber": { "type": "string", "description": "The number of the invoice. The value is empty if the invoice was created as draft." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrder": { "type": "object", "description": "Model Class: SalesOrder ", "additionalProperties": false, "required": [ "Id", "Number", "ExternalNumber", "BillingNumber", "CompanyId", "DepartureCountry", "CustomerId", "CustomerVatID", "MerchantVatID", "BillingAddress", "Shipmentaddress", "SalesOrderDate", "SalesOrderPaymentDetails", "SalesOrderShippingDetail", "ColorcodeId", "IsExternalInvoice", "Comment", "CustomerComment", "IsCancelled", "LanguageIso", "CancellationDetails", "SalesChannelId", "UserCreatedId", "UserId", "TransactionStatusId" ], "properties": { "id": { "description": "Unique ID to identify a sales order file.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "number": { "type": "string", "description": "The number of the sales order." }, "externalNumber": { "type": "string", "description": "The external number of the sales order." }, "billingNumber": { "type": "string", "description": "The number of the invoice." }, "companyId": { "description": "The company of the sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "departureCountry": { "description": "The departure country information of the sales order. If none is indicated, it will be determined from the company's information.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.DepartureCountry" }, "customerId": { "description": "The customer ID.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "customerVatID": { "type": "string", "description": "The VAT ID of the customer." }, "merchantVatID": { "type": "string", "description": "The VAT ID of the merchant." }, "billingAddress": { "description": "The billing address of the sales order.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address" }, "shipmentaddress": { "description": "The shipping address of the sales order.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address" }, "salesOrderDate": { "type": "string", "description": "The date when the order was created.", "format": "date-time" }, "salesOrderPaymentDetails": { "description": "Payment specific information of the sales order.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderPaymentDetail" }, "salesOrderShippingDetail": { "description": "Shipping specific information of the sales order.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderShippingDetail" }, "colorcodeId": { "description": "The colour code of the sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FarbeKey" }, "isExternalInvoice": { "type": "boolean", "description": "Indicates if the invoice of the order was created in an external system, like Amazon VCS." }, "comment": { "type": "string", "description": "A comment on the sales order." }, "customerComment": { "type": "string", "description": "A customer comment on the sales order." }, "isCancelled": { "type": "boolean", "description": "Indicates if the order has been cancelled. There is a special endpoint for cancelling sales orders." }, "languageIso": { "type": "string", "description": "The language of the order." }, "cancellationDetails": { "description": "The cancellation details in case the sales order has been cancelled.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderCancellationDetails" }, "salesChannelId": { "type": "string", "description": "The sales channel of the sales order." }, "userCreatedId": { "description": "The user who created the sales order.", "$ref": "#/components/schemas/JTL.Identity.Abstractions.BenutzerKey" }, "userId": { "description": "The user who is responsible for the sales order.", "$ref": "#/components/schemas/JTL.Identity.Abstractions.BenutzerKey" }, "transactionStatusId": { "description": "Unique ID to identify a transaction's status.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VorgangsstatusKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderCancellationDetails": { "type": "object", "description": "Model Class: SalesOrderCancellationDetails ", "additionalProperties": false, "required": [ "CancellationReasonId", "CancellationComment", "Date" ], "properties": { "cancellationReasonId": { "description": "The id of the reason for cancelling the sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AuftragStornogrundKey" }, "cancellationComment": { "type": "string", "description": "A comment that adds further information to the cancellation." }, "date": { "type": "string", "description": "The DateTime of Cancellation.", "format": "date-time" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderCancellationReason": { "type": "object", "description": "Model Class: SalesOrderCancellationReason ", "additionalProperties": false, "required": [ "Id", "Name", "IsCommentRequired" ], "properties": { "id": { "description": "Unique ID to identify a cancellation reason", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AuftragStornogrundKey" }, "name": { "type": "string", "description": "Name of the cancellation reason" }, "isCommentRequired": { "type": "boolean", "description": "Indicates if a comment is required when this cancellation reason is used" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderFile": { "type": "object", "description": "Model Class: SalesOrderFile ", "additionalProperties": false, "required": [ "Id", "SalesOrderId", "FileId", "FileDataType", "Size", "CreatedAt", "FileName" ], "properties": { "id": { "description": "Unique ID to identify a sales order file.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragFileKey" }, "salesOrderId": { "description": "Unique ID to identify a sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "fileId": { "description": "Unique ID to identify a file.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FileKey" }, "fileDataType": { "type": "string", "description": "Type of file." }, "size": { "type": "number", "description": "Image size.", "format": "decimal" }, "createdAt": { "type": "string", "description": "Date when the file was created in the system.", "format": "date-time" }, "fileName": { "type": "string", "description": "name of the file." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderLineItem": { "type": "object", "description": "Model Class: SalesOrderLineItem ", "additionalProperties": false, "required": [ "Id", "SalesOrderId", "ItemId", "Name", "SKU", "Type", "Quantity", "QuantityDelivered", "QuantityReturned", "SalesUnit", "SalesPriceNet", "SalesPriceGross", "Discount", "PurchasePriceNet", "TaxRate", "Notice" ], "properties": { "id": { "description": "Unique ID to identify a sales order item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "salesOrderId": { "description": "Unique ID to identify a sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "itemId": { "description": "Unique ID to identify an item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "name": { "type": "string", "description": "Name of the position." }, "sKU": { "type": "string", "description": "SKU of the sales order line item." }, "type": { "description": "Type of the sales order line item. Type 0 -> free-text position | Type 1 -> item position", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderLineItemType" }, "quantity": { "type": "number", "description": "The quantity of the line item.", "format": "decimal" }, "quantityDelivered": { "type": "number", "description": "The quantity of the line item that has been delivered.", "format": "decimal" }, "quantityReturned": { "type": "number", "description": "The quantity of the line item that has been returned.", "format": "decimal" }, "salesUnit": { "type": "string", "description": "The sales unit of the line item." }, "salesPriceNet": { "type": "number", "description": "The net sales price of the item. Only net or gross price can be entered. The other price will then be calculated.", "format": "decimal" }, "salesPriceGross": { "type": "number", "description": "The gross sales price of the item. Only net or gross price can be entered. The other price will then be calculated.", "format": "decimal" }, "discount": { "type": "number", "description": "The discount of the line item.", "format": "decimal" }, "purchasePriceNet": { "type": "number", "description": "The purchase price of the item.", "format": "decimal" }, "taxRate": { "type": "number", "description": "The tax rate of the line item.", "format": "decimal" }, "notice": { "type": "string", "description": "Notice for the line item." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderLineItemFile": { "type": "object", "description": "Model Class: SalesOrderLineItemFile ", "additionalProperties": false, "required": [ "Id", "SalesOrderLineItemId", "SalesOrderId", "FileId", "FileDataType", "Size", "CreatedAt", "FileName" ], "properties": { "id": { "description": "Unique ID to identify a sales order line item file.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionFileKey" }, "salesOrderLineItemId": { "description": "Unique ID to identify a sales order item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "salesOrderId": { "description": "Unique ID to identify a sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "fileId": { "description": "Unique ID to identify a file.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FileKey" }, "fileDataType": { "type": "string", "description": "Type of file." }, "size": { "type": "number", "description": "Image size.", "format": "decimal" }, "createdAt": { "type": "string", "description": "Date when the file was created in the system.", "format": "date-time" }, "fileName": { "type": "string", "description": "name of the file." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderLineItemType": { "type": "integer", "description": "0 = Blank, 1 = Item, 2 = Shipping, 3 = Coupon, 4 = Voucher, 5 = Payment, 6 = ShippingSurcharge, 7 = NewCustomerCoupon, 8 = CashOnDelivery, 9 = ShippingSurchargeItem, 10 = Packing, 11 = GiftForFree, 12 = TrustedShops, 13 = InterestPremium, 14 = ProcessingFee, 15 = Carton, 16 = ReturnDelivery, 17 = MultiPurposeVoucher, 18 = MultiPurposeVoucherDigital, 19 = SinglePurposeVoucher, 20 = SinglePurposeVoucherDigital, 21 = SinglePurposeVoucherRedemption", "format": "int32", "x-enumNames": [ "Blank", "Item", "Shipping", "Coupon", "Voucher", "Payment", "ShippingSurcharge", "NewCustomerCoupon", "CashOnDelivery", "ShippingSurchargeItem", "Packing", "GiftForFree", "TrustedShops", "InterestPremium", "ProcessingFee", "Carton", "ReturnDelivery", "MultiPurposeVoucher", "MultiPurposeVoucherDigital", "SinglePurposeVoucher", "SinglePurposeVoucherDigital", "SinglePurposeVoucherRedemption" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderPaymentDetail": { "type": "object", "description": "Model Class: SalesOrderPaymentDetail ", "additionalProperties": false, "required": [ "PaymentMethodId", "PaymentStatus", "TotalGrossAmount", "CurrencyIso", "CurrencyFactor", "DateOfPayment", "StillToPay", "PaymentTarget", "CashDiscount", "CashDiscountDays" ], "properties": { "paymentMethodId": { "description": "The payment method of the sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "paymentStatus": { "description": "The payment status of the sales order", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.PaymentStatus" }, "totalGrossAmount": { "type": "number", "description": "The total gross amount of the sales order.", "format": "decimal" }, "currencyIso": { "type": "string", "description": "ISO code of the currency of the sales order." }, "currencyFactor": { "type": "number", "description": "The currency factor in the order at the time the order is created.", "format": "decimal" }, "dateOfPayment": { "type": "string", "description": "Date of payment that paid off the sales order.", "format": "date-time" }, "stillToPay": { "type": "number", "description": "The amount that is left to pay for this sales order.", "format": "decimal" }, "paymentTarget": { "type": "integer", "description": "The payment target of the sales order in days.", "format": "int32" }, "cashDiscount": { "type": "number", "description": "The cash discount of the sales order.", "format": "decimal" }, "cashDiscountDays": { "type": "integer", "description": "The days that the cash discount is valid.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderShippingDetail": { "type": "object", "description": "Model Class: SalesOrderShippingDetail ", "additionalProperties": false, "required": [ "ShippingMethodId", "DeliveryCompleteStatus", "ShippingPriority", "ShippingDate", "EstimatedDeliveryDate", "DeliveredDate", "OnHoldReasonId", "ExtraWeight" ], "properties": { "shippingMethodId": { "description": "The shipping method of the sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey" }, "deliveryCompleteStatus": { "description": "The delivery status of the sales order.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.DeliveryCompleteStatus" }, "shippingPriority": { "type": "integer", "description": "The shipping priority of the sales order.", "format": "int32" }, "shippingDate": { "type": "string", "description": "The notified shipping date of the sales order.", "format": "date-time" }, "estimatedDeliveryDate": { "type": "string", "description": "The estimated delivery date of the sales order.", "format": "date-time" }, "deliveredDate": { "type": "string", "description": "The date when the sales order was delivered.", "format": "date-time" }, "onHoldReasonId": { "description": "The ID of the on hold reason of the sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RueckhaltegrundKey" }, "extraWeight": { "type": "number", "description": "The extra weight added to the sales order.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.SalesOrderWorkflowEvent": { "type": "integer", "description": "1 = Created, 2 = Deleted, 3 = Changed, 4 = Delievered, 5 = Canceled, 6 = Joined, 7 = Splittet, 9 = WithOutShipping, 10 = CompletePaid", "format": "int32", "x-enumNames": [ "Created", "Deleted", "Changed", "Delievered", "Canceled", "Joined", "Splittet", "WithOutShipping", "CompletePaid" ], "enum": [ 1, 2, 3, 4, 5, 6, 7, 9, 10 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.UpdateDepartureCountry": { "type": "object", "description": "Model Class: UpdateDepartureCountry ", "additionalProperties": false, "properties": { "countryISO": { "type": "string", "description": "ISO code of the departure country." }, "state": { "type": "string", "description": "Name of the state in the departure country." }, "currencyIso": { "type": "string", "description": "ISO code of the currency of the departure country." }, "currencyFactor": { "type": "number", "description": "The currency factor of the departure country.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.UpdateSalesOrder": { "type": "object", "description": "Model Class: UpdateSalesOrder ", "additionalProperties": false, "properties": { "externalNumber": { "type": "string", "description": "The external number of the sales order." }, "billingNumber": { "type": "string", "description": "The number of the invoice." }, "companyId": { "description": "The company of the sales order.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "departureCountry": { "description": "The departure country information of the sales order. If none is indicated, it will be determined from the company's information.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.UpdateDepartureCountry" }, "customerId": { "description": "The customer ID.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "customerVatID": { "type": "string", "description": "The VAT ID of the customer." }, "billingAddress": { "description": "The billing address of the sales order.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateAddress" }, "shipmentaddress": { "description": "The shipping address of the sales order.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateAddress" }, "salesOrderDate": { "type": "string", "description": "The date when the order was created.", "format": "date-time" }, "salesOrderPaymentDetails": { "description": "Payment specific information of the sales order.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.UpdateSalesOrderPaymentDetail" }, "salesOrderShippingDetail": { "description": "Shipping specific information of the sales order.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.UpdateSalesOrderShippingDetail" }, "colorcodeId": { "description": "The colour code of the sales order.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FarbeKey" }, "comment": { "type": "string", "description": "A comment on the sales order." }, "customerComment": { "type": "string", "description": "A customer comment on the sales order." }, "languageIso": { "type": "string", "description": "The language of the order." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.UpdateSalesOrderLineItem": { "type": "object", "description": "Model Class: UpdateSalesOrderLineItem ", "additionalProperties": false, "properties": { "itemId": { "description": "Unique ID to identify an item.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "name": { "type": "string", "description": "Name of the position." }, "sKU": { "type": "string", "description": "SKU of the sales order line item." }, "quantity": { "type": "number", "description": "The quantity of the line item.", "format": "decimal" }, "salesUnit": { "type": "string", "description": "The sales unit of the line item." }, "salesPriceNet": { "type": "number", "description": "The net sales price of the item. Only net or gross price can be entered. The other price will then be calculated.", "format": "decimal" }, "salesPriceGross": { "type": "number", "description": "The gross sales price of the item. Only net or gross price can be entered. The other price will then be calculated.", "format": "decimal" }, "discount": { "type": "number", "description": "The discount of the line item.", "format": "decimal" }, "purchasePriceNet": { "type": "number", "description": "The purchase price of the item.", "format": "decimal" }, "taxRate": { "type": "number", "description": "The tax rate of the line item.", "format": "decimal" }, "notice": { "type": "string", "description": "Notice for the line item." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.UpdateSalesOrderLineItemFile": { "type": "object", "description": "Model Class: UpdateSalesOrderLineItemFile ", "additionalProperties": false, "properties": { "fileData": { "type": "string", "description": "Base64 encoded data of the file.", "format": "byte" }, "fileDataType": { "type": "string", "description": "Type of file." }, "fileName": { "type": "string", "description": "name of the file." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.UpdateSalesOrderPaymentDetail": { "type": "object", "description": "Model Class: UpdateSalesOrderPaymentDetail ", "additionalProperties": false, "properties": { "paymentMethodId": { "description": "The payment method of the sales order.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "currencyIso": { "type": "string", "description": "ISO code of the currency of the sales order." }, "currencyFactor": { "type": "number", "description": "The currency factor in the order at the time the order is created.", "format": "decimal" }, "paymentTarget": { "type": "integer", "description": "The payment target of the sales order in days.", "format": "int32" }, "cashDiscount": { "type": "number", "description": "The cash discount of the sales order.", "format": "decimal" }, "cashDiscountDays": { "type": "integer", "description": "The days that the cash discount is valid.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.SalesOrder.UpdateSalesOrderShippingDetail": { "type": "object", "description": "Model Class: UpdateSalesOrderShippingDetail ", "additionalProperties": false, "properties": { "shippingMethodId": { "description": "The shipping method of the sales order.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey" }, "shippingPriority": { "type": "integer", "description": "The shipping priority of the sales order.", "format": "int32" }, "shippingDate": { "type": "string", "description": "The notified shipping date of the sales order.", "format": "date-time" }, "estimatedDeliveryDate": { "type": "string", "description": "The estimated delivery date of the sales order.", "format": "date-time" }, "onHoldReasonId": { "description": "The ID of the on hold reason of the sales order.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RueckhaltegrundKey" }, "extraWeight": { "type": "number", "description": "The extra weight added to the sales order.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.ShippingClass.ShippingClass": { "type": "object", "description": "Model Class: ShippingClass ", "additionalProperties": false, "required": [ "Id", "Name" ], "properties": { "id": { "description": "Unique ID to identify a shipping class.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandklasseKey" }, "name": { "type": "string", "description": "The name of the shipping class." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.ShippingMethod.ShippingMethod": { "type": "object", "description": "Model Class: ShippingMethod ", "additionalProperties": false, "required": [ "Id", "Name", "Priority", "GrossPrice", "ExtraWeight", "IsAmazonPrime" ], "properties": { "id": { "description": "Unique ID to identify a shipping method.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey" }, "name": { "type": "string", "description": "Name of the shipping method." }, "priority": { "type": "integer", "description": "The priority of the shipping method.", "format": "int32" }, "grossPrice": { "type": "number", "description": "Gross price of the shipping method.", "format": "decimal" }, "extraWeight": { "type": "number", "description": "Extra weight for each parcel created with the shipping method.", "format": "decimal" }, "isAmazonPrime": { "type": "boolean", "description": "Indicates if seller-fulfilled Amazon Prime should be applied to the shipping method." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Stock.CreateStock": { "type": "object", "description": "Model Class: CreateStock ", "additionalProperties": false, "required": [ "WarehouseId", "ItemId", "Quantity" ], "properties": { "warehouseId": { "description": "Warehouse ID.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "storageLocationId": { "description": "Storage location ID if the warehouse type is JTL-WMS.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" }, "itemId": { "description": "Id of the item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "shelfLifeExpirationDate": { "type": "string", "description": "Shelf life expiration date of the item, if applicable.", "format": "date-time" }, "batchNumber": { "type": "string", "description": "Batch number of the item if, the item is a batch item." }, "quantity": { "type": "number", "description": "The quantity that should be added to this storage location.", "format": "decimal" }, "purchasePriceNet": { "type": "number", "description": "The purchase price of the item.", "format": "decimal" }, "serialNumbers": { "type": "array", "description": "Serial numbers of the item. The amount of serial numbers must match the quantity and no serial numbers that are already in stock are allowed.", "items": { "type": "string" } }, "comment": { "type": "string", "description": "Comment for this stock change." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Stock.SerialNumber": { "type": "object", "description": "Model Class: SerialNumber ", "additionalProperties": false, "required": [ "WarehouseId", "StorageLocationId", "ItemId", "SerialNumbers" ], "properties": { "warehouseId": { "description": "Id of the Warehouse.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "storageLocationId": { "description": "Id of the storage location if the warehouse type is JTL-WMS.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" }, "itemId": { "description": "Id of the item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "serialNumbers": { "type": "array", "description": "Serial numbers of the item.", "items": { "type": "string" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Stock.Stock": { "type": "object", "description": "Model Class: Stock ", "additionalProperties": false, "required": [ "WarehouseId", "StorageLocationId", "StorageLocationName", "ItemId", "ShelfLifeExpirationDate", "BatchNumber", "QuantityTotal", "QuantityLockedForShipment", "QuantityLockedForAvailability", "QuantityInPickingLists" ], "properties": { "warehouseId": { "description": "Warehouse ID.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "storageLocationId": { "description": "Storage location ID if the warehouse type is JTL-WMS.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" }, "storageLocationName": { "type": "string", "description": "Name of the storage location." }, "itemId": { "description": "Id of the item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "shelfLifeExpirationDate": { "type": "string", "description": "Shelf life expiration date of the item, if applicable.", "format": "date-time" }, "batchNumber": { "type": "string", "description": "Batch number of the item if, the item is a batch item." }, "quantityTotal": { "type": "number", "description": "Total quantity of this item at this storage location.", "format": "decimal" }, "quantityLockedForShipment": { "type": "number", "description": "Quantity at this storage location that is locked for shipment, f.e. because the storage location or warehouse is locked for shipment.", "format": "decimal" }, "quantityLockedForAvailability": { "type": "number", "description": "Quantity at this storage location that is locked for availability, f.e. because the storage location or warehouse is locked for availability.", "format": "decimal" }, "quantityInPickingLists": { "type": "number", "description": "Quantity at this storage location that is on picking lists.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Stock.StockChange": { "type": "object", "description": "Model Class: StockChange ", "additionalProperties": false, "required": [ "ItemId", "WarehouseId", "StorageLocationId", "Quantity", "ChangedDate", "ShelfLifeExpirationDate", "BatchNumber", "Comment", "Username" ], "properties": { "itemId": { "description": "Id of the item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "warehouseId": { "description": "Id of the Warehouse.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "storageLocationId": { "description": "Id of the storage location.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" }, "quantity": { "type": "number", "description": "The quantity that was changed.", "format": "decimal" }, "changedDate": { "type": "string", "description": "The date when the stock change took place.", "format": "date-time" }, "shelfLifeExpirationDate": { "type": "string", "description": "Shelf life expiration date of the item if the item has one.", "format": "date-time" }, "batchNumber": { "type": "string", "description": "Batch number of the item if the item is a batch item." }, "comment": { "type": "string", "description": "Comment for this stock change." }, "username": { "type": "string", "description": "Name of the user who made this stock change." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Supplier.Supplier": { "type": "object", "description": "Model Class: Supplier ", "additionalProperties": false, "required": [ "Id", "Name", "Type", "SupplierNo", "InternalCustomerId", "LanguageISO", "FormOfAddress", "FirstName", "LastName", "Company", "Company2", "Contact", "Street", "Address2", "PostalCode", "City", "State", "CountryIso", "Phone", "PhoneExtension", "Fax", "Email", "Website", "Comment", "VatID", "Status", "LastChangedDate" ], "properties": { "id": { "description": "Unique ID to identify a supplier.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "name": { "type": "string", "description": "Supplier name." }, "type": { "type": "string" }, "supplierNo": { "type": "string", "description": "Supplier ID number." }, "internalCustomerId": { "type": "string", "description": "Internal customer ID of the supplier." }, "languageISO": { "type": "string", "description": "The language ISO of a supplier." }, "formOfAddress": { "type": "string", "description": "The form of address of the supplier." }, "firstName": { "type": "string", "description": "Supplier first name." }, "lastName": { "type": "string", "description": "Supplier last name." }, "company": { "type": "string", "description": "Name of the supplier's company." }, "company2": { "type": "string", "description": "The additional address infomation about the company." }, "contact": { "type": "string", "description": "Supplier's contact person." }, "street": { "type": "string", "description": "Supplier's street and house number." }, "address2": { "type": "string", "description": "Additional address information." }, "postalCode": { "type": "string", "description": "Supplier's postal code." }, "city": { "type": "string", "description": "Supplier's city." }, "state": { "type": "string", "description": "Supplier's state." }, "countryIso": { "type": "string", "description": "Country ISO code of the address." }, "phone": { "type": "string", "description": "Supplier's main telephone number." }, "phoneExtension": { "type": "string", "description": "Supplier's telephone number extension." }, "fax": { "type": "string", "description": "Supplier's fax number." }, "email": { "type": "string", "description": "Supplier's email address." }, "website": { "type": "string", "description": "Supplier's website." }, "comment": { "type": "string", "description": "Additional information about the supplier." }, "vatID": { "type": "string", "description": "Supplier's VAT ID number." }, "status": { "type": "string", "description": "Supplier's status." }, "lastChangedDate": { "type": "string", "description": "Last change date of the supplier.", "format": "date-time" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Tax.TaxRate": { "type": "object", "description": "Model Class: TaxRate ", "additionalProperties": false, "required": [ "Rate", "TaxClassId", "DepartureCountryISO", "ShipmentCountryISO" ], "properties": { "rate": { "type": "number", "description": "The given Rate", "format": "decimal" }, "taxClassId": { "description": "The ID of the tax class.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey" }, "departureCountryISO": { "type": "string", "description": "Country ISO code of the address." }, "shipmentCountryISO": { "type": "string", "description": "Country ISO code of the address." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.TaxClass.TaxClass": { "type": "object", "description": "Model Class: TaxClass ", "additionalProperties": false, "required": [ "Id", "Name", "IsDefault", "Type" ], "properties": { "id": { "description": "Unique ID to identify a tax class.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey" }, "name": { "type": "string", "description": "Name of the tax class." }, "isDefault": { "type": "boolean", "description": "Indicates whether or not the tax class is the default one. There can be only one default tax class." }, "type": { "description": "Type of the tax rate.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.TaxClass.TaxRateType" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.TaxClass.TaxRateType": { "type": "integer", "description": "0 = KeinTyp, 1 = StarkErmaessigterSatz, 2 = ErmaessigterSatzNiedrig, 3 = ErmaessigterSatz, 4 = NormalerSatz, 5 = Zwischensatz", "format": "int32", "x-enumNames": [ "KeinTyp", "StarkErmaessigterSatz", "ErmaessigterSatzNiedrig", "ErmaessigterSatz", "NormalerSatz", "Zwischensatz" ], "enum": [ 0, 1, 2, 3, 4, 5 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.TransactionStatus.TransactionStatus": { "type": "object", "description": "Model Class: TransactionStatus ", "additionalProperties": false, "required": [ "Id", "Name", "IsValidForSalesQuotation", "IsValidForSalesOrder", "IsValidForSubscription" ], "properties": { "id": { "type": "integer", "description": "Unique ID to identify a transaction's status.", "format": "int32" }, "name": { "type": "string", "description": "Name of the transaction status." }, "isValidForSalesQuotation": { "type": "boolean", "description": "Indicates if a transaction status can be used for sales quotations." }, "isValidForSalesOrder": { "type": "boolean", "description": "Indicates if a transaction status can be used for sales orders." }, "isValidForSubscription": { "type": "boolean", "description": "Indicates if a transaction status can be used for subscriptions." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Warehouse.StorageLocation": { "type": "object", "description": "Model Class: StorageLocation ", "additionalProperties": false, "required": [ "Id", "WarehouseId", "Name", "StorageLocationType", "SortNumber", "Priority", "LockForShipment", "LockForAvailability", "Comment", "Dimensions" ], "properties": { "id": { "description": "Unique ID of the storage location or bin.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" }, "warehouseId": { "description": "ID of the warehouse where the storage location is located.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "name": { "type": "string", "description": "Name of the storage bin. This identifies the exact location inside the warehouse." }, "storageLocationType": { "description": "Type of the storage location.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Warehouse.StorageLocationType" }, "sortNumber": { "type": "integer", "description": "Sort number for the storage location. Used for creating picking lists.", "format": "int32" }, "priority": { "type": "integer", "description": "Priority of the storage location.", "format": "int32" }, "lockForShipment": { "type": "boolean", "description": "Declares if the warehouse is locked for shipment." }, "lockForAvailability": { "type": "boolean", "description": "Declares is the warehouse is locked for stock availabilites." }, "comment": { "type": "string", "description": "Comment for the storage bin." }, "dimensions": { "description": "Dimentions of the storage bin.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Dimensions" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Warehouse.StorageLocationType": { "type": "object", "description": "Model Class: StorageLocationType ", "additionalProperties": false, "required": [ "Id", "Name", "Description", "Scope" ], "properties": { "id": { "type": "string", "description": "Unique Id of the storage location type as UUID." }, "name": { "type": "string", "description": "Name of the storage location type." }, "description": { "type": "string", "description": "Description of the storage location type." }, "scope": { "type": "array", "description": "List of Scopes with permissions", "items": { "type": "string" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Warehouse.Warehouse": { "type": "object", "description": "Model Class: Warehouse ", "additionalProperties": false, "required": [ "Id", "Name", "Address", "Code", "Type", "Description", "Priority", "CompanyId", "LockForShipment", "LockForAvailability", "IsActive" ], "properties": { "id": { "description": "Unique ID of the warehouse.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "name": { "type": "string", "description": "Name of the warehouse." }, "address": { "description": "Address of the warehouse.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address" }, "code": { "type": "string", "description": "Code of the warehouse." }, "type": { "description": "Type of the warehouse.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Warehouse.WarehouseType" }, "description": { "type": "string", "description": "A description on the warehouse." }, "priority": { "type": "integer", "description": "Priority level of the warehouse.", "format": "int32" }, "companyId": { "description": "Company assigned to the warehouse.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "lockForShipment": { "type": "boolean", "description": "Indicates if the warehouse is locked for shipment." }, "lockForAvailability": { "type": "boolean", "description": "Indicates if the warehouse is locked for stock availability." }, "isActive": { "type": "boolean", "description": "Indicates if the warehouse is active." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Warehouse.WarehouseType": { "type": "object", "description": "Model Class: WarehouseType ", "additionalProperties": false, "required": [ "Id", "Name", "Description", "Scope" ], "properties": { "id": { "type": "string", "description": "Unique Id of the warehouse type as UUID." }, "name": { "type": "string", "description": "Name of the warehouse type." }, "description": { "type": "string", "description": "Description of the warehouse type." }, "scope": { "type": "array", "description": "List of Scopes with permissions", "items": { "type": "string" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.WMS.ChangeReservation": { "type": "object", "description": "Model Class: ChangeReservation ", "additionalProperties": false, "required": [ "Error", "UpdatedPositions" ], "properties": { "error": { "description": "todo", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.WMS.ChangeReservationError" }, "updatedPositions": { "type": "array", "description": "todo", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.WMS.PickListPosition" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.WMS.ChangeReservationError": { "type": "integer", "description": "0 = None, 1 = Unknown, 2 = PartialReserved, 3 = NothingReserved", "format": "int32", "x-enumNames": [ "None", "Unknown", "PartialReserved", "NothingReserved" ], "enum": [ 0, 1, 2, 3 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.WMS.CreatePickList": { "type": "object", "description": "Model Class: CreatePickList ", "additionalProperties": false, "required": [ "PickListTemplateId" ], "properties": { "pickListTemplateId": { "description": "Id of the pick list template that created the pick list.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PicklisteVorlageKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.WMS.PickList": { "type": "object", "description": "Model Class: PickList ", "additionalProperties": false, "required": [ "Id", "WarehouseId", "PicklistNumber", "PickListTemplateId", "PickListTemplateName", "Status", "CreatedAt" ], "properties": { "id": { "description": "Internal unique id of the pick list. This is not the same as the pick list number.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PicklisteKey" }, "warehouseId": { "description": "Id of the Warehouse.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "picklistNumber": { "type": "string", "description": "Number of the pick list. This can be resetted in JTL-Wawi, but is always used for printing and showing the pick list in the UI." }, "pickListTemplateId": { "description": "Id of the pick list template that created the pick list.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PicklisteVorlageKey" }, "pickListTemplateName": { "type": "string", "description": "Name of the pick list template that created the pick list." }, "status": { "description": "Status of the pick list.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.WMS.PickListStatus" }, "createdAt": { "type": "string", "description": "Time when the pick list was created.", "format": "date-time" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.WMS.PickListPosition": { "type": "object", "description": "Model Class: PickListPosition ", "additionalProperties": false, "required": [ "Id", "WarehouseId", "PicklistId", "StorageLocationId", "ItemId", "Quantity", "Status", "Priority", "SalesOrderLineItemId", "CreatedAt", "SalesOrderId" ], "properties": { "id": { "description": "Id of the pick list position.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PicklistePosKey" }, "warehouseId": { "description": "Id of the warehouse.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "picklistId": { "description": "Id of the pick list.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PicklisteKey" }, "storageLocationId": { "description": "Id of the storage location from where the pick should happen.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" }, "itemId": { "description": "Id of the item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "quantity": { "type": "number", "description": "Quantity to pick.", "format": "decimal" }, "status": { "description": "Status of the position.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.WMS.PickListStatus" }, "priority": { "type": "integer", "description": "Priority of the position.", "format": "int32" }, "salesOrderLineItemId": { "description": "Id of the corresponding order position.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "createdAt": { "type": "string", "description": "Time when the pick list was created.", "format": "date-time" }, "salesOrderId": { "description": "Search for a specific sales order Id.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.WMS.PickListStatus": { "type": "integer", "description": "10 = Created, 11 = InProgress, 20 = Picked, 30 = InShippingBox, 40 = Completed", "format": "int32", "x-enumNames": [ "Created", "InProgress", "Picked", "InShippingBox", "Completed" ], "enum": [ 10, 11, 20, 30, 40 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.WMS.PickListTemplate": { "type": "object", "description": "Model Class: PickListTemplate ", "additionalProperties": false, "required": [ "PickListTemplateId", "Name" ], "properties": { "pickListTemplateId": { "description": "Id of the pick list template.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PicklisteVorlageKey" }, "name": { "type": "string", "description": "Name of the pick list template." } } }, "JTL.Wawi.Rest.Contracts.Models.V1.WMS.UpdateChangeReservation": { "type": "object", "description": "Model Class: UpdateChangeReservation ", "additionalProperties": false, "properties": { "storageLocationList": { "type": "array", "description": "Id of the storage location from where the pick should happen.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.WMS.UpdatePickPosition": { "type": "object", "description": "Model Class: UpdatePickPosition ", "additionalProperties": false, "properties": { "quantity": { "type": "number", "description": "Quantity to pick.", "format": "decimal" }, "shelfLifeExpirationDate": { "type": "string", "description": "Shelf life expiration date of the item, if applicable.", "format": "date-time" }, "batchNumber": { "type": "string", "description": "Batch number of the item if, the item is a batch item." }, "serialNumbers": { "type": "array", "description": "Serial numbers of the item. The amount of serial numbers must match the quantity and no serial numbers that are already in stock are allowed.", "items": { "type": "string" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Worker.CreateWorkerSyncConfiguration": { "type": "object", "description": "Model Class: CreateWorkerSyncConfiguration ", "additionalProperties": false, "properties": { "interval": { "type": "string", "description": "The Sync Interval", "format": "duration" }, "configs": { "type": "array", "description": "The Config Items to Set", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateConfigItem" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Worker.PutWorkerSyncAction": { "type": "object", "description": "Model Class: PutWorkerSyncAction ", "additionalProperties": false, "required": [ "Action" ], "properties": { "action": { "description": "The Action to Execute", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Worker.WorkerControlAction" } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Worker.SyncState": { "type": "integer", "description": "0 = Suspended, 1 = Starting, 2 = Running, 3 = SuccessfullFinished, 4 = SleepingError, 5 = Stopping, 6 = SleepingErrorGesperrt, 7 = Deactivated", "format": "int32", "x-enumNames": [ "Suspended", "Starting", "Running", "SuccessfullFinished", "SleepingError", "Stopping", "SleepingErrorGesperrt", "Deactivated" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.Worker.WorkerControlAction": { "type": "integer", "description": "0 = Start, 1 = Stop, 2 = Restart", "format": "int32", "x-enumNames": [ "Start", "Stop", "Restart" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Rest.Contracts.Models.V1.Worker.WorkerSyncItem": { "type": "object", "description": "Model Class: WorkerSyncItem ", "additionalProperties": false, "required": [ "Identifier", "SyncName", "SalesChannelName", "SalesChannelId", "ReportProgress", "Configurations" ], "properties": { "identifier": { "description": "The Unique Identifier of a Sync", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WorkerSyncKey" }, "syncName": { "type": "string", "description": "the Name of the Sync" }, "salesChannelName": { "type": "string", "description": "The Name of the Sales Channel" }, "salesChannelId": { "type": "string", "description": "The SalesChannel for the Sync" }, "interval": { "type": "string", "description": "The Sync Interval", "format": "duration" }, "reportProgress": { "type": "boolean", "description": "The Sync can Report Progress in Percent" }, "configurations": { "type": "array", "description": "The Configurations", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Config" } } } }, "JTL.Wawi.Rest.Contracts.Models.V1.Worker.WorkerSyncStatus": { "type": "object", "description": "Model Class: WorkerSyncStatus ", "additionalProperties": false, "required": [ "Identifier", "State", "ProgressText" ], "properties": { "identifier": { "description": "The Unique Identifier of a Sync", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WorkerSyncKey" }, "state": { "description": "The current State of Sync", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Worker.SyncState" }, "progressText": { "type": "string", "description": "The text of Progress" }, "progress": { "type": "number", "description": "The Percent of Progress", "format": "double" }, "lastSync": { "type": "string", "description": "The Time of Last Sync", "format": "date-time" }, "nextSync": { "type": "string", "description": "The Time of Next Sync", "format": "date-time" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.AccountingData.AccountingData": { "type": "object", "description": "Model Class: AccountingData ", "additionalProperties": false, "required": [ "DocumentNumber", "DocumentType", "DocumentDate", "ServiceDate", "CurrencyIso", "CompanyId", "CompanyVatId", "SalesChannelId", "IsCancelled", "DepartureCountry", "ShipmentCountry", "BillingAddress", "ShipmentAddress", "AccountDataLineItems" ], "properties": { "documentNumber": { "type": "string", "description": "The number of the document." }, "documentType": { "description": "0 = Sales invoice, 1 = Sales credit, 2 = Sales invoice correction, 3 = Sales invoice cancellation, 4 = Sales credit cancellation, 5 = Sales invoice correction cancellation.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.AccountingData.DocumentType" }, "documentDate": { "type": "string", "description": "The date and time when the document was created.", "format": "date-time" }, "serviceDate": { "type": "string", "description": "The service date of the invoice or the related invoice if the document is an invoice correction.", "format": "date-time" }, "salesInvoiceCorrectionId": { "description": "The identifier of the sales invoice correction or sales credit or the cancellation document.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.GutschriftKey" }, "salesInvoiceId": { "description": "The identifier of the sales invoice.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungKey" }, "salesOrderId": { "description": "The identifier of the sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "salesOrderNumber": { "type": "string", "description": "The internal number of the sales order." }, "externalSalesOrderNumber": { "type": "string", "description": "The external number of the sales order." }, "currencyIso": { "type": "string", "description": "ISO code of the currency of the departure country." }, "companyId": { "description": "The identifier of the company.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "companyVatId": { "type": "string", "description": "The VAT Id of the Company" }, "customerVatId": { "type": "string", "description": "The VAT ID of the customer, if applicable." }, "salesChannelId": { "type": "string", "description": "Identifier for the sales channel through which the order was placed." }, "isCancelled": { "type": "boolean", "description": "Indicates if the document has been cancelled." }, "departureCountry": { "description": "The Departure country information of the document. If none is indicated, it will be determined from the company's information.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.Country" }, "shipmentCountry": { "description": "ISO code of the destination country.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.Country" }, "billingAddress": { "description": "Address to which the invoice is billed.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address" }, "shipmentAddress": { "description": "Address where the goods are shipped.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Address" }, "accountDataLineItems": { "type": "array", "description": "Detailed list of items included in the document.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.AccountingData.AccountingDataLineItem" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.AccountingData.AccountingDataLineItem": { "type": "object", "description": "Model Class: AccountingDataLineItem ", "additionalProperties": false, "required": [ "LineItemType", "Name", "TaxClassType", "Quantity", "NetSalesPricePerUnit", "VatRate", "VatAmount", "DiscountInPercent", "TotalDiscountGrossAmount", "TotalDiscountNetAmount", "TotalGrossAmount", "TotalNetAmount", "SortOrder" ], "properties": { "salesInvoiceCorrectionLineItemId": { "description": "The identifier of the sales invoice correction line item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.GutschriftPosKey" }, "salesInvoiceLineItemId": { "description": "The identifier of the sales invoice line item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungPositionKey" }, "itemId": { "description": "The identifier of the item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "lineItemType": { "description": "The type of line item.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.LineItemType" }, "name": { "type": "string", "description": "The description of the line item." }, "taxClassId": { "description": "The identifier of the tax class.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey" }, "taxClassName": { "type": "string", "description": "The name of the tax class." }, "taxClassType": { "description": "The type of the tax class.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.AccountingData.TaxClassType" }, "generalLedgerAccount": { "type": "string", "description": "An account or record used to sort, store and summarize a company's transactions." }, "quantity": { "type": "number", "description": "The number of items.", "format": "decimal" }, "netSalesPricePerUnit": { "type": "number", "description": "The net sales price per unit of this line item.", "format": "decimal" }, "vatRate": { "type": "number", "description": "Applicable VAT rate in percent.", "format": "decimal" }, "vatAmount": { "type": "number", "description": "Total VAT charged for this item.", "format": "decimal" }, "discountInPercent": { "type": "number", "description": "Discount in percent for this line item.", "format": "decimal" }, "totalDiscountGrossAmount": { "type": "number", "description": "Total discount amount including VAT.", "format": "decimal" }, "totalDiscountNetAmount": { "type": "number", "description": "Total discount amount excluding VAT.", "format": "decimal" }, "totalGrossAmount": { "type": "number", "description": "Total item price including VAT.", "format": "decimal" }, "totalNetAmount": { "type": "number", "description": "Total item price excluding VAT.", "format": "decimal" }, "sortOrder": { "type": "integer", "description": "The order in which the line item appears in the document.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.AccountingData.DocumentType": { "type": "integer", "description": "0 = SalesInvoice, 1 = SalesCredit, 2 = SalesInvoiceCorrection, 3 = SalesInvoiceCancellation, 4 = SalesCreditCancellation, 5 = SalesInvoiceCorrectionCancellation, 6 = SalesLiquidation, 7 = SalesLiquidationCancellation", "format": "int32", "x-enumNames": [ "SalesInvoice", "SalesCredit", "SalesInvoiceCorrection", "SalesInvoiceCancellation", "SalesCreditCancellation", "SalesInvoiceCorrectionCancellation", "SalesLiquidation", "SalesLiquidationCancellation" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ] }, "JTL.Wawi.Rest.Contracts.Models.V2.AccountingData.TaxClassType": { "type": "integer", "description": "0 = None, 1 = SuperReducedTaxRate, 2 = ReducedTaxRateLow, 3 = ReducedTaxRate, 4 = StandardTaxRate, 5 = IntermediaryRate", "format": "int32", "x-enumNames": [ "None", "SuperReducedTaxRate", "ReducedTaxRateLow", "ReducedTaxRate", "StandardTaxRate", "IntermediaryRate" ], "enum": [ 0, 1, 2, 3, 4, 5 ] }, "JTL.Wawi.Rest.Contracts.Models.V2.Attributes.Attribute": { "type": "object", "description": "Model Class: Attribute ", "additionalProperties": false, "required": [ "Id", "AttributeId", "GroupName", "Description", "Names", "PossibleValues", "ActiveSalesChannels", "SortNumber", "RelationType", "FieldType" ], "properties": { "id": { "description": "Unique ID to identify an attribute.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AttributKey" }, "attributeId": { "type": "string", "description": "Unique ID to identify an attribute. Setting this field will make the attribute a functional attribute." }, "groupName": { "type": "string", "description": "The Name of the group to which the attribute belongs." }, "description": { "type": "string", "description": "Internal attribute description." }, "names": { "description": "Attribute names for a given language.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.AttributeNames" }, "possibleValues": { "description": "Attribute value lists for a given language.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.AttributePossibleValues" }, "activeSalesChannels": { "type": "array", "description": "Shops in which the attribute will be available.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" } }, "sortNumber": { "type": "integer", "description": "The attribute sort number used in some sales channels for arranging the attributes.", "format": "int32" }, "relationType": { "description": "Determines to which kind of object the attribute can assigend.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.AttributeRelationType" }, "fieldType": { "description": "Determines the data type of the attribute.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.AttributeFieldType" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Attributes.AttributeFieldType": { "type": "integer", "description": "0 = None, 1 = Integer, 2 = Decimal, 3 = Text, 4 = Checkbox, 5 = List, 6 = Url, 7 = Email, 8 = PhoneNumber, 9 = CountryIso, 10 = Price, 11 = Date, 12 = ShortText", "format": "int32", "x-enumNames": [ "None", "Integer", "Decimal", "Text", "Checkbox", "List", "Url", "Email", "PhoneNumber", "CountryIso", "Price", "Date", "ShortText" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] }, "JTL.Wawi.Rest.Contracts.Models.V2.Attributes.AttributeNames": { "type": "object", "description": "Model Class: AttributeNames ", "additionalProperties": false, "required": [ "Names" ], "properties": { "names": { "type": "array", "description": "Attribute names in different languages.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Translation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Attributes.AttributePossibleValues": { "type": "object", "description": "Model Class: AttributePossibleValues ", "additionalProperties": false, "required": [ "PossibleValues" ], "properties": { "possibleValues": { "type": "array", "description": "Attribute values in the specified language", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.PossibleValueTranslation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Attributes.AttributeRelationType": { "type": "integer", "description": "0 = Product, 1 = Category", "format": "int32", "x-enumNames": [ "Product", "Category" ], "enum": [ 0, 1 ] }, "JTL.Wawi.Rest.Contracts.Models.V2.Attributes.CreateAttribute": { "type": "object", "description": "Model Class: CreateAttribute ", "additionalProperties": false, "required": [ "GroupName", "Names", "RelationType", "FieldType" ], "properties": { "attributeId": { "type": "string", "description": "Unique ID to identify an attribute. Setting this field will make the attribute a functional attribute." }, "groupName": { "type": "string", "description": "The Name of the group to which the attribute belongs." }, "description": { "type": "string", "description": "Internal attribute description." }, "names": { "description": "Attribute names for a given language.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.CreateAttributeNames" }, "possibleValues": { "description": "Attribute value lists for a given language.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.CreateAttributePossibleValues" }, "activeSalesChannels": { "type": "array", "description": "Shops in which the attribute will be available.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" } }, "sortNumber": { "type": "integer", "description": "The attribute sort number used in some sales channels for arranging the attributes.", "format": "int32" }, "relationType": { "description": "Determines to which kind of object the attribute can assigend.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.AttributeRelationType" }, "fieldType": { "description": "Determines the data type of the attribute.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.AttributeFieldType" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Attributes.CreateAttributeNames": { "type": "object", "description": "Model Class: CreateAttributeNames ", "additionalProperties": false, "required": [ "Names" ], "properties": { "names": { "type": "array", "description": "Attribute names in different languages.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateTranslation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Attributes.CreateAttributePossibleValues": { "type": "object", "description": "Model Class: CreateAttributePossibleValues ", "additionalProperties": false, "required": [ "PossibleValues" ], "properties": { "possibleValues": { "type": "array", "description": "Attribute values in the specified language", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.CreatePossibleValueTranslation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Attributes.CreateFunctionAttribute": { "type": "object", "description": "Model Class: CreateFunctionAttribute ", "additionalProperties": false, "required": [ "AttributeId", "GroupName", "Name", "RelationType", "FieldType" ], "properties": { "attributeId": { "type": "string", "description": "Unique ID to identify an attribute. Setting this field will make the attribute a functional attribute." }, "groupName": { "type": "string", "description": "The Name of the group to which the attribute belongs." }, "description": { "type": "string", "description": "Internal attribute description." }, "name": { "type": "string", "description": "Attribute name." }, "possibleValues": { "type": "array", "description": "Attribute value list.", "items": { "type": "string" } }, "activeSalesChannels": { "type": "array", "description": "Shops in which the attribute will be available.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" } }, "sortNumber": { "type": "integer", "description": "The attribute sort number used in some sales channels for arranging the attributes.", "format": "int32" }, "relationType": { "description": "Determines to which kind of object the attribute can assigend.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.AttributeRelationType" }, "fieldType": { "description": "Determines the data type of the attribute.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.AttributeFieldType" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Attributes.CreatePossibleValueTranslation": { "type": "object", "description": "Model Class: CreatePossibleValueTranslation ", "additionalProperties": false, "required": [ "LanguageIso", "PossibleValues" ], "properties": { "languageIso": { "type": "string", "description": "The language ISO code" }, "possibleValues": { "type": "array", "description": "The list of possible values in the corresponding language", "items": { "type": "string" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Attributes.FunctionAttribute": { "type": "object", "description": "Model Class: FunctionAttribute ", "additionalProperties": false, "required": [ "Id", "AttributeId", "GroupName", "Description", "Name", "PossibleValues", "ActiveSalesChannels", "SortNumber", "RelationType", "FieldType" ], "properties": { "id": { "description": "Unique ID to identify an attribute.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AttributKey" }, "attributeId": { "type": "string", "description": "Unique ID to identify an attribute. Setting this field will make the attribute a functional attribute." }, "groupName": { "type": "string", "description": "The Name of the group to which the attribute belongs." }, "description": { "type": "string", "description": "Internal attribute description." }, "name": { "type": "string", "description": "Attribute name." }, "possibleValues": { "type": "array", "description": "Attribute value list.", "items": { "type": "string" } }, "activeSalesChannels": { "type": "array", "description": "Shops in which the attribute will be available.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" } }, "sortNumber": { "type": "integer", "description": "The attribute sort number used in some sales channels for arranging the attributes.", "format": "int32" }, "relationType": { "description": "Determines to which kind of object the attribute can assigend.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.AttributeRelationType" }, "fieldType": { "description": "Determines the data type of the attribute.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.AttributeFieldType" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Attributes.PossibleValueTranslation": { "type": "object", "description": "Model Class: PossibleValueTranslation ", "additionalProperties": false, "required": [ "LanguageIso", "PossibleValues" ], "properties": { "languageIso": { "type": "string", "description": "The language ISO code" }, "possibleValues": { "type": "array", "description": "The list of possible values in the corresponding language", "items": { "type": "string" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Attributes.UpdateAttribute": { "type": "object", "description": "Model Class: UpdateAttribute ", "additionalProperties": false, "properties": { "attributeId": { "type": "string", "description": "Unique ID to identify an attribute. Setting this field will make the attribute a functional attribute." }, "groupName": { "type": "string", "description": "The Name of the group to which the attribute belongs." }, "description": { "type": "string", "description": "Internal attribute description." }, "names": { "description": "Attribute names for a given language.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.UpdateAttributeNames" }, "possibleValues": { "description": "Attribute value lists for a given language.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.UpdateAttributePossibleValues" }, "activeSalesChannels": { "type": "array", "description": "Shops in which the attribute will be available.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" } }, "sortNumber": { "type": "integer", "description": "The attribute sort number used in some sales channels for arranging the attributes.", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Attributes.UpdateAttributeNames": { "type": "object", "description": "Model Class: UpdateAttributeNames ", "additionalProperties": false, "required": [ "Names" ], "properties": { "names": { "type": "array", "description": "Attribute names in different languages.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateTranslation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Attributes.UpdateAttributePossibleValues": { "type": "object", "description": "Model Class: UpdateAttributePossibleValues ", "additionalProperties": false, "required": [ "PossibleValues" ], "properties": { "possibleValues": { "type": "array", "description": "Attribute values in the specified language", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Attributes.UpdatePossibleValueTranslation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Attributes.UpdatePossibleValueTranslation": { "type": "object", "description": "Model Class: UpdatePossibleValueTranslation ", "additionalProperties": false, "required": [ "LanguageIso", "PossibleValues" ], "properties": { "languageIso": { "type": "string", "description": "The language ISO code" }, "possibleValues": { "type": "array", "description": "The list of possible values in the corresponding language", "items": { "type": "string" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.Category": { "type": "object", "description": "Model Class: Category ", "additionalProperties": false, "required": [ "Id", "ParentCategoryId", "SortNumber", "Descriptions", "Attributes", "CustomFields", "Discounts", "HiddenForCustomerGroups", "Shops" ], "properties": { "id": { "description": "Unique ID to identify a category. Test", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey" }, "parentCategoryId": { "description": "ID of the parent category, if the category is a child category.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey" }, "sortNumber": { "type": "integer", "description": "The category sort number used in some sales channels for arranging the categories.", "format": "int32" }, "descriptions": { "description": "Category descriptions for language and saleschannel.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryDescriptions" }, "attributes": { "description": "Attribute values of the category", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryAttributes" }, "customFields": { "description": "Custom field values of the category", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryCustomFields" }, "discounts": { "description": "Discounts of the category", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryDiscounts" }, "hiddenForCustomerGroups": { "description": "Visibilities of the category", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryHiddenForCustomerGroups" }, "shops": { "description": "Shops of the category", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryShops" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryAttributes": { "type": "object", "description": "Model Class: CategoryAttributes ", "additionalProperties": false, "required": [ "Values" ], "properties": { "values": { "type": "array", "description": "Attribute values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.AttributeValues" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryCustomFields": { "type": "object", "description": "Model Class: CategoryCustomFields ", "additionalProperties": false, "required": [ "Values" ], "properties": { "values": { "type": "array", "description": "Custom field values", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryCustomFieldValue" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryCustomFieldValue": { "type": "object", "description": "Model Class: CategoryCustomFieldValue ", "additionalProperties": false, "required": [ "CustomFieldId", "Value" ], "properties": { "customFieldId": { "description": "Identifies the Custom Field", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AttributKey" }, "value": { "type": "string", "description": "Value of this Custom Field as string. Please consider the Custom Field Type for correct formatting." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryDescriptions": { "type": "object", "description": "Model Class: CategoryDescriptions ", "additionalProperties": false, "required": [ "DefaultDescriptions", "SalesChannelDescriptions" ], "properties": { "defaultDescriptions": { "type": "array", "description": "Description values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.PlatformDescription" } }, "salesChannelDescriptions": { "type": "array", "description": "Description values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.SalesChannelDescription" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryDiscount": { "type": "object", "description": "Model Class: CategoryDiscount ", "additionalProperties": false, "required": [ "ShopId", "CustomerGroupId", "Discount" ], "properties": { "shopId": { "description": "The Shop ID of the discount. Only specific shops are allowed for this operation and are specified in the saleschannels endpoint(GET).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" }, "customerGroupId": { "description": "The Customer group ID of the discount. Only specific shops are allowed for this operation and are specified in the saleschannels endpoint(GET).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "discount": { "type": "number", "description": "The discount", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryDiscounts": { "type": "object", "description": "Model Class: CategoryDiscounts ", "additionalProperties": false, "required": [ "Values" ], "properties": { "values": { "type": "array", "description": "Discount values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryDiscount" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryHiddenForCustomerGroup": { "type": "object", "description": "Model Class: CategoryHiddenForCustomerGroup ", "additionalProperties": false, "required": [ "ShopId", "CustomerGroupId" ], "properties": { "shopId": { "description": "The Shop ID of the visibility. Only specific shops are allowed for this operation and are specified in the saleschannels endpoint(GET).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" }, "customerGroupId": { "description": "The Customer group ID of the visibility. Only specific shops are allowed for this operation and are specified in the saleschannels endpoint(GET).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryHiddenForCustomerGroups": { "type": "object", "description": "Model Class: CategoryHiddenForCustomerGroups ", "additionalProperties": false, "required": [ "Values" ], "properties": { "values": { "type": "array", "description": "Visibility values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryHiddenForCustomerGroup" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryShop": { "type": "object", "description": "Model Class: CategoryShop ", "additionalProperties": false, "required": [ "ShopId" ], "properties": { "shopId": { "description": "The Shop ID. Only specific shops are allowed for this operation and are specified in the saleschannels endpoint(GET).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryShops": { "type": "object", "description": "Model Class: CategoryShops ", "additionalProperties": false, "required": [ "Values" ], "properties": { "values": { "type": "array", "description": "Shop values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CategoryShop" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategory": { "type": "object", "description": "Model Class: CreateCategory ", "additionalProperties": false, "properties": { "parentCategoryId": { "description": "ID of the parent category, if the category is a child category.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey" }, "sortNumber": { "type": "integer", "description": "The category sort number used in some sales channels for arranging the categories.", "format": "int32" }, "descriptions": { "description": "Category descriptions for language and saleschannel.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryDescriptions" }, "attributes": { "description": "Attribute values of the category", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryAttributes" }, "customFields": { "description": "Custom field values of the category", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryCustomFields" }, "discounts": { "description": "Discounts of the category", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryDiscounts" }, "hiddenForCustomerGroups": { "description": "Visibilities of the category", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryHiddenForCustomerGroups" }, "shops": { "description": "Shops of the category", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryShops" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryAttributes": { "type": "object", "description": "Model Class: CreateCategoryAttributes ", "additionalProperties": false, "required": [ "Values" ], "properties": { "values": { "type": "array", "description": "Attribute values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.CreateAttributeValues" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryCustomFields": { "type": "object", "description": "Model Class: CreateCategoryCustomFields ", "additionalProperties": false, "required": [ "Values" ], "properties": { "values": { "type": "array", "description": "Custom field values", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryCustomFieldValue" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryCustomFieldValue": { "type": "object", "description": "Model Class: CreateCategoryCustomFieldValue ", "additionalProperties": false, "required": [ "CustomFieldId" ], "properties": { "customFieldId": { "description": "Identifies the Custom Field", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AttributKey" }, "value": { "type": "string", "description": "Value of this Custom Field as string. Please consider the Custom Field Type for correct formatting." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryDescriptions": { "type": "object", "description": "Model Class: CreateCategoryDescriptions ", "additionalProperties": false, "required": [ "DefaultDescriptions" ], "properties": { "defaultDescriptions": { "type": "array", "description": "Description values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.CreatePlatformDescription" } }, "salesChannelDescriptions": { "type": "array", "description": "Description values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.CreateSalesChannelDescription" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryDiscount": { "type": "object", "description": "Model Class: CreateCategoryDiscount ", "additionalProperties": false, "required": [ "ShopId", "CustomerGroupId", "Discount" ], "properties": { "shopId": { "description": "The Shop ID of the discount. Only specific shops are allowed for this operation and are specified in the saleschannels endpoint(GET).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" }, "customerGroupId": { "description": "The Customer group ID of the discount. Only specific shops are allowed for this operation and are specified in the saleschannels endpoint(GET).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "discount": { "type": "number", "description": "The discount", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryDiscounts": { "type": "object", "description": "Model Class: CreateCategoryDiscounts ", "additionalProperties": false, "required": [ "Values" ], "properties": { "values": { "type": "array", "description": "Discount values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryDiscount" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryHiddenForCustomerGroup": { "type": "object", "description": "Model Class: CreateCategoryHiddenForCustomerGroup ", "additionalProperties": false, "required": [ "ShopId", "CustomerGroupId" ], "properties": { "shopId": { "description": "The Shop ID of the visibility. Only specific shops are allowed for this operation and are specified in the saleschannels endpoint(GET).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" }, "customerGroupId": { "description": "The Customer group ID of the visibility. Only specific shops are allowed for this operation and are specified in the saleschannels endpoint(GET).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryHiddenForCustomerGroups": { "type": "object", "description": "Model Class: CreateCategoryHiddenForCustomerGroups ", "additionalProperties": false, "required": [ "Values" ], "properties": { "values": { "type": "array", "description": "Visibility values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryHiddenForCustomerGroup" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryShop": { "type": "object", "description": "Model Class: CreateCategoryShop ", "additionalProperties": false, "required": [ "ShopId" ], "properties": { "shopId": { "description": "The Shop ID. Only specific shops are allowed for this operation and are specified in the saleschannels endpoint(GET).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryShops": { "type": "object", "description": "Model Class: CreateCategoryShops ", "additionalProperties": false, "required": [ "Values" ], "properties": { "values": { "type": "array", "description": "Shop values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.CreateCategoryShop" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.DeleteCategoryDeleteParameters": { "type": "object", "description": "Model Class: DeleteCategoryDeleteParameters ", "additionalProperties": false, "properties": { "childCategoryDestination": { "description": "The Id of the category the child categories of the deletedd category will be moved to. If this is left empty the child categories will be removed.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategory": { "type": "object", "description": "Model Class: UpdateCategory ", "additionalProperties": false, "properties": { "parentCategoryId": { "description": "ID of the parent category, if the category is a child category.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey" }, "sortNumber": { "type": "integer", "description": "The category sort number used in some sales channels for arranging the categories.", "format": "int32" }, "descriptions": { "description": "Category descriptions for language and saleschannel.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryDescriptions" }, "attributes": { "description": "Attribute values of the category", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryAttributes" }, "customFields": { "description": "Custom field values of the category", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryCustomFields" }, "discounts": { "description": "Discounts of the category", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryDiscounts" }, "hiddenForCustomerGroups": { "description": "Visibilities of the category", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryHiddenForCustomerGroups" }, "shops": { "description": "Shops of the category", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryShops" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryAttributes": { "type": "object", "description": "Model Class: UpdateCategoryAttributes ", "additionalProperties": false, "required": [ "Values" ], "properties": { "values": { "type": "array", "description": "Attribute values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdateAttributeValues" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryCustomFields": { "type": "object", "description": "Model Class: UpdateCategoryCustomFields ", "additionalProperties": false, "required": [ "Values" ], "properties": { "values": { "type": "array", "description": "Custom field values", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryCustomFieldValue" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryCustomFieldValue": { "type": "object", "description": "Model Class: UpdateCategoryCustomFieldValue ", "additionalProperties": false, "required": [ "CustomFieldId" ], "properties": { "customFieldId": { "description": "Identifies the Custom Field", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AttributKey" }, "value": { "type": "string", "description": "Value of this Custom Field as string. Please consider the Custom Field Type for correct formatting." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryDescriptions": { "type": "object", "description": "Model Class: UpdateCategoryDescriptions ", "additionalProperties": false, "properties": { "defaultDescriptions": { "type": "array", "description": "Description values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdatePlatformDescription" } }, "salesChannelDescriptions": { "type": "array", "description": "Description values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdateSalesChannelDescription" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryDiscount": { "type": "object", "description": "Model Class: UpdateCategoryDiscount ", "additionalProperties": false, "required": [ "ShopId", "CustomerGroupId", "Discount" ], "properties": { "shopId": { "description": "The Shop ID of the discount. Only specific shops are allowed for this operation and are specified in the saleschannels endpoint(GET).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" }, "customerGroupId": { "description": "The Customer group ID of the discount. Only specific shops are allowed for this operation and are specified in the saleschannels endpoint(GET).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "discount": { "type": "number", "description": "The discount", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryDiscounts": { "type": "object", "description": "Model Class: UpdateCategoryDiscounts ", "additionalProperties": false, "required": [ "Values" ], "properties": { "values": { "type": "array", "description": "Discount values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryDiscount" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryHiddenForCustomerGroup": { "type": "object", "description": "Model Class: UpdateCategoryHiddenForCustomerGroup ", "additionalProperties": false, "required": [ "ShopId", "CustomerGroupId" ], "properties": { "shopId": { "description": "The Shop ID of the visibility. Only specific shops are allowed for this operation and are specified in the saleschannels endpoint(GET).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" }, "customerGroupId": { "description": "The Customer group ID of the visibility. Only specific shops are allowed for this operation and are specified in the saleschannels endpoint(GET).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryHiddenForCustomerGroups": { "type": "object", "description": "Model Class: UpdateCategoryHiddenForCustomerGroups ", "additionalProperties": false, "required": [ "Values" ], "properties": { "values": { "type": "array", "description": "Visibility values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryHiddenForCustomerGroup" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryShop": { "type": "object", "description": "Model Class: UpdateCategoryShop ", "additionalProperties": false, "required": [ "ShopId" ], "properties": { "shopId": { "description": "The Shop ID. Only specific shops are allowed for this operation and are specified in the saleschannels endpoint(GET).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryShops": { "type": "object", "description": "Model Class: UpdateCategoryShops ", "additionalProperties": false, "required": [ "Values" ], "properties": { "values": { "type": "array", "description": "Shop values of the category", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Category.UpdateCategoryShop" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.AttributeSalesChannelValues": { "type": "object", "description": "Model Class: AttributeSalesChannelValues ", "additionalProperties": false, "required": [ "SalesChannelId", "Values" ], "properties": { "salesChannelId": { "type": "string", "description": "Identifies the saleschannel for this attributevalue" }, "values": { "type": "array", "description": "Identifies the saleschannel for this attributevalue", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.AttributeValue" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.AttributeValue": { "type": "object", "description": "Model Class: AttributeValue ", "additionalProperties": false, "required": [ "LanguageId", "Value" ], "properties": { "languageId": { "type": "string", "description": "ISO3 of the language" }, "value": { "type": "string", "description": "Value of this attribute as string. Please consider the Attribute Type for correct formatting." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.AttributeValues": { "type": "object", "description": "Model Class: AttributeValues ", "additionalProperties": false, "required": [ "AttributeId", "DefaultValues", "SalesChannelValues" ], "properties": { "attributeId": { "description": "Identifies the attribute", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AttributKey" }, "defaultValues": { "type": "array", "description": "Defines the default values for the attribute and item in different languages.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.AttributeValue" } }, "salesChannelValues": { "type": "array", "description": "Contains all values for saleschannels for this attribute and item", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.AttributeSalesChannelValues" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.CreateAttributeSalesChannelValues": { "type": "object", "description": "Model Class: CreateAttributeSalesChannelValues ", "additionalProperties": false, "properties": { "salesChannelId": { "type": "string", "description": "Identifies the saleschannel for this attributevalue" }, "values": { "type": "array", "description": "Identifies the saleschannel for this attributevalue", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.CreateAttributeValue" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.CreateAttributeValue": { "type": "object", "description": "Model Class: CreateAttributeValue ", "additionalProperties": false, "properties": { "languageId": { "type": "string", "description": "ISO3 of the language" }, "value": { "type": "string", "description": "Value of this attribute as string. Please consider the Attribute Type for correct formatting." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.CreateAttributeValues": { "type": "object", "description": "Model Class: CreateAttributeValues ", "additionalProperties": false, "properties": { "attributeId": { "description": "Identifies the attribute", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AttributKey" }, "defaultValues": { "type": "array", "description": "Defines the default values for the attribute and item in different languages.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.CreateAttributeValue" } }, "salesChannelValues": { "type": "array", "description": "Contains all values for saleschannels for this attribute and item", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.CreateAttributeSalesChannelValues" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.CreateDescriptionData": { "type": "object", "description": "Model Class: CreateDescriptionData ", "additionalProperties": false, "properties": { "itemName": { "type": "string", "description": "The name of the item." }, "shortDescription": { "type": "string", "description": "Short description of the item." }, "description": { "type": "string", "description": "Detailed description of the item." }, "metaDescription": { "type": "string", "description": "Meta description for SEO." }, "metaKeywords": { "type": "string", "description": "Meta keywords for SEO." }, "titleTag": { "type": "string", "description": "Tags for the title." }, "urlPath": { "type": "string", "description": "URL path for the item." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.CreatePaymentRequest": { "type": "object", "description": "Model Class: CreatePaymentRequest ", "additionalProperties": false, "required": [ "Amount", "PaymentDate", "PaymentMethodId" ], "properties": { "amount": { "type": "number", "description": "Payment amount", "format": "decimal" }, "paymentDate": { "type": "string", "description": "Date when the payment was made", "format": "date-time" }, "paymentMethodId": { "description": "Payment method identifier", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "distribute": { "type": "boolean", "description": "Whether to distribute the payment to associated orders" }, "comment": { "type": "string", "description": "Optional comment for the payment" }, "sendMail": { "type": "boolean", "description": "Whether to send a confirmation email after payment processing" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.CreatePlatformDescription": { "type": "object", "description": "Model Class: CreatePlatformDescription ", "additionalProperties": false, "properties": { "platformId": { "description": "Id of the platform", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PlattformKey" }, "languageId": { "type": "string", "description": "ISO3 Id of the language" }, "descriptionData": { "description": "Contains the Description Data", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.CreateDescriptionData" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.CreateSalesChannelDescription": { "type": "object", "description": "Model Class: CreateSalesChannelDescription ", "additionalProperties": false, "properties": { "salesChannelId": { "type": "string", "description": "Id of the SalesChannel" }, "languageId": { "type": "string", "description": "ISO3 Id of the language" }, "descriptionData": { "description": "Contains the Description Data", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.CreateDescriptionData" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.DescriptionData": { "type": "object", "description": "Model Class: DescriptionData ", "additionalProperties": false, "required": [ "ItemName", "ShortDescription", "Description", "MetaDescription", "MetaKeywords", "TitleTag", "UrlPath" ], "properties": { "itemName": { "type": "string", "description": "The name of the item." }, "shortDescription": { "type": "string", "description": "Short description of the item." }, "description": { "type": "string", "description": "Detailed description of the item." }, "metaDescription": { "type": "string", "description": "Meta description for SEO." }, "metaKeywords": { "type": "string", "description": "Meta keywords for SEO." }, "titleTag": { "type": "string", "description": "Tags for the title." }, "urlPath": { "type": "string", "description": "URL path for the item." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.Payment": { "type": "object", "description": "Model Class: Payment ", "additionalProperties": false, "required": [ "Id", "Amount", "AssignmentInfo", "AssignmentRating", "AssignmentType", "Date", "ExternalTransactionId", "IsAdvancePayment", "ManualSKR", "Name", "NoExport", "Note", "PaymentType", "SalesInvoiceCorrectionId", "SalesInvoiceId", "PaymentMethodId", "SalesOrderId", "UserId" ], "properties": { "id": { "description": "Unique ID to identify a payment", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungKey" }, "amount": { "type": "number", "description": "The Payment Amount", "format": "decimal" }, "assignmentInfo": { "type": "string", "description": "The Payment AssignmentInfo" }, "assignmentRating": { "type": "integer", "description": "The Payment AssignmentRating", "format": "int32" }, "assignmentType": { "type": "integer", "description": "The Payment AssignmentType", "format": "int32" }, "date": { "type": "string", "description": "The Payment Date", "format": "date-time" }, "externalTransactionId": { "type": "string", "description": "The Payment ExternalTransactionId" }, "isAdvancePayment": { "type": "boolean", "description": "The Payment IsAdvancePayment" }, "manualSKR": { "type": "string", "description": "The Payment ManualSKR" }, "name": { "type": "string", "description": "The Payment Name" }, "noExport": { "type": "integer", "description": "The Payment NoExport", "format": "int32" }, "note": { "type": "string", "description": "The Payment Note" }, "paymentType": { "type": "integer", "description": "The Payment PaymentType", "format": "int32" }, "salesInvoiceCorrectionId": { "description": "The Id of the sales invoice correction", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.GutschriftKey" }, "salesInvoiceId": { "description": "The Id of the sales invoice associated with the payment", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungKey" }, "paymentMethodId": { "description": "The Payment PaymentMethodId", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "salesOrderId": { "description": "The Id of the sales order associated with the payment", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "userId": { "description": "The id of the user who processed the payment", "$ref": "#/components/schemas/JTL.Identity.Abstractions.BenutzerKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.PlatformDescription": { "type": "object", "description": "Model Class: PlatformDescription ", "additionalProperties": false, "required": [ "PlatformId", "LanguageId", "DescriptionData" ], "properties": { "platformId": { "description": "Id of the platform", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PlattformKey" }, "languageId": { "type": "string", "description": "ISO3 Id of the language" }, "descriptionData": { "description": "Contains the Description Data", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.DescriptionData" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.SalesChannelDescription": { "type": "object", "description": "Model Class: SalesChannelDescription ", "additionalProperties": false, "required": [ "SalesChannelId", "LanguageId", "DescriptionData" ], "properties": { "salesChannelId": { "type": "string", "description": "Id of the SalesChannel" }, "languageId": { "type": "string", "description": "ISO3 Id of the language" }, "descriptionData": { "description": "Contains the Description Data", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.DescriptionData" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdateAttributeSalesChannelValues": { "type": "object", "description": "Model Class: UpdateAttributeSalesChannelValues ", "additionalProperties": false, "required": [ "SalesChannelId", "Values" ], "properties": { "salesChannelId": { "type": "string", "description": "Identifies the saleschannel for this attributevalue" }, "values": { "type": "array", "description": "Identifies the saleschannel for this attributevalue", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdateAttributeValue" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdateAttributeValue": { "type": "object", "description": "Model Class: UpdateAttributeValue ", "additionalProperties": false, "required": [ "LanguageId" ], "properties": { "languageId": { "type": "string", "description": "ISO3 of the language" }, "value": { "type": "string", "description": "Value of this attribute as string. Please consider the Attribute Type for correct formatting." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdateAttributeValues": { "type": "object", "description": "Model Class: UpdateAttributeValues ", "additionalProperties": false, "required": [ "AttributeId" ], "properties": { "attributeId": { "description": "Identifies the attribute", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AttributKey" }, "defaultValues": { "type": "array", "description": "Defines the default values for the attribute and item in different languages.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdateAttributeValue" } }, "salesChannelValues": { "type": "array", "description": "Contains all values for saleschannels for this attribute and item", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdateAttributeSalesChannelValues" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdateDescriptionData": { "type": "object", "description": "Model Class: UpdateDescriptionData ", "additionalProperties": false, "properties": { "itemName": { "type": "string", "description": "The name of the item." }, "shortDescription": { "type": "string", "description": "Short description of the item." }, "description": { "type": "string", "description": "Detailed description of the item." }, "metaDescription": { "type": "string", "description": "Meta description for SEO." }, "metaKeywords": { "type": "string", "description": "Meta keywords for SEO." }, "titleTag": { "type": "string", "description": "Tags for the title." }, "urlPath": { "type": "string", "description": "URL path for the item." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdatePlatformDescription": { "type": "object", "description": "Model Class: UpdatePlatformDescription ", "additionalProperties": false, "required": [ "PlatformId", "LanguageId" ], "properties": { "platformId": { "description": "Id of the platform", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PlattformKey" }, "languageId": { "type": "string", "description": "ISO3 Id of the language", "maxLength": 2147483647 }, "descriptionData": { "description": "Contains the Description Data", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdateDescriptionData" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdateSalesChannelDescription": { "type": "object", "description": "Model Class: UpdateSalesChannelDescription ", "additionalProperties": false, "required": [ "SalesChannelId", "LanguageId" ], "properties": { "salesChannelId": { "type": "string", "description": "Id of the SalesChannel" }, "languageId": { "type": "string", "description": "ISO3 Id of the language", "maxLength": 2147483647 }, "descriptionData": { "description": "Contains the Description Data", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdateDescriptionData" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.CustomField.CreateCustomField": { "type": "object", "description": "Model Class: CreateCustomField ", "additionalProperties": false, "required": [ "Name", "GroupName", "DataType", "DisplayLocation", "ReferenceType" ], "properties": { "name": { "type": "string", "description": "The custom field name." }, "groupName": { "type": "string", "description": "The group name for this custom field." }, "dataType": { "description": "The custom field data type.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.CustomField.CustomFieldDataType" }, "displayLocation": { "description": "Where the field should be displayed (EigeneFelder or specific location).", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.CustomField.DisplayLocationType" }, "referenceType": { "description": "The reference type this field belongs to (Item, Category, Customer, etc.).", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.CustomField.ReferenceType" }, "description": { "type": "string", "description": "Description of the custom field purpose." }, "isRequired": { "type": "boolean", "description": "Whether this field is required." }, "isHidden": { "type": "boolean", "description": "Whether this field should be hidden in the UI." }, "sortOrder": { "type": "integer", "description": "The sort order within the group.", "format": "int32" }, "possibleValues": { "type": "array", "description": "The possible values when the custom field is a list type.", "items": { "type": "string" } }, "productGroups": { "type": "array", "description": "Product groups where this field is visible (only for Item reference type).", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarengruppeKey" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.CustomField.CustomField": { "type": "object", "description": "Model Class: CustomField ", "additionalProperties": false, "required": [ "CustomFieldId", "Name", "GroupName", "DataType", "DisplayLocation", "ReferenceType", "Description", "IsRequired", "IsHidden", "SortOrder", "PossibleValues", "ProductGroups" ], "properties": { "customFieldId": { "description": "Unique ID to identify a custom field.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EigenesFeldKey" }, "name": { "type": "string", "description": "The custom field name." }, "groupName": { "type": "string", "description": "The group name for this custom field." }, "dataType": { "description": "The custom field data type.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.CustomField.CustomFieldDataType" }, "displayLocation": { "description": "Where the field should be displayed (EigeneFelder or specific location).", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.CustomField.DisplayLocationType" }, "referenceType": { "description": "The reference type this field belongs to (Item, Category, Customer, etc.).", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.CustomField.ReferenceType" }, "description": { "type": "string", "description": "Description of the custom field purpose." }, "isRequired": { "type": "boolean", "description": "Whether this field is required." }, "isHidden": { "type": "boolean", "description": "Whether this field should be hidden in the UI." }, "sortOrder": { "type": "integer", "description": "The sort order within the group.", "format": "int32" }, "possibleValues": { "type": "array", "description": "The possible values when the custom field is a list type.", "items": { "type": "string" } }, "productGroups": { "type": "array", "description": "Product groups where this field is visible (only for Item reference type).", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarengruppeKey" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.CustomField.CustomFieldDataType": { "type": "integer", "description": "0 = None, 1 = Integer, 2 = Decimal, 3 = Text, 4 = Checkbox, 5 = List, 6 = Url, 7 = Email, 8 = PhoneNumber, 9 = CountryIso, 10 = Price, 11 = Date, 12 = ShortText", "format": "int32", "x-enumNames": [ "None", "Integer", "Decimal", "Text", "Checkbox", "List", "Url", "Email", "PhoneNumber", "CountryIso", "Price", "Date", "ShortText" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] }, "JTL.Wawi.Rest.Contracts.Models.V2.CustomField.CustomFieldGroup": { "type": "object", "description": "Model Class: CustomFieldGroup ", "additionalProperties": false, "required": [ "GroupName", "CustomFields" ], "properties": { "groupName": { "type": "string", "description": "The name of the custom field group." }, "customFields": { "type": "array", "description": "List of custom fields in this group.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.CustomField.CustomField" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.CustomField.DisplayLocationType": { "type": "integer", "description": "0 = CustomFields, 1 = General", "format": "int32", "x-enumNames": [ "CustomFields", "General" ], "enum": [ 0, 1 ] }, "JTL.Wawi.Rest.Contracts.Models.V2.CustomField.ReferenceType": { "type": "integer", "description": "0 = Item, 1 = Category, 2 = Wawi, 3 = Customer, 4 = SalesOrder, 5 = Company, 6 = ProductionOrder, 7 = Operations, 8 = Resource, 9 = ProductionFacility, 10 = ProductionItem, 11 = SalesOrderLineItem", "format": "int32", "x-enumNames": [ "Item", "Category", "Wawi", "Customer", "SalesOrder", "Company", "ProductionOrder", "Operations", "Resource", "ProductionFacility", "ProductionItem", "SalesOrderLineItem" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ] }, "JTL.Wawi.Rest.Contracts.Models.V2.CustomField.UpdateCustomField": { "type": "object", "description": "Model Class: UpdateCustomField ", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The custom field name." }, "groupName": { "type": "string", "description": "The group name for this custom field." }, "displayLocation": { "type": "integer", "description": "Where the field should be displayed (EigeneFelder or specific location).", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.CustomField.DisplayLocationType" }, "description": { "type": "string", "description": "Description of the custom field purpose." }, "isRequired": { "type": "boolean", "description": "Whether this field is required." }, "isHidden": { "type": "boolean", "description": "Whether this field should be hidden in the UI." }, "sortOrder": { "type": "integer", "description": "The sort order within the group.", "format": "int32" }, "possibleValues": { "type": "array", "description": "The possible values when the custom field is a list type.", "items": { "type": "string" } }, "productGroups": { "type": "array", "description": "Product groups where this field is visible (only for Item reference type).", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarengruppeKey" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.BomItem": { "type": "object", "description": "Model Class: BomItem ", "additionalProperties": false, "required": [ "ItemId", "Amount", "Notes", "Position" ], "properties": { "itemId": { "description": "Id of the bomitem", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "amount": { "type": "number", "description": "Amount of the itembom that is needed", "format": "decimal" }, "notes": { "type": "string", "description": "Notes for the itembom" }, "position": { "type": "integer", "description": "Position of this item inside the bom", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.BundleItem": { "type": "object", "description": "Model Class: BundleItem ", "additionalProperties": false, "required": [ "BundleId", "EAN", "Quantity", "UPC", "UnitId" ], "properties": { "bundleId": { "description": "Id of the bundle item", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.GebindeKey" }, "eAN": { "type": "string", "description": "The ItemBundle EAN" }, "quantity": { "type": "number", "description": "The ItemBundle Quantity", "format": "decimal" }, "uPC": { "type": "string", "description": "The ItemBundle UPC" }, "unitId": { "description": "The Unit to measure the bundle with", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EinheitKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ConfigurationGroup": { "type": "object", "description": "Model Class: ConfigurationGroup ", "additionalProperties": false, "required": [ "ConfigurationGroupId" ], "properties": { "configurationGroupId": { "description": "Id of the configurationGroup", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KonfiggruppeKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CopyItemDetailsResponse": { "type": "object", "description": "Model Class: CopyItemDetailsResponse ", "additionalProperties": false, "required": [ "ItemKeys" ], "properties": { "itemKeys": { "type": "array", "description": "The IDs of the duplicated items.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateCopyItemDetails": { "type": "object", "description": "Model Class: CreateCopyItemDetails ", "additionalProperties": false, "required": [ "ItemKey", "ReceivingItemsForDetailCopys" ], "properties": { "executeWorkflows": { "type": "boolean", "description": "Indicates whether workflows should be executed" }, "itemKey": { "description": "The key of the item-details to be copied", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "receivingItemsForDetailCopys": { "description": "Items that will receive the copied details", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateCopyItemDetailsReceivingItems" }, "copyDetailsOptions": { "description": "Regular copy options for the item", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateCopyItemDetailsOptions" }, "copyItemDetailsDescription": { "description": "Options for copying item description", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateCopyItemDetailsDescription" }, "copyItemDetailsSuppliers": { "description": "Options for copying item suppliers", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateCopyItemDetailsSuppliers" }, "copyItemDetailsScx": { "description": "Options for copying item SCX data", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateCopyItemDetailsScx" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateCopyItemDetailsDescription": { "type": "object", "description": "Model Class: CreateCopyItemDetailsDescription ", "additionalProperties": false, "required": [ "LanguageAndOutputWays" ], "properties": { "languageAndOutputWays": { "type": "boolean", "description": "Sprache und Ausgabewege" }, "itemName": { "type": "boolean", "description": "Artikelname" }, "description": { "type": "boolean", "description": "Beschreibung" }, "metadataSeo": { "type": "boolean", "description": "Metadaten/SEO" }, "urlPath": { "type": "boolean", "description": "URL" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateCopyItemDetailsOptions": { "type": "object", "description": "Model Class: CreateCopyItemDetailsOptions ", "additionalProperties": false, "properties": { "manufacturer": { "type": "boolean", "description": "Hersteller" }, "shippingClass": { "type": "boolean", "description": "Versandklasse" }, "taxClass": { "type": "boolean", "description": "Steuerklasse" }, "productGroup": { "type": "boolean", "description": "Warengruppe" }, "basePriceUnit": { "type": "boolean", "description": "Grundpreis/Einheit" }, "purchaseSettings": { "type": "boolean", "description": "Einstellung zur Abnahme" }, "minMaxStock": { "type": "boolean", "description": "Mindest- und Maximalbestaende" }, "dimensionsAndWeight": { "type": "boolean" }, "gTIN": { "type": "boolean", "description": "GTIN" }, "salesPrices": { "type": "boolean", "description": "Verkaufspreise" }, "purchasePriceNet": { "type": "boolean", "description": "Einkaufspreise Netto" }, "deliveryOptions": { "type": "boolean", "description": "Lieferoptionen" }, "oversellingSettings": { "type": "boolean", "description": "Einstellungen zu Ueberverkaeufen" }, "attributes": { "type": "boolean", "description": "Attribute" }, "attributeSettingCopyAction": { "type": "integer", "description": "ArtikelSettingCopyAction specifies whether the elements are to be replaced or appended", "format": "int32" }, "characteristics": { "type": "boolean", "description": "Merkmale" }, "characteristicSettingCopyAction": { "type": "integer", "description": "ArtikelSettingCopyAction specifies whether the elements are to be replaced or appended", "format": "int32" }, "isbn": { "type": "boolean", "description": "ISBN" }, "upc": { "type": "boolean", "description": "UPC" }, "han": { "type": "boolean", "description": "HAN" }, "taricCode": { "type": "boolean", "description": "TARIC-Code" }, "hazardNumber": { "type": "boolean", "description": "Gefahrennummer" }, "ownId": { "type": "boolean", "description": "Eigene Id" }, "unNumber": { "type": "boolean", "description": "UN-Nummer" }, "amazonFsku": { "type": "boolean", "description": "Amazon-FSKU" }, "originCountry": { "type": "boolean", "description": "Herkunftsland" }, "packaging": { "type": "boolean", "description": "Gebinde" }, "crossSellingGroupsAndItems": { "type": "boolean" }, "crossSellingGroupsAndItemsAction": { "type": "integer", "description": "ArtikelSettingCopyAction specifies whether the elements are to be replaced or appended", "format": "int32" }, "discountIgnore": { "type": "boolean", "description": "Rabatte ignorieren" }, "itemType": { "type": "boolean", "description": "Artikeltyp" }, "responsiblePerson": { "type": "boolean", "description": "Verantwortliche Person" }, "remark": { "type": "boolean", "description": "Anmerkung" }, "searchTerms": { "type": "boolean", "description": "Suchbegriffe" }, "priceList": { "type": "boolean", "description": "Preisliste" }, "orderProcess": { "type": "boolean", "description": "Bestellvorgaenge" }, "allSpecialPrices": { "type": "boolean", "description": "Alle Sonderpreise" }, "mediaFiles": { "type": "boolean", "description": "Mediendateien" }, "mediaFilesSettingCopyAction": { "type": "integer", "description": "ArtikelSettingCopyAction specifies whether the elements are to be replaced or appended", "format": "int32" }, "downloadFiles": { "type": "boolean", "description": "Download-Dateien" }, "downloadFilesSettingCopyAction": { "type": "integer", "description": "ArtikelSettingCopyAction specifies whether the elements are to be replaced or appended", "format": "int32" }, "uploadFiles": { "type": "boolean", "description": "Upload-Dateien" }, "uploadFilesSettingCopyAction": { "type": "integer", "description": "ArtikelSettingCopyAction specifies whether the elements are to be replaced or appended", "format": "int32" }, "allOwnFields": { "type": "boolean", "description": "Alle eigenen Felder" }, "allOwnFieldsSettingCopyAction": { "type": "integer", "description": "ArtikelSettingCopyAction specifies whether the elements are to be replaced or appended", "format": "int32" }, "picturesAllPlattforms": { "type": "boolean", "description": "Bilder (alle Plattformen)" }, "pictureSettingCopyAction": { "type": "integer", "description": "ArtikelSettingCopyAction specifies whether the elements are to be replaced or appended", "format": "int32" }, "variations": { "type": "boolean", "description": "Variationen" }, "partsList": { "type": "boolean", "description": "Stuecklistenkomponenten" }, "configurator": { "type": "boolean", "description": "Konfigurationsgruppen" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateCopyItemDetailsReceivingItems": { "type": "object", "description": "Model Class: CreateCopyItemDetailsReceivingItems ", "additionalProperties": false, "required": [ "ItemKeys" ], "properties": { "itemKeys": { "type": "array", "description": "List of item keys that will receive the copied details", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateCopyItemDetailsScx": { "type": "object", "description": "Model Class: CreateCopyItemDetailsScx ", "additionalProperties": false, "required": [ "SalesChannelCategories" ], "properties": { "salesChannelCategories": { "type": "boolean", "description": "Verkaufskanal-Kategorien" }, "salesChannelFieldValues": { "type": "boolean", "description": "Verkaufskanal-Feldwerte" }, "shopsToConsider": { "type": "array", "description": "Shops die berücksichtigt werden sollen", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateCopyItemDetailsSuppliers": { "type": "object", "description": "Model Class: CreateCopyItemDetailsSuppliers ", "additionalProperties": false, "required": [ "AssignedSuppliers" ], "properties": { "assignedSuppliers": { "type": "boolean", "description": "Zugewiesene Lieferanten" }, "artikelSettingCopyAction": { "type": "integer", "description": "ArtikelSettingCopyAction specifies whether the elements are to be replaced or appended", "format": "int32" }, "itemNameOfSupplier": { "type": "boolean", "description": "Artikelname des Lieferanten" }, "itemNumberOfSupplier": { "type": "boolean", "description": "Artikelnummer des Lieferanten" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateDataDuplicateOptions": { "type": "object", "description": "Model Class: CreateDataDuplicateOptions ", "additionalProperties": false, "required": [ "IsActive" ], "properties": { "isActive": { "type": "boolean", "description": "IsActive indicates whether these options are used" }, "considerManufacturer": { "type": "boolean", "description": "Consider copying manufacturer information" }, "considerMinimumPurchaseSettings": { "type": "boolean", "description": "Consider copying minimum purchase settings" }, "considerItemType": { "type": "boolean", "description": "Consider copying item type" }, "considerInventoryManagement": { "type": "boolean", "description": "Consider copying inventory management settings" }, "considerPackaging": { "type": "boolean", "description": "Consider copying packaging information" }, "considerBasePriceUnit": { "type": "boolean", "description": "Consider copying base price unit" }, "considerMinMaxInventory": { "type": "boolean", "description": "Consider copying minimum/maximum inventory levels" }, "considerNonDiscountable": { "type": "boolean", "description": "Consider copying non-discountable flag" }, "considerProductCompliancePerson": { "type": "boolean", "description": "Consider copying product compliance person" }, "considerTaxClass": { "type": "boolean", "description": "Consider copying tax class" }, "considerShippingClass": { "type": "boolean", "description": "Consider copying shipping class" }, "considerProductGroup": { "type": "boolean", "description": "Consider copying product group" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateDuplicateItem": { "type": "object", "description": "Model Class: CreateDuplicateItem ", "additionalProperties": false, "required": [ "ExecuteWorkflows", "ItemKey", "NewItems" ], "properties": { "executeWorkflows": { "type": "boolean", "description": "Indicates whether workflows should be executed" }, "itemKey": { "description": "The key of the item to be copied", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "newItems": { "type": "array", "description": "List of new items to be created", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateNewDuplicateItem" } }, "attributeCopy": { "type": "boolean", "description": "Options for copying item attributes" }, "configurationsCopy": { "type": "boolean", "description": "Options for copying item configurations" }, "crossSellingCopy": { "type": "boolean", "description": "Options for copying item cross-selling data" }, "dataDuplicateOptions": { "description": "Options for copying item data", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateDataDuplicateOptions" }, "deliveryOptionsCopy": { "type": "boolean", "description": "Options for copying item delivery options" }, "downloadFilesCopy": { "type": "boolean", "description": "Options for copying item download files" }, "featuresCopy": { "type": "boolean", "description": "Options for copying item characteristics" }, "identifierDuplicateOptions": { "description": "Options for copying item identifiers", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateIdentifierDuplicateOptions" }, "massWeightCopy": { "type": "boolean", "description": "Options for copying item mass and weight data" }, "mediaDataCopy": { "type": "boolean", "description": "Options for copying item media files" }, "oversalesCopy": { "type": "boolean", "description": "Options for copying item overstock sales settings" }, "ownFieldsCopy": { "type": "boolean", "description": "Options for copying item custom fields" }, "partListComponentsCopy": { "type": "boolean", "description": "Options for copying item bill of materials components" }, "pictureCopy": { "type": "boolean", "description": "Options for copying item images" }, "purchasePricesCopy": { "type": "boolean", "description": "Options for copying item purchase prices" }, "salesPricesCopy": { "type": "boolean", "description": "Options for copying item sales prices" }, "scxDuplicateOptions": { "description": "Options for copying item SCX data", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateScxDuplicateOptions" }, "shopDuplicateOptions": { "description": "Options for copying item shop data", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateShopDuplicateOptions" }, "specialpricesCopy": { "type": "boolean", "description": "Options for copying item special prices" }, "suppliersDuplicateOptions": { "description": "Options for copying item suppliers", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateSuppliersDuplicateOptions" }, "textDuplicateOptions": { "description": "Options for copying item texts", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateTextDuplicateOptions" }, "uploadDataCopy": { "type": "boolean", "description": "Options for copying item upload files" }, "variationsCopy": { "type": "boolean", "description": "Options for copying item variations" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateIdentifierDuplicateOptions": { "type": "object", "description": "Model Class: CreateIdentifierDuplicateOptions ", "additionalProperties": false, "required": [ "IsActive" ], "properties": { "isActive": { "type": "boolean", "description": "IsActive indicates whether these options are used" }, "considerAmazonFnsku": { "type": "boolean", "description": "Consider copying Amazon FNSKU" }, "considerNotes": { "type": "boolean", "description": "Consider copying notes" }, "considerOrderSuggestions": { "type": "boolean", "description": "Consider copying order suggestions flag" }, "considerEan": { "type": "boolean", "description": "Consider copying EAN code" }, "considerHazardNumber": { "type": "boolean", "description": "Consider copying hazard number" }, "considerHan": { "type": "boolean", "description": "Consider copying HAN (Hersteller-Artikel-Nummer)" }, "considerIncludeInPriceList": { "type": "boolean", "description": "Consider copying include in price list flag" }, "considerIsbn": { "type": "boolean", "description": "Consider copying ISBN" }, "considerCountryCode": { "type": "boolean", "description": "Consider copying country code" }, "considerSeries": { "type": "boolean", "description": "Consider copying series information" }, "considerSearchTerms": { "type": "boolean", "description": "Consider copying search terms" }, "considerTaricCode": { "type": "boolean", "description": "Consider copying TARIC code" }, "considerUnNumber": { "type": "boolean", "description": "Consider copying UN number" }, "considerUpc": { "type": "boolean", "description": "Consider copying UPC code" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateNewDuplicateItem": { "type": "object", "description": "Model Class: CreateNewDuplicateItem ", "additionalProperties": false, "required": [ "ReferenceNumber", "ItemNumber", "ItemName", "IsInventoryLeading" ], "properties": { "referenceNumber": { "type": "integer", "description": "Identifier to recognize the article if the article number changes but the article does not yet have a key. Is only required in the memory and is not saved.", "format": "int32" }, "itemNumber": { "type": "string", "description": "ItemNumber for new Item AlphaNumeric, must be unique" }, "itemName": { "type": "string", "description": "Name for new Item, must be unique" }, "isInventoryLeading": { "type": "boolean", "description": "IsInventoryLeading indicates whether the item to be created works with inventory management or not." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateNewItem": { "type": "object", "description": "Model Class: CreateNewItem ", "additionalProperties": false, "required": [ "Name", "MainCategoryId" ], "properties": { "sKU": { "type": "string", "description": "Item SKU. If no SKU is given when posting an item, the SKU will be generated automatically." }, "name": { "type": "string", "description": "Name of the ptoduct in the default language in JTL-Wawi.", "maxLength": 255 }, "mainCategoryId": { "description": "Main Category for the product to be in.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey" }, "salesPriceNet": { "type": "number", "description": "The net sales price of the item.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateScxDuplicateOptions": { "type": "object", "description": "Model Class: CreateScxDuplicateOptions ", "additionalProperties": false, "required": [ "IsActive" ], "properties": { "isActive": { "type": "boolean", "description": "IsActive indicates whether these options are used" }, "considerEveryShop": { "type": "boolean", "description": "Consider all shops" }, "considerCategoryMappings": { "type": "boolean", "description": "Consider copying category mappings" }, "considerSalesChannelFieldValues": { "type": "boolean", "description": "Consider copying sales channel field values" }, "shopsToConsider": { "type": "array", "description": "Choose Shops-Settings which would Copy if ConsiderEveryShop is false", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateShopDuplicateOptions": { "type": "object", "description": "Model Class: CreateShopDuplicateOptions ", "additionalProperties": false, "required": [ "IsActive" ], "properties": { "isActive": { "type": "boolean", "description": "IsActive indicates whether these options are used" }, "considerHighlightOptions": { "type": "boolean", "description": "Consider copying highlight options" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateSuppliersDuplicateOptions": { "type": "object", "description": "Model Class: CreateSuppliersDuplicateOptions ", "additionalProperties": false, "required": [ "IsActive" ], "properties": { "isActive": { "type": "boolean", "description": "IsActive indicates whether these options are used" }, "keepItemName": { "type": "boolean", "description": "Keep original item name from supplier" }, "keepItemNumber": { "type": "boolean", "description": "Keep original item number from supplier" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CreateTextDuplicateOptions": { "type": "object", "description": "Model Class: CreateTextDuplicateOptions ", "additionalProperties": false, "required": [ "IsActive" ], "properties": { "isActive": { "type": "boolean", "description": "IsActive indicates whether these options are used" }, "considerDescriptions": { "type": "boolean", "description": "Consider copying descriptions" }, "considerMetadata": { "type": "boolean", "description": "Consider copying metadata" }, "considerNames": { "type": "boolean", "description": "Consider copying names" }, "considerUrlPaths": { "type": "boolean", "description": "Consider copying URL paths" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CustomerGroupOrderingConstraint": { "type": "object", "description": "Model Class: CustomerGroupOrderingConstraint ", "additionalProperties": false, "required": [ "CustomerGroupid", "IsActive", "OrderingAmount" ], "properties": { "customerGroupid": { "description": "Identifies the customer group.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "isActive": { "type": "boolean", "description": "If this constraint is active." }, "orderingAmount": { "description": "Constraints for this customergroup", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.OrderingAmount" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CustomerGroupPrices": { "type": "object", "description": "Model Class: CustomerGroupPrices ", "additionalProperties": false, "required": [ "CustomerGroupId", "Prices" ], "properties": { "customerGroupId": { "description": "Id of the customergroup", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "prices": { "type": "array", "description": "Contains the prices for that platform and customergroup", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.Price" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CustomerGroupSurcharge": { "type": "object", "description": "Model Class: CustomerGroupSurcharge ", "additionalProperties": false, "required": [ "CustomerGroupId", "Surcharge" ], "properties": { "customerGroupId": { "description": "Id of the customergroup", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "surcharge": { "type": "number", "description": "Surcharge for that customergroup", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.CustomerPrices": { "type": "object", "description": "Model Class: CustomerPrices ", "additionalProperties": false, "required": [ "CustomerId", "Prices" ], "properties": { "customerId": { "description": "Id of the customer", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "prices": { "type": "array", "description": "Contains the prices for that customer", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.Price" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.DuplicateItems": { "type": "object", "description": "Model Class: DuplicateItems ", "additionalProperties": false, "required": [ "Value" ], "properties": { "value": { "type": "array", "description": "The IDs of the duplicated items.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemAsin": { "type": "object", "description": "Model Class: ItemAsin ", "additionalProperties": false, "required": [ "Asin", "IsDefault" ], "properties": { "asin": { "type": "string", "description": "Asin of the item" }, "isDefault": { "type": "boolean", "description": "If this is the default asin for the item. Only one default asin is allowed per item." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemAttributes": { "type": "object", "description": "Model Class: ItemAttributes ", "additionalProperties": false, "required": [ "Attributes" ], "properties": { "attributes": { "type": "array", "description": "Contains all attributes assigned to the item", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.AttributeValues" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemBom": { "type": "object", "description": "Model Class: ItemBom ", "additionalProperties": false, "required": [ "Items" ], "properties": { "items": { "type": "array", "description": "Contains all items in the itembom", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.BomItem" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemBundles": { "type": "object", "description": "Model Class: ItemBundles ", "additionalProperties": false, "required": [ "BundleItems" ], "properties": { "bundleItems": { "type": "array", "description": "Contains all items of the bundle", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.BundleItem" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemCategories": { "type": "object", "description": "Model Class: ItemCategories ", "additionalProperties": false, "required": [ "Categories" ], "properties": { "categories": { "type": "array", "description": "Contains all categories the item is in", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemCategory" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemCategory": { "type": "object", "description": "Model Class: ItemCategory ", "additionalProperties": false, "required": [ "CategoryId" ], "properties": { "categoryId": { "description": "Id of the category", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemConfigurationGroups": { "type": "object", "description": "Model Class: ItemConfigurationGroups ", "additionalProperties": false, "required": [ "Items" ], "properties": { "items": { "type": "array", "description": "Contains all configurationgroups", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.ConfigurationGroup" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemCrossSellingGroups": { "type": "object", "description": "Model Class: ItemCrossSellingGroups ", "additionalProperties": false, "required": [ "Groups" ], "properties": { "groups": { "type": "array", "description": "Contains all crosssellinggroups", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.Artikel.CrossSellingGruppeKey" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemDescriptions": { "type": "object", "description": "Model Class: ItemDescriptions ", "additionalProperties": false, "required": [ "DefaultDescription", "SalesChannelDescriptions", "PlatformDescriptions" ], "properties": { "defaultDescription": { "description": "Default description. This is being used when not overriden by another platform/saleschannel", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.PlatformDescription" }, "salesChannelDescriptions": { "type": "array", "description": "Descriptions belonging to saleschannel Platforms like JTL-Shop.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.SalesChannelDescription" } }, "platformDescriptions": { "type": "array", "description": "Descriptions belonging to non saleschannel Platforms like Printing.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.PlatformDescription" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemEpid": { "type": "object", "description": "Model Class: ItemEpid ", "additionalProperties": false, "required": [ "Epid", "IsDefault" ], "properties": { "epid": { "type": "string", "description": "Asin of the item" }, "isDefault": { "type": "boolean", "description": "If this is the default epid for the item. Only one default epid is allowed per item." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemFeatures": { "type": "object", "description": "Model Class: ItemFeatures ", "additionalProperties": false, "required": [ "Features" ], "properties": { "features": { "type": "array", "description": "Contains all featureid's the item has.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalWertKey" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemIdentifiers": { "type": "object", "description": "Model Class: ItemIdentifiers ", "additionalProperties": false, "required": [ "AmazonFnsku", "Gtin", "HazardNumber", "ISBN", "ManufacturerNumber", "OwnIdentifier", "SKU", "Taric", "UNNumber", "UPC", "ItemAsins", "ItemEpids" ], "properties": { "amazonFnsku": { "type": "string", "description": "The Item AmazonFnsku" }, "gtin": { "type": "string", "description": "The Item Gtin. Also know as EAN." }, "hazardNumber": { "type": "string", "description": "The Item HazardNumber" }, "iSBN": { "type": "string", "description": "The Item ISBN" }, "manufacturerNumber": { "type": "string", "description": "The Item ManufacturerNumber" }, "ownIdentifier": { "type": "string", "description": "The Item OwnIdentifier" }, "sKU": { "type": "string", "description": "Item SKU. If no SKU is given when posting an item, the SKU will be generated automatically." }, "taric": { "type": "string", "description": "Taric code of the item." }, "uNNumber": { "type": "string", "description": "The Item UNNumber" }, "uPC": { "type": "string", "description": "The Item UPC" }, "itemAsins": { "type": "array", "description": "The list of asins of this item", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemAsin" } }, "itemEpids": { "type": "array", "description": "The list of epids of this item. An Epid is an ebay product identifier.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemEpid" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemMeasurements": { "type": "object", "description": "Model Class: ItemMeasurements ", "additionalProperties": false, "required": [ "Height", "Length", "ShippingWeight", "Weight", "Width" ], "properties": { "height": { "type": "number", "description": "The Item Height", "format": "decimal" }, "length": { "type": "number", "description": "The Item Length", "format": "decimal" }, "shippingWeight": { "type": "number", "description": "The Item ShippingWeight", "format": "decimal" }, "weight": { "type": "number", "description": "The Item Weight", "format": "decimal" }, "width": { "type": "number", "description": "The Item Width", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemOrderingConstraints": { "type": "object", "description": "Model Class: ItemOrderingConstraints ", "additionalProperties": false, "required": [ "DefaultOrderingConstraint", "CustomerGroupOrderingConstraints" ], "properties": { "defaultOrderingConstraint": { "description": "Defaultconstraints for all customergroups", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.OrderingAmount" }, "customerGroupOrderingConstraints": { "type": "array", "description": "The customergroup specific ordering restraints.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CustomerGroupOrderingConstraint" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemPrices": { "type": "object", "description": "Model Class: ItemPrices ", "additionalProperties": false, "required": [ "IgnoreDiscounts", "SalesPriceNet", "SuggestedRetailPrice", "PurchasePriceNet", "EbayPrice", "AmazonPrice", "DefaultPrices", "SalesChannelPrices", "CustomerPrices" ], "properties": { "ignoreDiscounts": { "type": "boolean", "description": "Indicates if the item is flagged to ignore other discounts" }, "salesPriceNet": { "type": "number", "description": "The net sales price of the item.", "format": "decimal" }, "suggestedRetailPrice": { "type": "number", "description": "The suggested retail price for the item.", "format": "decimal" }, "purchasePriceNet": { "type": "number", "description": "The purchase price of the item.", "format": "decimal" }, "ebayPrice": { "type": "number", "description": "Default price in new listing templates.", "format": "decimal" }, "amazonPrice": { "type": "number", "description": "Brutto price for new Amazon listings.", "format": "decimal" }, "defaultPrices": { "description": "Contains all platform specific prices", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.PlatformPrices" }, "salesChannelPrices": { "type": "array", "description": "Contains all saleschannel specific prices", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.SalesChannelPrices" } }, "customerPrices": { "type": "array", "description": "Contains all saleschannel specific prices", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CustomerPrices" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemResponse": { "type": "object", "description": "Model Class: ItemResponse ", "additionalProperties": false, "required": [ "ItemId" ], "properties": { "itemId": { "description": "The ID of the item that was created or updated.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemStorageConstraints": { "type": "object", "description": "Model Class: ItemStorageConstraints ", "additionalProperties": false, "required": [ "AllowNegativeStock", "ItemPlatformNegativeStocks", "ItemSalesChannelNegativeStocks", "Buffer", "GlobalMinimumStockLevel", "HasBatch", "IsInventoryManagementActive", "IsBestBeforeManaged", "IsStockDivisible", "SerialNumberType" ], "properties": { "allowNegativeStock": { "type": "boolean", "description": "This option allows you to sell a higher quantity of the item than is actually in stock. Activates this feature but needs to be specified for platforms aswell." }, "itemPlatformNegativeStocks": { "type": "array", "description": "Activates the ability to sell a highter quantity of the item for specific platforms. AllowNegativeStock has be activated aswell.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.NegativeStockPlatform" } }, "itemSalesChannelNegativeStocks": { "type": "array", "description": "Activates the ability to sell a highter quantity of the item for specific saleschannels. AllowNegativeStock has be activated aswell.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.NegativeStockSalesChannel" } }, "buffer": { "type": "integer", "description": "The item buffer", "format": "int32" }, "globalMinimumStockLevel": { "type": "number", "description": "The Item GlobalMinimumStockLevel.", "format": "decimal" }, "hasBatch": { "type": "boolean", "description": "The Item HasBatch." }, "isInventoryManagementActive": { "type": "boolean", "description": "Determines if the item is working with inventory management." }, "isBestBeforeManaged": { "type": "boolean", "description": "Determines if the item is working with best before date ( mhd )." }, "isStockDivisible": { "type": "boolean", "description": "Determines if the item is working split quantities in stock." }, "serialNumberType": { "description": "Determines the type of serial number processing.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.SerialNumberType" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemSupplier": { "type": "object", "description": "Model Class: ItemSupplier ", "additionalProperties": false, "required": [ "SupplierId", "SupplierItemName", "SupplierItemNumber", "StockLevel", "NetPurchasePrice", "Currency", "MinimumPurchaseQuantity", "DeliveryTimeInDays", "SupplierDeliveryTimeInDays", "SupplierSupportsDropshipping", "IsDropshippingActive", "IsDefaultSupplier", "IsDefaultForDropshipping", "PackageUnitDescription", "PackageUnitQuantity", "Notes", "VatRate", "UseSupplierDeliveryTime", "IncludeSupplierStock", "PurchaseInterval", "IsFulfillmentNetworkSupplier", "IsProductionSupplier", "ScalePrices", "LastSupplierStockChange", "PackageUnitPurchasePrice" ], "properties": { "supplierId": { "description": "Id of the supplier", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "supplierItemName": { "type": "string", "description": "Name of the item at the supplier (max 255 characters)." }, "supplierItemNumber": { "type": "string", "description": "Item number at the supplier (max 255 characters)." }, "stockLevel": { "type": "number", "description": "Stock level of the item at the supplier.", "format": "decimal" }, "netPurchasePrice": { "type": "number", "description": "Net purchase price of the item at the supplier.", "format": "decimal" }, "currency": { "type": "string", "description": "Currency used by the supplier." }, "minimumPurchaseQuantity": { "type": "integer", "description": "Minimum purchase quantity of the item at the supplier.", "format": "int32" }, "deliveryTimeInDays": { "type": "integer", "description": "Delivery time for this item at the supplier (in days).", "format": "int32" }, "supplierDeliveryTimeInDays": { "type": "integer", "description": "General delivery time of the supplier (in days).", "format": "int32" }, "supplierSupportsDropshipping": { "type": "boolean", "description": "Indicates if the supplier supports dropshipping." }, "isDropshippingActive": { "type": "boolean", "description": "Indicates if this item uses dropshipping from the supplier." }, "isDefaultSupplier": { "type": "boolean", "description": "Indicates if this supplier is the default supplier for the item." }, "isDefaultForDropshipping": { "type": "boolean", "description": "Indicates if this supplier is the default dropshipping supplier for the item." }, "packageUnitDescription": { "type": "string", "description": "Description of the packaging unit." }, "packageUnitQuantity": { "type": "number", "description": "Quantity per packaging unit.", "format": "decimal" }, "notes": { "type": "string", "description": "Additional notes (max 512 characters)." }, "vatRate": { "type": "number", "description": "VAT rate of the item at the supplier.", "format": "decimal" }, "useSupplierDeliveryTime": { "type": "boolean", "description": "Whether to use the supplier’s delivery time directly." }, "includeSupplierStock": { "type": "boolean", "description": "Whether to include the supplier’s stock in own inventory." }, "purchaseInterval": { "type": "number", "description": "Purchase interval for this item at the supplier.", "format": "decimal" }, "isFulfillmentNetworkSupplier": { "type": "boolean", "description": "Indicates if the supplier is part of the JTL Fulfillment Network." }, "isProductionSupplier": { "type": "boolean", "description": "Indicates if this supplier is a production supplier." }, "scalePrices": { "type": "array", "description": "Scale prices defined by the supplier for this item.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.SupplierPrice" } }, "lastSupplierStockChange": { "type": "string", "description": "Timestamp of last stock change at the supplier.", "format": "date-time" }, "packageUnitPurchasePrice": { "type": "number", "description": "Net purchase price per packaging unit.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemSuppliers": { "type": "object", "description": "Model Class: ItemSuppliers ", "additionalProperties": false, "required": [ "DefaultSupplier", "DefaultDropshippingSupplier", "Suppliers" ], "properties": { "defaultSupplier": { "description": "Sets the default supplier for the item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "defaultDropshippingSupplier": { "description": "Sets the default supplier for dropshipping for the item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "suppliers": { "type": "array", "description": "Assigned suppliers for the item", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemSupplier" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemUnitPricing": { "type": "object", "description": "Model Class: ItemUnitPricing ", "additionalProperties": false, "required": [ "SalesUnitId", "InnerQuantity", "InnerQuantityUnitId", "IsBasePriceDeclared", "BasePriceReferenceUnitId", "BasePriceReferenceAmount" ], "properties": { "salesUnitId": { "description": "Id of the salesunit like kg or liter", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EinheitKey" }, "innerQuantity": { "type": "number", "description": "The amount of content for one piece of the sales unit", "format": "decimal" }, "innerQuantityUnitId": { "description": "The measurement unit for the inner quantity", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MassEinheitKey" }, "isBasePriceDeclared": { "type": "boolean", "description": "Indicates if the baseprice is declared" }, "basePriceReferenceUnitId": { "description": "Unit Measurement for the base price.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MassEinheitKey" }, "basePriceReferenceAmount": { "type": "number", "description": "The amount to refer to when calculating the declared unit price", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemVariations": { "type": "object", "description": "Model Class: ItemVariations ", "additionalProperties": false, "required": [ "Variations", "VariationKombinations" ], "properties": { "variations": { "type": "array", "description": "Contains all Variations", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.Variation" } }, "variationKombinations": { "type": "array", "description": "Contains all VariationKombinations", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.VariationKombination" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.ItemWarehouseConstraints": { "type": "object", "description": "Model Class: ItemWarehouseConstraints ", "additionalProperties": false, "required": [ "Warehouses" ], "properties": { "warehouses": { "type": "array", "description": "This option allows you to sell a higher quantity of the item than is actually in stock. Activates this feature but needs to be specified for platforms aswell.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.WarehouseConstraint" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.NegativeStockPlatform": { "type": "object", "description": "Model Class: NegativeStockPlatform ", "additionalProperties": false, "required": [ "PlatformId", "IsNegativeStockAllowed" ], "properties": { "platformId": { "description": "Identifies the Platform", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PlattformKey" }, "isNegativeStockAllowed": { "type": "boolean", "description": "Determines if negative Stock is allowed for this platform" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.NegativeStockSalesChannel": { "type": "object", "description": "Model Class: NegativeStockSalesChannel ", "additionalProperties": false, "required": [ "SalesChannelId", "IsNegativeStockAllowed" ], "properties": { "salesChannelId": { "type": "string", "description": "Identifies the Saleschannel" }, "isNegativeStockAllowed": { "type": "boolean", "description": "Determines if negative Stock is allowed for this platform" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.OrderingAmount": { "type": "object", "description": "Model Class: OrderingAmount ", "additionalProperties": false, "required": [ "MinimumOrderQuantity", "PurchaseIncrement" ], "properties": { "minimumOrderQuantity": { "type": "number", "description": "Minimum Amount when purchasing this item.", "format": "decimal" }, "purchaseIncrement": { "type": "number", "description": "The increasementsteps when increasing ordering amount.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.PlatformPrices": { "type": "object", "description": "Model Class: PlatformPrices ", "additionalProperties": false, "required": [ "PlatformId", "Prices" ], "properties": { "platformId": { "description": "Id of the platform", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PlattformKey" }, "prices": { "type": "array", "description": "Contains the prices for that platform and customergroup", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CustomerGroupPrices" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.PlatformSurcharges": { "type": "object", "description": "Model Class: PlatformSurcharges ", "additionalProperties": false, "required": [ "PlatformId", "Surcharges" ], "properties": { "platformId": { "description": "Id of the platform", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PlattformKey" }, "surcharges": { "type": "array", "description": "Contains the surcharges for that saleschannel and customergroup", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CustomerGroupSurcharge" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.Price": { "type": "object", "description": "Model Class: Price ", "additionalProperties": false, "required": [ "FromQuantity", "NetPrice", "ReduceStandardPriceByPercent" ], "properties": { "fromQuantity": { "type": "integer", "description": "The quantity for the scale prices. This should be 0 or empty for the default price. If a FromQuantity is given, this price applies to the range from this quantity to the next specified FromQuantity. If no higher FromQuantity exists, then this price applies to all quantities from this point on.", "format": "int32" }, "netPrice": { "type": "number", "description": "The net sales price of the item. If you use NetPrice, you can't use ReduceStandardPriceByPercent too. Only one can be used.", "format": "decimal" }, "reduceStandardPriceByPercent": { "type": "number", "description": "Reduces the default sales price by a percentage. If you use ReduceStandardPriceByPercent, you can't use NetPrice too. Only one can be used.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.SalesChannelPrices": { "type": "object", "description": "Model Class: SalesChannelPrices ", "additionalProperties": false, "required": [ "SalesChannelId", "Prices", "IsActive" ], "properties": { "salesChannelId": { "type": "string", "description": "Id of the saleschannel" }, "prices": { "type": "array", "description": "Contains the prices for that platform and customergroup", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CustomerGroupPrices" } }, "isActive": { "type": "boolean", "description": "Defines if the prices are valid" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.SalesChannelSurcharges": { "type": "object", "description": "Model Class: SalesChannelSurcharges ", "additionalProperties": false, "required": [ "SalesChannelId", "Surcharges", "IsActive" ], "properties": { "salesChannelId": { "type": "string", "description": "Id of the saleschannel" }, "surcharges": { "type": "array", "description": "Contains the surcharges for that saleschannel and customergroup", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.CustomerGroupSurcharge" } }, "isActive": { "type": "boolean", "description": "Defines if the surcharges are valid" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.SerialNumberType": { "type": "integer", "description": "0 = NoSerialNumbers, 1 = SerialNumbersActive, 2 = SerialNumbersTracking", "format": "int32", "x-enumNames": [ "NoSerialNumbers", "SerialNumbersActive", "SerialNumbersTracking" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.StorageLocation": { "type": "object", "description": "Model Class: StorageLocation ", "additionalProperties": false, "required": [ "StorageLocationId", "Note1", "Note2" ], "properties": { "storageLocationId": { "description": "Identifies the storagelocation", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" }, "note1": { "type": "string", "description": "Field for notes" }, "note2": { "type": "string", "description": "Field for notes" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.SupplierPrice": { "type": "object", "description": "Model Class: SupplierPrice ", "additionalProperties": false, "required": [ "FromQuantity", "NetPrice", "UsePercentageDiscount", "PercentageDiscount" ], "properties": { "fromQuantity": { "type": "number", "description": "Quantity from which the price applies. This value is not editable. To change it, a new scale must be created.", "format": "decimal" }, "netPrice": { "type": "number", "description": "Net price for this scale.", "format": "decimal" }, "usePercentageDiscount": { "type": "boolean", "description": "Indicates whether the scale uses a percentage discount of the NetPurchasePrice." }, "percentageDiscount": { "type": "number", "description": "The percentage discount applied in this scale.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateBomItem": { "type": "object", "description": "Model Class: UpdateBomItem ", "additionalProperties": false, "required": [ "ItemId", "Amount" ], "properties": { "itemId": { "description": "Id of the bomitem", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "amount": { "type": "number", "description": "Amount of the itembom that is needed", "format": "decimal" }, "notes": { "type": "string", "description": "Notes for the itembom" }, "position": { "type": "integer", "description": "Position of this item inside the bom", "format": "int32" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateBundleItem": { "type": "object", "description": "Model Class: UpdateBundleItem ", "additionalProperties": false, "properties": { "bundleId": { "description": "Id of the bundle item", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.GebindeKey" }, "eAN": { "type": "string", "description": "The ItemBundle EAN" }, "quantity": { "type": "number", "description": "The ItemBundle Quantity", "format": "decimal" }, "uPC": { "type": "string", "description": "The ItemBundle UPC" }, "unitId": { "description": "The Unit to measure the bundle with", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EinheitKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateConfigurationGroup": { "type": "object", "description": "Model Class: UpdateConfigurationGroup ", "additionalProperties": false, "required": [ "ConfigurationGroupId" ], "properties": { "configurationGroupId": { "description": "Id of the configurationGroup", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KonfiggruppeKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateCustomerGroupOrderingConstraint": { "type": "object", "description": "Model Class: UpdateCustomerGroupOrderingConstraint ", "additionalProperties": false, "required": [ "CustomerGroupid" ], "properties": { "customerGroupid": { "description": "Identifies the customer group.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "isActive": { "type": "boolean", "description": "If this constraint is active." }, "orderingAmount": { "description": "Constraints for this customergroup", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateOrderingAmount" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateCustomerGroupPrices": { "type": "object", "description": "Model Class: UpdateCustomerGroupPrices ", "additionalProperties": false, "required": [ "CustomerGroupId" ], "properties": { "customerGroupId": { "description": "Id of the customergroup", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "prices": { "type": "array", "description": "Contains the prices for that platform and customergroup", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdatePrice" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateCustomerGroupSurcharge": { "type": "object", "description": "Model Class: UpdateCustomerGroupSurcharge ", "additionalProperties": false, "required": [ "CustomerGroupId", "Surcharge" ], "properties": { "customerGroupId": { "description": "Id of the customergroup", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "surcharge": { "type": "number", "description": "Surcharge for that customergroup", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateCustomerPrices": { "type": "object", "description": "Model Class: UpdateCustomerPrices ", "additionalProperties": false, "required": [ "CustomerId" ], "properties": { "customerId": { "description": "Id of the customer", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "prices": { "type": "array", "description": "Contains the prices for that customer", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdatePrice" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItem": { "type": "object", "description": "Model Class: UpdateItem ", "additionalProperties": false, "required": [ "Id" ], "properties": { "id": { "description": "Item SKU. If no SKU is given when posting an item, the SKU will be generated automatically.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "isActive": { "type": "boolean", "description": "Indicates if the item is active." }, "manufacturerId": { "description": "The manufacturer ID.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.HerstellerKey" }, "productGroupId": { "description": "The ID of the item group.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarengruppeKey" }, "responsiblePersonId": { "description": "tbd", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ContactManagement.ProductComplianceContactKey" }, "shippingClassId": { "description": "The shipping class ID.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandklasseKey" }, "sortOrder": { "type": "integer", "description": "The Item SortOrder", "format": "int32" }, "taxClassId": { "description": "The ID of the tax class.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey" }, "isNew": { "type": "boolean", "description": "The Item IsNew" }, "isAvailableForPricelist": { "type": "boolean", "description": "Indicates if the item is visible on a pricelist" }, "isIgnoredForPurchaseProposals": { "type": "boolean", "description": "Indicates if the item should be ignored when generating purchase proposals" }, "countryOfOrigin": { "type": "string", "description": "The Items country of origin" }, "note": { "type": "string", "description": "Notes being attached to the item" }, "isTopItem": { "type": "boolean", "description": "The Item IsTopItem" }, "newInAssortmentDate": { "type": "string", "description": "The Item NewInAssortmentDate", "format": "date-time" }, "descriptions": { "description": "Descriptions of the item", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemDescriptions" }, "prices": { "description": "Prices of the item", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemPrices" }, "storageConstraints": { "description": "Storage Constraints", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemStorageConstraints" }, "bundles": { "description": "Item Bundles", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemBundles" }, "categories": { "description": "Item Categories", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemCategories" }, "configurationGroups": { "description": "Item Configuration Groups", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemConfigurationGroups" }, "identifiers": { "description": "Item Identifiers", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemIdentifiers" }, "measurements": { "description": "Measurements of the item", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemMeasurements" }, "shippingDetails": { "description": "Shipping Details", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemShippingDetails" }, "suppliers": { "description": "Suppliers", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemSuppliers" }, "unitPricing": { "description": "Unit Pricing", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemUnitPricing" }, "orderingConstraints": { "description": "Ordering Constraints", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemOrderingConstraints" }, "crossSellingGroups": { "description": "Crossselling groups of an item", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemCrossSellingGroups" }, "variations": { "description": "Variations of an item", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemVariations" }, "features": { "description": "Features of this item.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemFeatures" }, "attributes": { "description": "Attribute values of this item.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemAttributes" }, "warehouseConstraints": { "description": "Constraints for warehouses for this item.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemWarehouseConstraints" }, "bom": { "description": "If the item is a bom this contains all items.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemBom" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemAsin": { "type": "object", "description": "Model Class: UpdateItemAsin ", "additionalProperties": false, "required": [ "Asin" ], "properties": { "asin": { "type": "string", "description": "Asin of the item" }, "isDefault": { "type": "boolean", "description": "If this is the default asin for the item. Only one default asin is allowed per item." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemAttributes": { "type": "object", "description": "Model Class: UpdateItemAttributes ", "additionalProperties": false, "properties": { "attributes": { "type": "array", "description": "Contains all attributes assigned to the item", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdateAttributeValues" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemBom": { "type": "object", "description": "Model Class: UpdateItemBom ", "additionalProperties": false, "properties": { "items": { "type": "array", "description": "Contains all items in the itembom", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateBomItem" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemBundles": { "type": "object", "description": "Model Class: UpdateItemBundles ", "additionalProperties": false, "properties": { "bundleItems": { "type": "array", "description": "Contains all items of the bundle", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateBundleItem" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemCategories": { "type": "object", "description": "Model Class: UpdateItemCategories ", "additionalProperties": false, "properties": { "categories": { "type": "array", "description": "Contains all categories the item is in", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemCategory" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemCategory": { "type": "object", "description": "Model Class: UpdateItemCategory ", "additionalProperties": false, "required": [ "CategoryId" ], "properties": { "categoryId": { "description": "Id of the category", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemConfigurationGroups": { "type": "object", "description": "Model Class: UpdateItemConfigurationGroups ", "additionalProperties": false, "properties": { "items": { "type": "array", "description": "Contains all configurationgroups", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateConfigurationGroup" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemCrossSellingGroups": { "type": "object", "description": "Model Class: UpdateItemCrossSellingGroups ", "additionalProperties": false, "required": [ "Groups" ], "properties": { "groups": { "type": "array", "description": "Contains all crosssellinggroups", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.Artikel.CrossSellingGruppeKey" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemDescriptions": { "type": "object", "description": "Model Class: UpdateItemDescriptions ", "additionalProperties": false, "required": [ "DefaultDescription" ], "properties": { "defaultDescription": { "description": "Default description. This is being used when not overriden by another platform/saleschannel", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdatePlatformDescription" }, "salesChannelDescriptions": { "type": "array", "description": "Descriptions belonging to saleschannel Platforms like JTL-Shop.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdateSalesChannelDescription" } }, "platformDescriptions": { "type": "array", "description": "Descriptions belonging to non saleschannel Platforms like Printing.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Common.UpdatePlatformDescription" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemEpid": { "type": "object", "description": "Model Class: UpdateItemEpid ", "additionalProperties": false, "required": [ "Epid" ], "properties": { "epid": { "type": "string", "description": "Asin of the item" }, "isDefault": { "type": "boolean", "description": "If this is the default epid for the item. Only one default epid is allowed per item." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemFeatures": { "type": "object", "description": "Model Class: UpdateItemFeatures ", "additionalProperties": false, "properties": { "features": { "type": "array", "description": "Contains all featureid's the item has.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalWertKey" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemIdentifiers": { "type": "object", "description": "Model Class: UpdateItemIdentifiers ", "additionalProperties": false, "properties": { "amazonFnsku": { "type": "string", "description": "The Item AmazonFnsku" }, "gtin": { "type": "string", "description": "The Item Gtin. Also know as EAN." }, "hazardNumber": { "type": "string", "description": "The Item HazardNumber" }, "iSBN": { "type": "string", "description": "The Item ISBN" }, "manufacturerNumber": { "type": "string", "description": "The Item ManufacturerNumber" }, "ownIdentifier": { "type": "string", "description": "The Item OwnIdentifier" }, "sKU": { "type": "string", "description": "Item SKU. If no SKU is given when posting an item, the SKU will be generated automatically." }, "taric": { "type": "string", "description": "Taric code of the item." }, "uNNumber": { "type": "string", "description": "The Item UNNumber" }, "uPC": { "type": "string", "description": "The Item UPC" }, "itemAsins": { "type": "array", "description": "The list of asins of this item", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemAsin" } }, "itemEpids": { "type": "array", "description": "The list of epids of this item. An Epid is an ebay product identifier.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemEpid" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemMeasurements": { "type": "object", "description": "Model Class: UpdateItemMeasurements ", "additionalProperties": false, "properties": { "height": { "type": "number", "description": "The Item Height", "format": "decimal" }, "length": { "type": "number", "description": "The Item Length", "format": "decimal" }, "shippingWeight": { "type": "number", "description": "The Item ShippingWeight", "format": "decimal" }, "weight": { "type": "number", "description": "The Item Weight", "format": "decimal" }, "width": { "type": "number", "description": "The Item Width", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemOrderingConstraints": { "type": "object", "description": "Model Class: UpdateItemOrderingConstraints ", "additionalProperties": false, "properties": { "defaultOrderingConstraint": { "description": "Defaultconstraints for all customergroups", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateOrderingAmount" }, "customerGroupOrderingConstraints": { "type": "array", "description": "The customergroup specific ordering restraints.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateCustomerGroupOrderingConstraint" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemPrices": { "type": "object", "description": "Model Class: UpdateItemPrices ", "additionalProperties": false, "properties": { "ignoreDiscounts": { "type": "boolean", "description": "Indicates if the item is flagged to ignore other discounts" }, "salesPriceNet": { "type": "number", "description": "The net sales price of the item.", "format": "decimal" }, "suggestedRetailPrice": { "type": "number", "description": "The suggested retail price for the item.", "format": "decimal" }, "purchasePriceNet": { "type": "number", "description": "The purchase price of the item.", "format": "decimal" }, "ebayPrice": { "type": "number", "description": "Default price in new listing templates.", "format": "decimal" }, "amazonPrice": { "type": "number", "description": "Brutto price for new Amazon listings.", "format": "decimal" }, "defaultPrices": { "description": "Contains all platform specific prices", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdatePlatformPrices" }, "salesChannelPrices": { "type": "array", "description": "Contains all saleschannel specific prices", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateSalesChannelPrices" } }, "customerPrices": { "type": "array", "description": "Contains all saleschannel specific prices", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateCustomerPrices" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemShippingDetails": { "type": "object", "description": "Model Class: UpdateItemShippingDetails ", "additionalProperties": false, "properties": { "deliveryDaysWhenSoldOut": { "type": "integer", "description": "The Item DeliveryDaysWhenSoldOut", "format": "int32" }, "hasAutomaticDeliveryDays": { "type": "boolean", "description": "The Item HasAutomaticDeliveryDays" }, "processingTime": { "type": "integer", "description": "The Item ProcessingTime", "format": "int32" }, "releaseDate": { "type": "string", "description": "The Item ReleaseDate", "format": "date-time" }, "availabilityId": { "description": "tbd", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferstatusKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemStorageConstraints": { "type": "object", "description": "Model Class: UpdateItemStorageConstraints ", "additionalProperties": false, "properties": { "allowNegativeStock": { "type": "boolean", "description": "This option allows you to sell a higher quantity of the item than is actually in stock. Activates this feature but needs to be specified for platforms aswell." }, "itemPlatformNegativeStocks": { "type": "array", "description": "Activates the ability to sell a highter quantity of the item for specific platforms. AllowNegativeStock has be activated aswell.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateNegativeStockPlatform" } }, "itemSalesChannelNegativeStocks": { "type": "array", "description": "Activates the ability to sell a highter quantity of the item for specific saleschannels. AllowNegativeStock has be activated aswell.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateNegativeStockSalesChannel" } }, "buffer": { "type": "integer", "description": "The item buffer", "format": "int32" }, "globalMinimumStockLevel": { "type": "number", "description": "The Item GlobalMinimumStockLevel.", "format": "decimal" }, "hasBatch": { "type": "boolean", "description": "The Item HasBatch." }, "isInventoryManagementActive": { "type": "boolean", "description": "Determines if the item is working with inventory management." }, "isBestBeforeManaged": { "type": "boolean", "description": "Determines if the item is working with best before date ( mhd )." }, "isStockDivisible": { "type": "boolean", "description": "Determines if the item is working split quantities in stock." }, "serialNumberType": { "type": "integer", "description": "Determines the type of serial number processing.", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.SerialNumberType" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemSupplier": { "type": "object", "description": "Model Class: UpdateItemSupplier ", "additionalProperties": false, "required": [ "SupplierId" ], "properties": { "supplierId": { "description": "Id of the supplier", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "supplierItemName": { "type": "string", "description": "Name of the item at the supplier (max 255 characters)." }, "supplierItemNumber": { "type": "string", "description": "Item number at the supplier (max 255 characters)." }, "stockLevel": { "type": "number", "description": "Stock level of the item at the supplier.", "format": "decimal" }, "netPurchasePrice": { "type": "number", "description": "Net purchase price of the item at the supplier.", "format": "decimal" }, "minimumPurchaseQuantity": { "type": "integer", "description": "Minimum purchase quantity of the item at the supplier.", "format": "int32" }, "deliveryTimeInDays": { "type": "integer", "description": "Delivery time for this item at the supplier (in days).", "format": "int32" }, "packageUnitDescription": { "type": "string", "description": "Description of the packaging unit." }, "packageUnitQuantity": { "type": "number", "description": "Quantity per packaging unit.", "format": "decimal" }, "notes": { "type": "string", "description": "Additional notes (max 512 characters)." }, "vatRate": { "type": "number", "description": "VAT rate of the item at the supplier.", "format": "decimal" }, "useSupplierDeliveryTime": { "type": "boolean", "description": "Whether to use the supplier’s delivery time directly." }, "includeSupplierStock": { "type": "boolean", "description": "Whether to include the supplier’s stock in own inventory." }, "purchaseInterval": { "type": "number", "description": "Purchase interval for this item at the supplier.", "format": "decimal" }, "scalePrices": { "type": "array", "description": "Scale prices defined by the supplier for this item.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateSupplierPrice" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemSuppliers": { "type": "object", "description": "Model Class: UpdateItemSuppliers ", "additionalProperties": false, "properties": { "defaultSupplier": { "description": "Sets the default supplier for the item.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "defaultDropshippingSupplier": { "description": "Sets the default supplier for dropshipping for the item.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "suppliers": { "type": "array", "description": "Assigned suppliers for the item", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemSupplier" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemUnitPricing": { "type": "object", "description": "Model Class: UpdateItemUnitPricing ", "additionalProperties": false, "properties": { "salesUnitId": { "description": "Id of the salesunit like kg or liter", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EinheitKey" }, "innerQuantity": { "type": "number", "description": "The amount of content for one piece of the sales unit", "format": "decimal" }, "innerQuantityUnitId": { "description": "The measurement unit for the inner quantity", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MassEinheitKey" }, "isBasePriceDeclared": { "type": "boolean", "description": "Indicates if the baseprice is declared" }, "basePriceReferenceUnitId": { "description": "Unit Measurement for the base price.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MassEinheitKey" }, "basePriceReferenceAmount": { "type": "number", "description": "The amount to refer to when calculating the declared unit price", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemVariations": { "type": "object", "description": "Model Class: UpdateItemVariations ", "additionalProperties": false, "properties": { "variations": { "type": "array", "description": "Contains all Variations", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateVariation" } }, "variationKombinations": { "type": "array", "description": "Contains all VariationKombinations", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateVariationKombination" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateItemWarehouseConstraints": { "type": "object", "description": "Model Class: UpdateItemWarehouseConstraints ", "additionalProperties": false, "properties": { "warehouses": { "type": "array", "description": "This option allows you to sell a higher quantity of the item than is actually in stock. Activates this feature but needs to be specified for platforms aswell.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateWarehouseConstraint" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateNegativeStockPlatform": { "type": "object", "description": "Model Class: UpdateNegativeStockPlatform ", "additionalProperties": false, "properties": { "platformId": { "description": "Identifies the Platform", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PlattformKey" }, "isNegativeStockAllowed": { "type": "boolean", "description": "Determines if negative Stock is allowed for this platform" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateNegativeStockSalesChannel": { "type": "object", "description": "Model Class: UpdateNegativeStockSalesChannel ", "additionalProperties": false, "properties": { "salesChannelId": { "type": "string", "description": "Identifies the Saleschannel" }, "isNegativeStockAllowed": { "type": "boolean", "description": "Determines if negative Stock is allowed for this platform" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateOrderingAmount": { "type": "object", "description": "Model Class: UpdateOrderingAmount ", "additionalProperties": false, "properties": { "minimumOrderQuantity": { "type": "number", "description": "Minimum Amount when purchasing this item.", "format": "decimal" }, "purchaseIncrement": { "type": "number", "description": "The increasementsteps when increasing ordering amount.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdatePlatformPrices": { "type": "object", "description": "Model Class: UpdatePlatformPrices ", "additionalProperties": false, "required": [ "PlatformId" ], "properties": { "platformId": { "description": "Id of the platform", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PlattformKey" }, "prices": { "type": "array", "description": "Contains the prices for that platform and customergroup", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateCustomerGroupPrices" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdatePlatformSurcharges": { "type": "object", "description": "Model Class: UpdatePlatformSurcharges ", "additionalProperties": false, "required": [ "PlatformId", "Surcharges" ], "properties": { "platformId": { "description": "Id of the platform", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PlattformKey" }, "surcharges": { "type": "array", "description": "Contains the surcharges for that saleschannel and customergroup", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateCustomerGroupSurcharge" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdatePrice": { "type": "object", "description": "Model Class: UpdatePrice ", "additionalProperties": false, "required": [ "FromQuantity" ], "properties": { "fromQuantity": { "type": "integer", "description": "The quantity for the scale prices. This should be 0 or empty for the default price. If a FromQuantity is given, this price applies to the range from this quantity to the next specified FromQuantity. If no higher FromQuantity exists, then this price applies to all quantities from this point on.", "format": "int32" }, "netPrice": { "type": "number", "description": "The net sales price of the item. If you use NetPrice, you can't use ReduceStandardPriceByPercent too. Only one can be used.", "format": "decimal" }, "reduceStandardPriceByPercent": { "type": "number", "description": "Reduces the default sales price by a percentage. If you use ReduceStandardPriceByPercent, you can't use NetPrice too. Only one can be used.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateSalesChannelPrices": { "type": "object", "description": "Model Class: UpdateSalesChannelPrices ", "additionalProperties": false, "required": [ "SalesChannelId" ], "properties": { "salesChannelId": { "type": "string", "description": "Id of the saleschannel" }, "prices": { "type": "array", "description": "Contains the prices for that platform and customergroup", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateCustomerGroupPrices" } }, "isActive": { "type": "boolean", "description": "Defines if the prices are valid" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateSalesChannelSurcharges": { "type": "object", "description": "Model Class: UpdateSalesChannelSurcharges ", "additionalProperties": false, "required": [ "SalesChannelId", "Surcharges" ], "properties": { "salesChannelId": { "type": "string", "description": "Id of the saleschannel" }, "surcharges": { "type": "array", "description": "Contains the surcharges for that saleschannel and customergroup", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateCustomerGroupSurcharge" } }, "isActive": { "type": "boolean", "description": "Defines if the surcharges are valid" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateStorageLocation": { "type": "object", "description": "Model Class: UpdateStorageLocation ", "additionalProperties": false, "properties": { "storageLocationId": { "description": "Identifies the storagelocation", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" }, "note1": { "type": "string", "description": "Field for notes" }, "note2": { "type": "string", "description": "Field for notes" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateSupplierPrice": { "type": "object", "description": "Model Class: UpdateSupplierPrice ", "additionalProperties": false, "required": [ "FromQuantity" ], "properties": { "fromQuantity": { "type": "number", "description": "Quantity from which the price applies. This value is not editable. To change it, a new scale must be created.", "format": "decimal" }, "netPrice": { "type": "number", "description": "Net price for this scale.", "format": "decimal" }, "usePercentageDiscount": { "type": "boolean", "description": "Indicates whether the scale uses a percentage discount of the NetPurchasePrice." }, "percentageDiscount": { "type": "number", "description": "The percentage discount applied in this scale.", "format": "decimal" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateVariation": { "type": "object", "description": "Model Class: UpdateVariation ", "additionalProperties": false, "required": [ "VariationId", "VariationType" ], "properties": { "variationId": { "description": "Id of the Variation", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey" }, "position": { "type": "integer", "description": "Position of this Variation in the List", "format": "int32" }, "descriptions": { "type": "array", "description": "Descriptions of this Variation in multiple Languages", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateVariationDescription" } }, "values": { "type": "array", "description": "Values for this Variation", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateVariationValue" } }, "variationType": { "description": "Type of the Variation", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.VariationType" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateVariationDescription": { "type": "object", "description": "Model Class: UpdateVariationDescription ", "additionalProperties": false, "required": [ "LanguageId", "Name" ], "properties": { "languageId": { "type": "string", "description": "ISO3 Id of the Language", "maxLength": 2147483647 }, "name": { "type": "string", "description": "Name of the Variation" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateVariationKombination": { "type": "object", "description": "Model Class: UpdateVariationKombination ", "additionalProperties": false, "required": [ "Variations", "ItemId" ], "properties": { "variations": { "type": "array", "description": "List of VariationValues that defines this Kombination", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationWertKey" } }, "itemId": { "description": "Id of the Item that is assigned to this Kombination", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateVariationValue": { "type": "object", "description": "Model Class: UpdateVariationValue ", "additionalProperties": false, "required": [ "VariationValueId" ], "properties": { "variationValueId": { "description": "Id of the VariationValue", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationWertKey" }, "itemNumber": { "type": "string", "description": "Itemnumber for this variationvalue" }, "gTIN": { "type": "string", "description": "GTIN for this variationvalue" }, "weightOffset": { "type": "number", "description": "Offset for the weight of this variationvalue", "format": "decimal" }, "descriptions": { "type": "array", "description": "Descriptions of this VariationValue in multiple Languages", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateVariationValueDescription" } }, "surcharges": { "description": "Surcharges of this VariationValue", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateVariationValueSurcharges" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateVariationValueDescription": { "type": "object", "description": "Model Class: UpdateVariationValueDescription ", "additionalProperties": false, "required": [ "LanguageId", "Name" ], "properties": { "languageId": { "type": "string", "description": "ISO3 Id of the Language", "maxLength": 2147483647 }, "name": { "type": "string", "description": "Name of the VariationValue" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateVariationValueSurcharges": { "type": "object", "description": "Model Class: UpdateVariationValueSurcharges ", "additionalProperties": false, "properties": { "defaultSurchargeNet": { "type": "number", "description": "Default Surcharge if there is none specified for a specific saleschannel + customergroup", "format": "decimal" }, "platformSurcharges": { "description": "Surcharge for specific platforms", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdatePlatformSurcharges" }, "salesChannelSurcharges": { "description": "Surcharge for specific saleschannels + customergroups", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateSalesChannelSurcharges" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateWarehouseConstraint": { "type": "object", "description": "Model Class: UpdateWarehouseConstraint ", "additionalProperties": false, "properties": { "warehouseId": { "description": "Identifies the warehouse", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "minStock": { "type": "number", "description": "The minimal stock for this item in this warehouse.", "format": "decimal" }, "maxStock": { "type": "number", "description": "The maximum stock for this item in this warehouse.", "format": "decimal" }, "storagelocations": { "type": "array", "description": "Locations in the warehouse where the item is placed", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.UpdateStorageLocation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.Variation": { "type": "object", "description": "Model Class: Variation ", "additionalProperties": false, "required": [ "VariationId", "Position", "Descriptions", "Values", "VariationType" ], "properties": { "variationId": { "description": "Id of the Variation", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey" }, "position": { "type": "integer", "description": "Position of this Variation in the List", "format": "int32" }, "descriptions": { "type": "array", "description": "Descriptions of this Variation in multiple Languages", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.VariationDescription" } }, "values": { "type": "array", "description": "Values for this Variation", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.VariationValue" } }, "variationType": { "description": "Type of the Variation", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.VariationType" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.VariationDescription": { "type": "object", "description": "Model Class: VariationDescription ", "additionalProperties": false, "required": [ "LanguageId", "Name" ], "properties": { "languageId": { "type": "string", "description": "ISO3 Id of the Language" }, "name": { "type": "string", "description": "Name of the Variation" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.VariationKombination": { "type": "object", "description": "Model Class: VariationKombination ", "additionalProperties": false, "required": [ "Variations", "ItemId" ], "properties": { "variations": { "type": "array", "description": "List of VariationValues that defines this Kombination", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationWertKey" } }, "itemId": { "description": "Id of the Item that is assigned to this Kombination", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.VariationType": { "type": "integer", "description": "0 = Unknown, 1 = Selectbox, 2 = Radiobutton, 3 = Swatches, 4 = Textbox, 5 = FreeText, 6 = MandatoryFreeText", "format": "int32", "x-enumNames": [ "Unknown", "Selectbox", "Radiobutton", "Swatches", "Textbox", "FreeText", "MandatoryFreeText" ], "enum": [ 0, 1, 2, 3, 4, 5, 6 ] }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.VariationValue": { "type": "object", "description": "Model Class: VariationValue ", "additionalProperties": false, "required": [ "VariationValueId", "ItemNumber", "GTIN", "WeightOffset", "Descriptions", "Surcharges" ], "properties": { "variationValueId": { "description": "Id of the VariationValue", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationWertKey" }, "itemNumber": { "type": "string", "description": "Itemnumber for this variationvalue" }, "gTIN": { "type": "string", "description": "GTIN for this variationvalue" }, "weightOffset": { "type": "number", "description": "Offset for the weight of this variationvalue", "format": "decimal" }, "descriptions": { "type": "array", "description": "Descriptions of this VariationValue in multiple Languages", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.VariationValueDescription" } }, "surcharges": { "description": "Surcharges of this VariationValue", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.VariationValueSurcharges" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.VariationValueDescription": { "type": "object", "description": "Model Class: VariationValueDescription ", "additionalProperties": false, "required": [ "LanguageId", "Name" ], "properties": { "languageId": { "type": "string", "description": "ISO3 Id of the Language" }, "name": { "type": "string", "description": "Name of the VariationValue" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.VariationValueSurcharges": { "type": "object", "description": "Model Class: VariationValueSurcharges ", "additionalProperties": false, "required": [ "DefaultSurchargeNet", "PlatformSurcharges", "SalesChannelSurcharges" ], "properties": { "defaultSurchargeNet": { "type": "number", "description": "Default Surcharge if there is none specified for a specific saleschannel + customergroup", "format": "decimal" }, "platformSurcharges": { "description": "Surcharge for specific platforms", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.PlatformSurcharges" }, "salesChannelSurcharges": { "description": "Surcharge for specific saleschannels + customergroups", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.SalesChannelSurcharges" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Item.WarehouseConstraint": { "type": "object", "description": "Model Class: WarehouseConstraint ", "additionalProperties": false, "required": [ "WarehouseId", "MinStock", "MaxStock", "Storagelocations" ], "properties": { "warehouseId": { "description": "Identifies the warehouse", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "minStock": { "type": "number", "description": "The minimal stock for this item in this warehouse.", "format": "decimal" }, "maxStock": { "type": "number", "description": "The maximum stock for this item in this warehouse.", "format": "decimal" }, "storagelocations": { "type": "array", "description": "Locations in the warehouse where the item is placed", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Item.StorageLocation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Label.CreateLabel": { "type": "object", "description": "Model Class: CreateLabel ", "additionalProperties": false, "properties": { "type": { "type": "integer", "description": "Label type.", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Label.LabelType" }, "name": { "type": "string", "description": "Label name." }, "colorCode": { "type": "string", "description": "Label color." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Label.Label": { "type": "object", "description": "Model Class: Label ", "additionalProperties": false, "required": [ "Id", "Type", "Name", "ColorCode" ], "properties": { "id": { "description": "Unique ID to identify a label.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LabelKey" }, "type": { "description": "Label type.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Label.LabelType" }, "name": { "type": "string", "description": "Label name." }, "colorCode": { "type": "string", "description": "Label color." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Label.LabelType": { "type": "integer", "description": "1 = Article, 2 = Customer, 6 = ProductionOperation, 7 = ProductionOrder, 8 = Resource", "format": "int32", "x-enumNames": [ "Article", "Customer", "ProductionOperation", "ProductionOrder", "Resource" ], "enum": [ 1, 2, 6, 7, 8 ] }, "JTL.Wawi.Rest.Contracts.Models.V2.Label.QueryLabelsResponse": { "type": "object", "description": "Model Class: QueryLabelsResponse ", "additionalProperties": false, "required": [ "Data" ], "properties": { "data": { "type": "array", "description": "The labels.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Label.Label" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Label.UpdateLabel": { "type": "object", "description": "Model Class: UpdateLabel ", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Label name." }, "colorCode": { "type": "string", "description": "Label color." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.AddressType": { "type": "integer", "description": "0 = Global, 1 = Delivery, 2 = Billing, 3 = PickUpAddress, 4 = Other", "format": "int32", "x-enumNames": [ "Global", "Delivery", "Billing", "PickUpAddress", "Other" ], "enum": [ 0, 1, 2, 3, 4 ] }, "JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.CreateManufacturer": { "type": "object", "description": "Model Class: CreateManufacturer ", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Name of the manufacturer." }, "homepageUrl": { "type": "string", "description": "Homepage url of the manufacturer." }, "position": { "type": "integer", "description": "Sorting position of the manufacturer.", "format": "int32" }, "manufacturerLanguages": { "type": "array", "description": "Language translation of the manufacturer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.CreateManufacturerLanguage" } }, "contact": { "description": "Address of the manufacturer.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.CreateManufacturerContactAddress" }, "imageId": { "description": "Unique ID to identify a manufacturer image.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.BildKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.CreateManufacturerContactAddress": { "type": "object", "description": "Model Class: CreateManufacturerContactAddress ", "additionalProperties": false, "properties": { "companyName": { "type": "string", "description": "Company name of the contact." }, "salutation": { "type": "integer", "description": "Stalutation of the contact.", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.Salutation" }, "academicTitle": { "type": "string", "description": "Academic title of the contact." }, "lastName": { "type": "string", "description": "Last name of the contact." }, "firstName": { "type": "string", "description": "First name of the contact." }, "street": { "type": "string", "description": "Street name." }, "houseNumber": { "type": "string", "description": "House number." }, "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City name." }, "countryIso": { "type": "string", "description": "ISO country code." }, "phoneNumber": { "type": "string", "description": "Phone number." }, "mobileNumber": { "type": "string", "description": "Mobile phone number." }, "faxNumber": { "type": "string", "description": "Fax number." }, "companyAdditionalName": { "type": "string", "description": "Additional company name." }, "addressSupplement": { "type": "string", "description": "Address supplement (e.g. floor or unit)." }, "eMailAddress": { "type": "string", "description": "Email address." }, "state": { "type": "string", "description": "Full state name if no ISO code is available." }, "stateIso": { "type": "string", "description": "ISO 3166-2 code for the state/province." }, "type": { "type": "integer", "description": "Type of the address.", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.AddressType" }, "homepage": { "type": "string", "description": "Homepage of the contact." }, "isDefault": { "type": "boolean", "description": "Indicates if the address is the default address." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.CreateManufacturerLanguage": { "type": "object", "description": "Model Class: CreateManufacturerLanguage ", "additionalProperties": false, "properties": { "languageId": { "description": "Unique ID to identify a language.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SpracheKey" }, "metaTitle": { "type": "string", "description": "Meta title of the manufacturer." }, "metaKeywords": { "type": "string", "description": "Meta keywords of the manufacturer." }, "metaDescription": { "type": "string", "description": "Meta description of the manufacturer." }, "description": { "type": "string", "description": "Manufacturer description." }, "seo": { "type": "string", "description": "The SEO text in the given language." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.Manufacturer": { "type": "object", "description": "Model Class: Manufacturer ", "additionalProperties": false, "required": [ "Id", "Name", "HomepageUrl", "Position", "ManufacturerLanguages", "Contact", "ImageId" ], "properties": { "id": { "description": "Unique ID to identify a manufacturer.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.HerstellerKey" }, "name": { "type": "string", "description": "Name of the manufacturer." }, "homepageUrl": { "type": "string", "description": "Homepage url of the manufacturer." }, "position": { "type": "integer", "description": "Sorting position of the manufacturer.", "format": "int32" }, "manufacturerLanguages": { "type": "array", "description": "Language translation of the manufacturer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.ManufacturerLanguage" } }, "contact": { "description": "Address of the manufacturer.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.ManufacturerContactAddress" }, "imageId": { "description": "Unique ID to identify a manufacturer image.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.BildKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.ManufacturerContactAddress": { "type": "object", "description": "Model Class: ManufacturerContactAddress ", "additionalProperties": false, "required": [ "CompanyName", "Salutation", "AcademicTitle", "LastName", "FirstName", "Street", "HouseNumber", "PostalCode", "City", "CountryIso", "PhoneNumber", "MobileNumber", "FaxNumber", "CompanyAdditionalName", "AddressSupplement", "EMailAddress", "State", "StateIso", "Type", "Homepage", "IsDefault" ], "properties": { "companyName": { "type": "string", "description": "Company name of the contact." }, "salutation": { "description": "Stalutation of the contact.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.Salutation" }, "academicTitle": { "type": "string", "description": "Academic title of the contact." }, "lastName": { "type": "string", "description": "Last name of the contact." }, "firstName": { "type": "string", "description": "First name of the contact." }, "street": { "type": "string", "description": "Street name." }, "houseNumber": { "type": "string", "description": "House number." }, "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City name." }, "countryIso": { "type": "string", "description": "ISO country code." }, "phoneNumber": { "type": "string", "description": "Phone number." }, "mobileNumber": { "type": "string", "description": "Mobile phone number." }, "faxNumber": { "type": "string", "description": "Fax number." }, "companyAdditionalName": { "type": "string", "description": "Additional company name." }, "addressSupplement": { "type": "string", "description": "Address supplement (e.g. floor or unit)." }, "eMailAddress": { "type": "string", "description": "Email address." }, "state": { "type": "string", "description": "Full state name if no ISO code is available." }, "stateIso": { "type": "string", "description": "ISO 3166-2 code for the state/province." }, "type": { "description": "Type of the address.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.AddressType" }, "homepage": { "type": "string", "description": "Homepage of the contact." }, "isDefault": { "type": "boolean", "description": "Indicates if the address is the default address." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.ManufacturerLanguage": { "type": "object", "description": "Model Class: ManufacturerLanguage ", "additionalProperties": false, "required": [ "LanguageId", "MetaTitle", "MetaKeywords", "MetaDescription", "Description", "Seo" ], "properties": { "languageId": { "description": "Unique ID to identify a language.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SpracheKey" }, "metaTitle": { "type": "string", "description": "Meta title of the manufacturer." }, "metaKeywords": { "type": "string", "description": "Meta keywords of the manufacturer." }, "metaDescription": { "type": "string", "description": "Meta description of the manufacturer." }, "description": { "type": "string", "description": "Manufacturer description." }, "seo": { "type": "string", "description": "The SEO text in the given language." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.Salutation": { "type": "integer", "description": "0 = Company, 1 = Mr, 2 = Mrs, 3 = Divers", "format": "int32", "x-enumNames": [ "Company", "Mr", "Mrs", "Divers" ], "enum": [ 0, 1, 2, 3 ] }, "JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.UpdateManufacturer": { "type": "object", "description": "Model Class: UpdateManufacturer ", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Name of the manufacturer." }, "homepageUrl": { "type": "string", "description": "Homepage url of the manufacturer." }, "position": { "type": "integer", "description": "Sorting position of the manufacturer.", "format": "int32" }, "manufacturerLanguages": { "type": "array", "description": "Language translation of the manufacturer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.UpdateManufacturerLanguage" } }, "contact": { "description": "Address of the manufacturer.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.UpdateManufacturerContactAddress" }, "imageId": { "description": "Unique ID to identify a manufacturer image.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.BildKey" } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.UpdateManufacturerContactAddress": { "type": "object", "description": "Model Class: UpdateManufacturerContactAddress ", "additionalProperties": false, "properties": { "companyName": { "type": "string", "description": "Company name of the contact." }, "salutation": { "type": "integer", "description": "Stalutation of the contact.", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.Salutation" }, "academicTitle": { "type": "string", "description": "Academic title of the contact." }, "lastName": { "type": "string", "description": "Last name of the contact." }, "firstName": { "type": "string", "description": "First name of the contact." }, "street": { "type": "string", "description": "Street name." }, "houseNumber": { "type": "string", "description": "House number." }, "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City name." }, "countryIso": { "type": "string", "description": "ISO country code." }, "phoneNumber": { "type": "string", "description": "Phone number." }, "mobileNumber": { "type": "string", "description": "Mobile phone number." }, "faxNumber": { "type": "string", "description": "Fax number." }, "companyAdditionalName": { "type": "string", "description": "Additional company name." }, "addressSupplement": { "type": "string", "description": "Address supplement (e.g. floor or unit)." }, "eMailAddress": { "type": "string", "description": "Email address." }, "state": { "type": "string", "description": "Full state name if no ISO code is available." }, "stateIso": { "type": "string", "description": "ISO 3166-2 code for the state/province." }, "type": { "type": "integer", "description": "Type of the address.", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.AddressType" }, "homepage": { "type": "string", "description": "Homepage of the contact." }, "isDefault": { "type": "boolean", "description": "Indicates if the address is the default address." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.Manufacturer.UpdateManufacturerLanguage": { "type": "object", "description": "Model Class: UpdateManufacturerLanguage ", "additionalProperties": false, "properties": { "languageId": { "description": "Unique ID to identify a language.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SpracheKey" }, "metaTitle": { "type": "string", "description": "Meta title of the manufacturer." }, "metaKeywords": { "type": "string", "description": "Meta keywords of the manufacturer." }, "metaDescription": { "type": "string", "description": "Meta description of the manufacturer." }, "description": { "type": "string", "description": "Manufacturer description." }, "seo": { "type": "string", "description": "The SEO text in the given language." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.ProductGroup.CreateProductGroup": { "type": "object", "description": "Model Class: CreateProductGroup ", "additionalProperties": false, "required": [ "Name" ], "properties": { "name": { "type": "string", "description": "The name of the item group.", "maxLength": 255 } } }, "JTL.Wawi.Rest.Contracts.Models.V2.ProductGroup.ProductGroup": { "type": "object", "description": "Model Class: ProductGroup ", "additionalProperties": false, "required": [ "Id", "Name" ], "properties": { "id": { "description": "Unique ID to identify an item group.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarengruppeKey" }, "name": { "type": "string", "description": "The name of the item group." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.ProductGroup.UpdateProductGroup": { "type": "object", "description": "Model Class: UpdateProductGroup ", "additionalProperties": false, "required": [ "Id", "Name" ], "properties": { "id": { "description": "Unique ID to identify an item group.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarengruppeKey" }, "name": { "type": "string", "description": "The name of the item group.", "maxLength": 255 } } }, "JTL.Wawi.Rest.Contracts.Models.V2.UnitsOfMeasure.CreateSalesUnit": { "type": "object", "description": "Model Class: CreateSalesUnit ", "additionalProperties": false, "required": [ "Translations" ], "properties": { "translations": { "type": "array", "description": "List of translations for the sales unit in different languages.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateTranslation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.UnitsOfMeasure.CreateUnitOfMeasurement": { "type": "object", "description": "Model Class: CreateUnitOfMeasurement ", "additionalProperties": false, "required": [ "DisplayCode", "Translations" ], "properties": { "displayCode": { "type": "string", "description": "Display code for the unit of measurement." }, "translations": { "type": "array", "description": "List of translations for the unit of measurement in different languages.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateTranslation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.UnitsOfMeasure.SalesUnit": { "type": "object", "description": "Model Class: SalesUnit ", "additionalProperties": false, "required": [ "Id", "Translations" ], "properties": { "id": { "description": "Unique ID to identify a sales unit.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufsEinheitKey" }, "translations": { "type": "array", "description": "List of translations for the sales unit in different languages.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Translation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.UnitsOfMeasure.UnitOfMeasurement": { "type": "object", "description": "Model Class: UnitOfMeasurement ", "additionalProperties": false, "required": [ "Id", "DisplayCode", "Translations" ], "properties": { "id": { "description": "Unique ID to identify a unit of measurement.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MassEinheitKey" }, "displayCode": { "type": "string", "description": "Display code for the unit of measurement." }, "translations": { "type": "array", "description": "List of translations for the unit of measurement in different languages.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Translation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.UnitsOfMeasure.UpdateSalesUnit": { "type": "object", "description": "Model Class: UpdateSalesUnit ", "additionalProperties": false, "required": [ "Translations" ], "properties": { "translations": { "type": "array", "description": "List of translations for the sales unit in different languages.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateTranslation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.UnitsOfMeasure.UpdateUnitOfMeasurement": { "type": "object", "description": "Model Class: UpdateUnitOfMeasurement ", "additionalProperties": false, "required": [ "DisplayCode", "Translations" ], "properties": { "displayCode": { "type": "string", "description": "Display code for the unit of measurement." }, "translations": { "type": "array", "description": "List of translations for the unit of measurement in different languages.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateTranslation" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.CreateWawiAppAddress": { "type": "object", "description": "Model Class: CreateWawiAppAddress ", "additionalProperties": false, "required": [ "Street", "City", "CountryIso2" ], "properties": { "addressType": { "type": "integer", "description": "Art der Adresse (z.B. Rechnungsadresse, Lieferadresse).", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.WawiAppAddressType" }, "isStandard": { "type": "boolean", "description": "Gibt an, ob es sich um die Standardadresse handelt." }, "street": { "type": "string", "description": "Straßenname und Hausnummer." }, "city": { "type": "string", "description": "Name der Stadt." }, "countryIso2": { "type": "string", "description": "ISO 2-stelliger Ländercode." }, "honorific": { "type": "string", "description": "Anrede (z.B. Herr, Frau)." }, "title": { "type": "string", "description": "Akademischer Titel." }, "firstName": { "type": "string", "description": "Vorname." }, "lastName": { "type": "string", "description": "Nachname." }, "company": { "type": "string", "description": "Firmenname." }, "companyAddition": { "type": "string", "description": "Firmenzusatz." }, "additionalAddressInfo": { "type": "string", "description": "Zusätzliche Adressinformationen." }, "state": { "type": "string", "description": "Bundesland oder Region." }, "country": { "type": "string", "description": "Name des Landes." }, "salesTaxIdentificationNumber": { "type": "string", "description": "Umsatzsteuer-Identifikationsnummer." }, "phoneNumber": { "type": "string", "description": "Telefonnummer." }, "mobilePhoneNumber": { "type": "string", "description": "Mobiltelefonnummer." }, "mailAddress": { "type": "string", "description": "E-Mail-Adresse." }, "postalCode": { "type": "string", "description": "Postleitzahl." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.CreateWawiAppBankAccount": { "type": "object", "description": "Model Class: CreateWawiAppBankAccount ", "additionalProperties": false, "properties": { "accountNumber": { "type": "string", "description": "Bank account number." }, "bankNumber": { "type": "string", "description": "Bank code or routing number." }, "iBAN": { "type": "string", "description": "International Bank Account Number." }, "bIC": { "type": "string", "description": "Bank Identifier Code (SWIFT code)." }, "bankName": { "type": "string", "description": "Name of the bank." }, "accountOwner": { "type": "string", "description": "Name of the account owner." }, "isDefault": { "type": "boolean", "description": "Indicates if this is the default bank account." }, "cardType": { "type": "string", "description": "Type of credit card (e.g. VISA, MasterCard)." }, "cardValidUntil": { "type": "string", "description": "Expiration date of the credit card in format MM/YY." }, "cardVerificationValue": { "type": "string", "description": "Card verification value (CVV) of the credit card." }, "bankCardNumber": { "type": "string", "description": "Credit card number." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.CreateWawiAppCustomer": { "type": "object", "description": "Model Class: CreateWawiAppCustomer ", "additionalProperties": false, "required": [ "CustomerGroup", "Street", "City", "CountryIso2" ], "properties": { "number": { "type": "string", "description": "Customer number." }, "customerGroup": { "description": "Customer group identifier.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "taxIdentificationNumber": { "type": "string", "description": "Tax identification number." }, "birthday": { "type": "string", "description": "Customer's birthday.", "format": "date-time" }, "isBanned": { "type": "boolean", "description": "Indicates if the customer is banned." }, "discount": { "type": "number", "description": "Customer discount percentage.", "format": "decimal" }, "stopPaymentRequest": { "type": "boolean", "description": "Indicates if payment requests are stopped." }, "paymentTarget": { "type": "integer", "description": "Payment target in days.", "format": "int32" }, "paymentMethodKey": { "description": "Payment method key.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "lineOfCredit": { "type": "integer", "description": "Customer's line of credit.", "format": "int32" }, "website": { "type": "string", "description": "Customer's website." }, "source": { "type": "string", "description": "Customer acquisition source." }, "honorific": { "type": "string", "description": "Customer's honorific title." }, "title": { "type": "string", "description": "Customer's academic title." }, "firstName": { "type": "string", "description": "Customer's first name." }, "lastName": { "type": "string", "description": "Customer's last name." }, "company": { "type": "string", "description": "Company name." }, "companyAddition": { "type": "string", "description": "Company name addition." }, "street": { "type": "string", "description": "Street address." }, "additionalAddressInfo": { "type": "string", "description": "Additional address information." }, "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City name." }, "state": { "type": "string", "description": "State or region." }, "countryIso2": { "type": "string", "description": "Country ISO 2-letter code." }, "phoneNumber": { "type": "string", "description": "Phone number." }, "mobilePhoneNumber": { "type": "string", "description": "Mobile phone number." }, "mailAddress": { "type": "string", "description": "Email address." }, "additionalAddresses": { "type": "array", "description": "List of additional addresses for the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.CreateWawiAppAddress" } }, "notes": { "type": "array", "description": "List of notes associated with the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.CreateWawiAppNote" } }, "fields": { "type": "array", "description": "List of customized fields for the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.CreateWawiAppCustomizedField" } }, "bankAccounts": { "type": "array", "description": "List of bank accounts associated with the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.CreateWawiAppBankAccount" } }, "contactPersons": { "type": "array", "description": "List of contact persons for the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.CreateWawiAppCustomerContactPerson" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.CreateWawiAppCustomerContactPerson": { "type": "object", "description": "Model Class: CreateWawiAppCustomerContactPerson ", "additionalProperties": false, "required": [ "KundeKey", "LieferantKey", "Anrede", "Vorname", "Nachname", "Telefon", "Mobil", "Fax", "Email", "Abteilung" ], "properties": { "kundeKey": { "description": "Eindeutige ID des zugehörigen Kunden.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "lieferantKey": { "description": "Eindeutige ID des zugehörigen Lieferanten.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "anrede": { "type": "string", "description": "Anrede des Ansprechpartners." }, "vorname": { "type": "string", "description": "Vorname des Ansprechpartners." }, "nachname": { "type": "string", "description": "Nachname des Ansprechpartners." }, "telefon": { "type": "string", "description": "Telefonnummer des Ansprechpartners." }, "mobil": { "type": "string", "description": "Mobiltelefonnummer des Ansprechpartners." }, "fax": { "type": "string", "description": "Faxnummer des Ansprechpartners." }, "email": { "type": "string", "description": "E-Mail-Adresse des Ansprechpartners." }, "abteilung": { "type": "string", "description": "Abteilung des Ansprechpartners im Unternehmen." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.CreateWawiAppCustomizedField": { "type": "object", "description": "Model Class: CreateWawiAppCustomizedField ", "additionalProperties": false, "required": [ "InternalCustomizedFieldKey", "Value" ], "properties": { "internalCustomizedFieldKey": { "description": "Unique ID to identify a customized field.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EigenesFeldKey" }, "value": { "type": "object", "description": "Value of the customized field." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.CreateWawiAppNote": { "type": "object", "description": "Model Class: CreateWawiAppNote ", "additionalProperties": false, "required": [ "NoteText" ], "properties": { "noteText": { "type": "string", "description": "The text content of the note." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.UpdateWawiAppAddress": { "type": "object", "description": "Model Class: UpdateWawiAppAddress ", "additionalProperties": false, "required": [ "Street", "City", "CountryIso2" ], "properties": { "internalAddressKey": { "description": "Eindeutige ID der Adresse.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AdresseKey" }, "addressType": { "type": "integer", "description": "Art der Adresse (z.B. Rechnungsadresse, Lieferadresse).", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.WawiAppAddressType" }, "isStandard": { "type": "boolean", "description": "Gibt an, ob es sich um die Standardadresse handelt." }, "street": { "type": "string", "description": "Straßenname und Hausnummer." }, "city": { "type": "string", "description": "Name der Stadt." }, "countryIso2": { "type": "string", "description": "ISO 2-stelliger Ländercode." }, "honorific": { "type": "string", "description": "Anrede (z.B. Herr, Frau)." }, "title": { "type": "string", "description": "Akademischer Titel." }, "firstName": { "type": "string", "description": "Vorname." }, "lastName": { "type": "string", "description": "Nachname." }, "company": { "type": "string", "description": "Firmenname." }, "companyAddition": { "type": "string", "description": "Firmenzusatz." }, "additionalAddressInfo": { "type": "string", "description": "Zusätzliche Adressinformationen." }, "state": { "type": "string", "description": "Bundesland oder Region." }, "country": { "type": "string", "description": "Name des Landes." }, "salesTaxIdentificationNumber": { "type": "string", "description": "Umsatzsteuer-Identifikationsnummer." }, "phoneNumber": { "type": "string", "description": "Telefonnummer." }, "mobilePhoneNumber": { "type": "string", "description": "Mobiltelefonnummer." }, "mailAddress": { "type": "string", "description": "E-Mail-Adresse." }, "postalCode": { "type": "string", "description": "Postleitzahl." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.UpdateWawiAppBankAccount": { "type": "object", "description": "Model Class: UpdateWawiAppBankAccount ", "additionalProperties": false, "properties": { "internalBankAccountKey": { "description": "Unique ID to identify a bank account.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KontoDatenKey" }, "accountNumber": { "type": "string", "description": "Bank account number." }, "bankNumber": { "type": "string", "description": "Bank code or routing number." }, "iBAN": { "type": "string", "description": "International Bank Account Number." }, "bIC": { "type": "string", "description": "Bank Identifier Code (SWIFT code)." }, "bankName": { "type": "string", "description": "Name of the bank." }, "accountOwner": { "type": "string", "description": "Name of the account owner." }, "isDefault": { "type": "boolean", "description": "Indicates if this is the default bank account." }, "cardType": { "type": "string", "description": "Type of credit card (e.g. VISA, MasterCard)." }, "cardValidUntil": { "type": "string", "description": "Expiration date of the credit card in format MM/YY." }, "cardVerificationValue": { "type": "string", "description": "Card verification value (CVV) of the credit card." }, "bankCardNumber": { "type": "string", "description": "Credit card number." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.UpdateWawiAppCustomer": { "type": "object", "description": "Model Class: UpdateWawiAppCustomer ", "additionalProperties": false, "properties": { "number": { "type": "string", "description": "Customer number." }, "customerGroup": { "description": "Customer group identifier.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "taxIdentificationNumber": { "type": "string", "description": "Tax identification number." }, "birthday": { "type": "string", "description": "Customer's birthday.", "format": "date-time" }, "isBanned": { "type": "boolean", "description": "Indicates if the customer is banned." }, "discount": { "type": "number", "description": "Customer discount percentage.", "format": "decimal" }, "stopPaymentRequest": { "type": "boolean", "description": "Indicates if payment requests are stopped." }, "paymentTarget": { "type": "integer", "description": "Payment target in days.", "format": "int32" }, "paymentMethodKey": { "description": "Payment method key.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "lineOfCredit": { "type": "integer", "description": "Customer's line of credit.", "format": "int32" }, "website": { "type": "string", "description": "Customer's website." }, "source": { "type": "string", "description": "Customer acquisition source." }, "honorific": { "type": "string", "description": "Customer's honorific title." }, "title": { "type": "string", "description": "Customer's academic title." }, "firstName": { "type": "string", "description": "Customer's first name." }, "lastName": { "type": "string", "description": "Customer's last name." }, "company": { "type": "string", "description": "Company name." }, "companyAddition": { "type": "string", "description": "Company name addition." }, "street": { "type": "string", "description": "Street address." }, "additionalAddressInfo": { "type": "string", "description": "Additional address information." }, "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City name." }, "state": { "type": "string", "description": "State or region." }, "countryIso2": { "type": "string", "description": "Country ISO 2-letter code." }, "phoneNumber": { "type": "string", "description": "Phone number." }, "mobilePhoneNumber": { "type": "string", "description": "Mobile phone number." }, "mailAddress": { "type": "string", "description": "Email address." }, "additionalAddresses": { "type": "array", "description": "List of additional addresses for the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.UpdateWawiAppAddress" } }, "notes": { "type": "array", "description": "List of notes associated with the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.UpdateWawiAppNote" } }, "fields": { "type": "array", "description": "List of customized fields for the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.UpdateWawiAppCustomizedField" } }, "bankAccounts": { "type": "array", "description": "List of bank accounts associated with the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.UpdateWawiAppBankAccount" } }, "contactPersons": { "type": "array", "description": "List of contact persons for the customer.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.UpdateWawiAppCustomerContactPerson" } } } }, "JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.UpdateWawiAppCustomerContactPerson": { "type": "object", "description": "Model Class: UpdateWawiAppCustomerContactPerson ", "additionalProperties": false, "required": [ "KundeKey", "LieferantKey", "Anrede", "Vorname", "Nachname", "Telefon", "Mobil", "Fax", "Email", "Abteilung" ], "properties": { "ansprechpartnerKey": { "description": "Eindeutige ID des Ansprechpartners.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AnsprechpartnerKey" }, "kundeKey": { "description": "Eindeutige ID des zugehörigen Kunden.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "lieferantKey": { "description": "Eindeutige ID des zugehörigen Lieferanten.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey" }, "anrede": { "type": "string", "description": "Anrede des Ansprechpartners." }, "vorname": { "type": "string", "description": "Vorname des Ansprechpartners." }, "nachname": { "type": "string", "description": "Nachname des Ansprechpartners." }, "telefon": { "type": "string", "description": "Telefonnummer des Ansprechpartners." }, "mobil": { "type": "string", "description": "Mobiltelefonnummer des Ansprechpartners." }, "fax": { "type": "string", "description": "Faxnummer des Ansprechpartners." }, "email": { "type": "string", "description": "E-Mail-Adresse des Ansprechpartners." }, "abteilung": { "type": "string", "description": "Abteilung des Ansprechpartners im Unternehmen." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.UpdateWawiAppCustomizedField": { "type": "object", "description": "Model Class: UpdateWawiAppCustomizedField ", "additionalProperties": false, "required": [ "InternalCustomizedFieldKey" ], "properties": { "internalCustomizedFieldKey": { "description": "Unique ID to identify a customized field.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.EigenesFeldKey" }, "value": { "type": "object", "description": "Value of the customized field." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.UpdateWawiAppNote": { "type": "object", "description": "Model Class: UpdateWawiAppNote ", "additionalProperties": false, "required": [ "NoteText" ], "properties": { "internalNoteKey": { "description": "Unique ID to identify a note.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.NotizKey" }, "noteText": { "type": "string", "description": "The text content of the note." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.WawiAppAddressType": { "type": "integer", "description": "0 = ShippingAddress, 1 = BillingAddress, 2 = Other", "format": "int32", "x-enumNames": [ "ShippingAddress", "BillingAddress", "Other" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Rest.Contracts.Models.V2.WawiApp.WawiAppCustomer": { "type": "object", "description": "Model Class: WawiAppCustomer ", "additionalProperties": false, "required": [ "InternalCustomerKey", "Number", "CustomerGroup", "TaxIdentificationNumber", "Birthday", "IsBanned", "Discount", "StopPaymentRequest", "PaymentTarget", "PaymentMethodKey", "LineOfCredit", "Website", "Source", "Honorific", "Title", "FirstName", "LastName", "Company", "CompanyAddition", "Street", "AdditionalAddressInfo", "PostalCode", "City", "State", "CountryIso2", "PhoneNumber", "MobilePhoneNumber", "MailAddress" ], "properties": { "internalCustomerKey": { "description": "Unique ID to identify a customer.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "number": { "type": "string", "description": "Customer number." }, "customerGroup": { "description": "Customer group identifier.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey" }, "taxIdentificationNumber": { "type": "string", "description": "Tax identification number." }, "birthday": { "type": "string", "description": "Customer's birthday.", "format": "date-time" }, "isBanned": { "type": "boolean", "description": "Indicates if the customer is banned." }, "discount": { "type": "number", "description": "Customer discount percentage.", "format": "decimal" }, "stopPaymentRequest": { "type": "boolean", "description": "Indicates if payment requests are stopped." }, "paymentTarget": { "type": "integer", "description": "Payment target in days.", "format": "int32" }, "paymentMethodKey": { "description": "Payment method key.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "lineOfCredit": { "type": "integer", "description": "Customer's line of credit.", "format": "int32" }, "website": { "type": "string", "description": "Customer's website." }, "source": { "type": "string", "description": "Customer acquisition source." }, "honorific": { "type": "string", "description": "Customer's honorific title." }, "title": { "type": "string", "description": "Customer's academic title." }, "firstName": { "type": "string", "description": "Customer's first name." }, "lastName": { "type": "string", "description": "Customer's last name." }, "company": { "type": "string", "description": "Company name." }, "companyAddition": { "type": "string", "description": "Company name addition." }, "street": { "type": "string", "description": "Street address." }, "additionalAddressInfo": { "type": "string", "description": "Additional address information." }, "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City name." }, "state": { "type": "string", "description": "State or region." }, "countryIso2": { "type": "string", "description": "Country ISO 2-letter code." }, "phoneNumber": { "type": "string", "description": "Phone number." }, "mobilePhoneNumber": { "type": "string", "description": "Mobile phone number." }, "mailAddress": { "type": "string", "description": "Email address." } } }, "JTL.Wawi.Rest.Contracts.Models.V2.WMS.PickListPosition": { "type": "object", "description": "Model Class: PickListPosition ", "additionalProperties": false, "required": [ "Id", "WarehouseId", "PicklistId", "StorageLocationId", "ItemId", "Quantity", "Status", "Priority", "SalesOrderLineItemId", "CreatedAt" ], "properties": { "id": { "description": "Id of the pick list position.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PicklistePosKey" }, "warehouseId": { "description": "Id of the warehouse.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "picklistId": { "description": "Id of the pick list.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.PicklisteKey" }, "storageLocationId": { "description": "Id of the storage location from where the pick should happen.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" }, "itemId": { "description": "Id of the item.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "quantity": { "type": "number", "description": "Quantity to pick.", "format": "decimal" }, "status": { "description": "Status of the position.", "$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.WMS.PickListStatus" }, "priority": { "type": "integer", "description": "Priority of the position.", "format": "int32" }, "salesOrderLineItemId": { "description": "Id of the corresponding order position.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "createdAt": { "type": "string", "description": "Time when the pick list was created.", "format": "date-time" } } }, "JTL.Wawi.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey": { "type": "string", "description": "Schlüssel für einen Nummernkreis Datensatz", "format": "uuid", "additionalProperties": false }, "JTL.Wawi.Stammdaten.PublicApi.DataTransferObjects.V2.Languages.ActivateLanguageCommandRequest": { "type": "object", "description": "Activates a language in the system - Request", "additionalProperties": false, "required": [ "CultureOrIso" ], "properties": { "cultureOrIso": { "type": "string", "description": "The culture or ISO code of the language to be activated." } } }, "JTL.Wawi.Stammdaten.PublicApi.DataTransferObjects.V2.Languages.DeactivateLanguageCommandRequest": { "type": "object", "description": "Deactivates a language in the system - Request", "additionalProperties": false, "required": [ "CultureOrIso" ], "properties": { "cultureOrIso": { "type": "string", "description": "The culture or ISO code of the language to be deactivate." } } }, "JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.CreateTaxClassCommandRequest": { "type": "object", "description": "Creates a new tax class in the system - Request", "additionalProperties": false, "required": [ "IsStandard", "Name", "TaxType" ], "properties": { "isStandard": { "type": "boolean", "description": "Whether this tax class is the standard tax class. Setting this to true will set all other tax classes to non-standard." }, "name": { "type": "string", "description": "The name of the new tax class" }, "taxType": { "description": "The type of the tax class", "$ref": "#/components/schemas/JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.TaxType" } } }, "JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.CreateTaxCodeCommandRequest": { "type": "object", "description": "Creates a new tax code in the system - Request", "additionalProperties": false, "required": [ "CashDiscountAccount", "GeneralLedgerAccount", "IsAutomatic", "Name" ], "properties": { "cashDiscountAccount": { "type": "string", "description": "The cash discount account of the new tax code" }, "generalLedgerAccount": { "type": "string", "description": "The general ledger account of the new tax code" }, "isAutomatic": { "type": "boolean", "description": "Whether this tax code is automatic" }, "name": { "type": "string", "description": "The name of the new tax code" }, "number": { "type": "integer", "description": "The number of the new tax code. If not provided, a number will be auto-assigned.", "format": "int32" } } }, "JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.DeleteTaxClassCommandRequest": { "type": "object", "description": "Deletes an existing tax class - Request", "additionalProperties": false, "properties": { "id": { "description": "The ID of the tax class to delete", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey" } } }, "JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.DeleteTaxCodeCommandRequest": { "type": "object", "description": "Deletes an existing tax code - Request", "additionalProperties": false, "properties": { "id": { "description": "The ID of the tax code to delete", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerschluesselKey" } } }, "JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.TaxDomainSpecialTaxTreatment": { "type": "integer", "description": "0 = None, 1 = ReverseCharge, 2 = ExemptFromVat, 3 = SubjectToVat", "format": "int32", "x-enumNames": [ "None", "ReverseCharge", "ExemptFromVat", "SubjectToVat" ], "enum": [ 0, 1, 2, 3 ] }, "JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.TaxDomainTaxReference": { "type": "integer", "description": "0 = ShipmentAddress, 1 = BillingAddress", "format": "int32", "x-enumNames": [ "ShipmentAddress", "BillingAddress" ], "enum": [ 0, 1 ] }, "JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.TaxType": { "type": "integer", "description": "0 = None, 1 = SuperReduced, 2 = ReducedLow, 3 = Reduced, 4 = Standard, 5 = Intermediate", "format": "int32", "x-enumNames": [ "None", "SuperReduced", "ReducedLow", "Reduced", "Standard", "Intermediate" ], "enum": [ 0, 1, 2, 3, 4, 5 ] }, "JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.UpdateTaxClassCommandRequest": { "type": "object", "description": "Updates an existing tax class - Request", "additionalProperties": false, "required": [ "Id" ], "properties": { "id": { "description": "The ID of the tax class to update", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey" }, "isStandard": { "type": "boolean", "description": "Whether this tax class is the standard tax class. Setting this to true will set all other tax classes to non-standard." }, "name": { "type": "string", "description": "The name of the tax class" }, "taxType": { "type": "integer", "description": "The type of the tax class", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.TaxType" } } }, "JTL.Wawi.Taxes.PublicApi.DataTransferObjects.V2.TaxDomain.UpdateTaxCodeCommandRequest": { "type": "object", "description": "Updates an existing tax code - Request", "additionalProperties": false, "required": [ "Id" ], "properties": { "id": { "description": "The ID of the tax code to update", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerschluesselKey" }, "cashDiscountAccount": { "type": "string", "description": "The cash discount account of the tax code" }, "generalLedgerAccount": { "type": "string", "description": "The general ledger account of the tax code" }, "isAutomatic": { "type": "boolean", "description": "Whether this tax code is automatic" }, "name": { "type": "string", "description": "The name of the tax code" }, "number": { "type": "integer", "description": "The number of the tax code. Can only be changed when the tax code is not referenced.", "format": "int32" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesInvoiceCorrectionDomain.CancelSalesInvoiceCorrectionCommandRequest": { "type": "object", "description": "Cancel a sales invoice correction - Request", "additionalProperties": false, "required": [ "SalesInvoiceCorrectionId", "CancellationReasonId" ], "properties": { "salesInvoiceCorrectionId": { "description": "The ID of the sales invoice correction to cancel.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.GutschriftKey" }, "cancellationReasonId": { "description": "The reason for cancelling the sales invoice correction.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.GutschriftStornogrundKey" }, "cancellationComment": { "type": "string", "description": "An optional comment explaining the cancellation." } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesInvoiceCorrectionDomain.CreateSalesInvoiceCorrectionCommandRequest": { "type": "object", "description": "Create a new sales invoice correction from an existing invoice - Request", "additionalProperties": false, "required": [ "SalesInvoiceId" ], "properties": { "salesInvoiceId": { "description": "The ID of the sales invoice to create the correction for.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungKey" }, "asDraft": { "type": "boolean", "description": "Indicates if the sales invoice correction should be created as draft." }, "useUndeliveredQuantities": { "type": "boolean", "description": "Indicates if only undelivered quantities should be used." }, "disableAutomaticWorkflows": { "type": "boolean", "description": "If true, the workflows do not trigger automatic." }, "reduceSalesOrderQuantities": { "type": "boolean", "description": "If true, the sales order quantities will be reduced." }, "reduceDeliveryQuantities": { "type": "boolean", "description": "If true, the delivery quantities will be reduced." }, "cancelWebShopOrder": { "type": "boolean", "description": "If true, the web shop order will be canceled" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesInvoiceDomain.CancelSalesInvoiceCommandRequest": { "type": "object", "description": "Cancel a sales invoice - Request", "additionalProperties": false, "required": [ "SalesInvoiceId", "CancellationReasonId" ], "properties": { "salesInvoiceId": { "description": "The ID of the sales invoice to cancel.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungKey" }, "cancellationReasonId": { "description": "The reason for cancelling the invoice.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RechnungStornogrundKey" }, "cancellationComment": { "type": "string", "description": "An optional comment explaining the cancellation." } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesInvoiceDomain.CreateSalesInvoiceCommandRequest": { "type": "object", "description": "Create a new sales invoice for a salesorder - Request", "additionalProperties": false, "required": [ "SalesOrderId" ], "properties": { "salesOrderId": { "description": "The ID of the sales order to create the invoice for.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "invoiceOnlyDeliveredQuantity": { "type": "boolean", "description": "If true, only the delivered quantities of the sales order line items are added to the new invoice." }, "asDraft": { "type": "boolean", "description": "If true, the invoice will be created as a draft. An invoice draft has no invoice number yet and can be edited until finalized." } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CalculateSalesOrderCommandRequest": { "type": "object", "description": "Calculate prices, discounts, and taxes for a sales order without persisting it. - Request", "additionalProperties": false, "required": [ "CalculateSalesOrderRequest", "RecalculateTaxMode", "Changes" ], "properties": { "calculateSalesOrderRequest": { "description": "The sales order calculation request model in the original state before any changes.", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCalculateSalesOrderRequest" }, "recalculateTaxMode": { "description": "The mode for tax recalculation (NoRecalculation, KeepNetPrices, KeepGrossPrices).", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.RecalculateTaxMode" }, "changes": { "type": "array", "description": "The history of changes made to the sales order request. Changes are processed in the order specified.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCalculateSalesOrderRequestChange" } } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCalculateSalesOrderAddress": { "type": "object", "description": "Address information for sales order calculation (tax determination).", "additionalProperties": false, "required": [ "CountryIso" ], "properties": { "countryIso": { "type": "string", "description": "The ISO code of the address country for tax calculation." }, "state": { "type": "string", "description": "The state of the address for tax calculation." }, "vatId": { "type": "string", "description": "The VAT ID of the address for tax calculation." } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCalculateSalesOrderLineItemRequest": { "type": "object", "description": "Request model for a sales order line item calculation.", "additionalProperties": false, "required": [ "SyncNumber", "Quantity" ], "properties": { "syncNumber": { "type": "integer", "description": "The synchronization identifier for the line item. Must be unique and greater than 0. This ID is assigned by the client and remains constant.", "format": "int32" }, "itemId": { "description": "The unique identifier of the item/article. If omitted, a free-text position is created.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "quantity": { "type": "number", "description": "The quantity of the item. Must be greater than 0.", "format": "decimal" }, "salesPriceNet": { "type": "number", "description": "Manual override for the net sales price per unit. If set, overrides the calculated price. Cannot be set simultaneously with SalesPriceGross.", "format": "decimal" }, "salesPriceGross": { "type": "number", "description": "Manual override for the gross sales price per unit. When set, the net price is recalculated. Cannot be set simultaneously with SalesPriceNet.", "format": "decimal" }, "discountPercent": { "type": "number", "description": "The discount percentage for the line item (e.g., 10.0 for 10% discount).", "format": "decimal" }, "taxClassId": { "description": "The tax class identifier for this line item. If set, overrides the automatically determined tax class.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey" }, "parentSyncNumber": { "type": "integer", "description": "The SyncNumber of the parent line item. Used to assign configuration components to their parent configuration item.", "format": "int32" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCalculateSalesOrderLineItemRequestChange": { "type": "object", "description": "Represents a change to apply to an existing line item.", "additionalProperties": false, "required": [ "SyncNumber" ], "properties": { "syncNumber": { "type": "integer", "description": "The synchronization identifier for the line item to update.", "format": "int32" }, "quantity": { "type": "number", "description": "The quantity of the item.", "format": "decimal" }, "salesPriceNet": { "type": "number", "description": "Manual override for the net sales price per unit. Cannot be set simultaneously with SalesPriceGross.", "format": "decimal" }, "salesPriceGross": { "type": "number", "description": "Manual override for the gross sales price per unit. When set, the net price is recalculated. Cannot be set simultaneously with SalesPriceNet.", "format": "decimal" }, "discountPercent": { "type": "number", "description": "The discount percentage for the line item (e.g., 10.0 for 10% discount).", "format": "decimal" }, "taxClassId": { "description": "The tax class identifier for this line item. If set, overrides the automatically determined tax class.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCalculateSalesOrderLineItemRequestChangeSet": { "type": "object", "description": "Represents a set of changes to apply to line items.", "additionalProperties": false, "properties": { "create": { "type": "array", "description": "The list of new line items to create.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCalculateSalesOrderLineItemRequest" } }, "update": { "type": "array", "description": "The list of existing line items to update.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCalculateSalesOrderLineItemRequestChange" } }, "delete": { "type": "array", "description": "The list of sync numbers of line items to delete.", "items": { "type": "integer", "format": "int32" } } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCalculateSalesOrderRequest": { "type": "object", "description": "Request model for calculating prices, discounts, taxes, and shipping costs for a sales order.", "additionalProperties": false, "required": [ "CompanyId", "CustomerId", "LineItems", "DepartureCountryIso" ], "properties": { "companyId": { "description": "The unique identifier of the company for the sales order.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "customerId": { "description": "The unique identifier of the customer for whom the sales order is being calculated.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "shippingMethodId": { "description": "The shipping method ID for shipping cost calculation and tax determination.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey" }, "shopId": { "description": "The shop ID for shop-specific price calculation.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey" }, "billingAddress": { "description": "The billing address information for tax calculation.", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCalculateSalesOrderAddress" }, "shipmentAddress": { "description": "The shipment address information for tax calculation.", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCalculateSalesOrderAddress" }, "lineItems": { "type": "array", "description": "The list of sales order line items to be calculated.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCalculateSalesOrderLineItemRequest" } }, "currencyIso": { "type": "string", "description": "The ISO code of the currency for price calculation (e.g., EUR, USD). If not specified, the default currency will be used." }, "currencyFactor": { "type": "number", "description": "Manual override for the currency conversion factor. If set (greater than 0), overrides the default factor from the currency settings.", "format": "decimal" }, "departureCountryIso": { "type": "string", "description": "The ISO code of the departure country for tax calculation." }, "departureCountryStateCode": { "type": "string", "description": "The departure country state/region code for state-level tax calculation (e.g., US states like CA, NY)." }, "extraWeight": { "type": "number", "description": "Additional weight in kg to add to the order for shipping cost calculation.", "format": "decimal" }, "specialTaxTreatment": { "type": "integer", "description": "The tax special treatment mode for the sales order (e.g., ReverseCharge, TaxExempt).", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.SpecialTaxTreatment" }, "taxReference": { "type": "integer", "description": "The tax reference of the sales order. This setting controls which data is used during tax calculation.", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.TaxReference" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCalculateSalesOrderRequestChange": { "type": "object", "description": "Represents a change to apply to the sales order calculation request.", "additionalProperties": false, "properties": { "companyId": { "description": "The company ID to use for the calculation.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "customerId": { "description": "The customer ID to use for the calculation.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "shippingMethodId": { "description": "The shipping method ID to use for the calculation.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey" }, "billingAddress": { "description": "The billing address information for tax calculation.", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCalculateSalesOrderAddress" }, "shipmentAddress": { "description": "The shipment address information for tax calculation.", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCalculateSalesOrderAddress" }, "lineItemChanges": { "description": "The line item changes to apply.", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCalculateSalesOrderLineItemRequestChangeSet" }, "currencyIso": { "type": "string", "description": "The ISO code of the currency for price calculation." }, "currencyFactor": { "type": "number", "description": "Manual override for the currency conversion factor.", "format": "decimal" }, "departureCountryIso": { "type": "string", "description": "The ISO code of the departure country for tax calculation." }, "departureCountryStateCode": { "type": "string", "description": "The departure country state/region code for state-level tax calculation." }, "extraWeight": { "type": "number", "description": "Additional weight in kg to add to the order for shipping cost calculation.", "format": "decimal" }, "specialTaxTreatment": { "type": "integer", "description": "The tax special treatment mode for the sales order.", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.SpecialTaxTreatment" }, "taxReference": { "type": "integer", "description": "The tax reference of the sales order. This setting controls which data is used during tax calculation.", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.TaxReference" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderAddress": { "type": "object", "description": "Address details for the sales order.", "additionalProperties": false, "required": [ "Street", "City", "CountryIso" ], "properties": { "salutation": { "type": "string", "description": "The SalesOrderAddress Salutation" }, "title": { "type": "string", "description": "The SalesOrderAddress Title" }, "firstName": { "type": "string", "description": "The SalesOrderAddress FirstName" }, "lastName": { "type": "string", "description": "The SalesOrderAddress LastName" }, "company": { "type": "string", "description": "The SalesOrderAddress Company" }, "additionalCompanyLine": { "type": "string", "description": "The SalesOrderAddress AdditionalCompanyLine" }, "street": { "type": "string", "description": "The SalesOrderAddress Street" }, "additionalAddressLine": { "type": "string", "description": "The SalesOrderAddress AdditionalAddressLine" }, "city": { "type": "string", "description": "The SalesOrderAddress City" }, "postalCode": { "type": "string", "description": "The SalesOrderAddress PostalCode" }, "state": { "type": "string", "description": "The SalesOrderAddress State" }, "countryIso": { "type": "string", "description": "The SalesOrderAddress CountryISO", "maxLength": 2, "minLength": 2 }, "postId": { "type": "string", "description": "The SalesOrderAddress PostId" }, "emailAddress": { "type": "string", "description": "The SalesOrderAddress EmailAddress" }, "phoneNumber": { "type": "string", "description": "The SalesOrderAddress PhoneNumber" }, "mobilePhoneNumber": { "type": "string", "description": "The SalesOrderAddress MobilePhoneNumber" }, "fax": { "type": "string", "description": "The SalesOrderAddress Fax" }, "vatId": { "type": "string", "description": "The SalesOrderAddress VAT ID" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderDepartureCountry": { "type": "object", "description": "Defines the departure country information for a sales order during its creation.", "additionalProperties": false, "required": [ "CountryIso", "CurrencyIso" ], "properties": { "countryIso": { "type": "string", "description": "The ISO code of the departure country.", "maxLength": 2, "minLength": 2 }, "currencyIso": { "type": "string", "description": "The sales order departure country currency iso", "maxLength": 3, "minLength": 3 }, "currencyFactor": { "type": "number", "description": "The sales order departure country currency factor", "format": "decimal" }, "state": { "type": "string", "description": "The SalesOrder State" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderExternalDetails": { "type": "object", "description": "External details for the sales order.", "additionalProperties": false, "properties": { "externalCreatedDate": { "type": "string", "description": "The SalesOrder ExternalCreatedDate", "format": "date-time" }, "externalInvoiceType": { "type": "integer", "description": "The SalesOrder ExternalInvoiceType", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ExternalSalesInvoiceType" }, "externalSalesOrderNumber": { "type": "string", "description": "The SalesOrder ExternalSalesOrderNumber" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderLineItem": { "type": "object", "description": "Line item details for the new sales order.", "additionalProperties": false, "properties": { "itemId": { "description": "Unique ID to identify an item.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "parentSalesOrderLineItemId": { "description": "The SalesOrderLineItem ParentSalesOrderLineItemId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "taxClassId": { "description": "The SalesOrderLineItem TaxClassId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey" }, "taxCodeId": { "description": "The SalesOrderLineItem TaxCodeId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerschluesselKey" }, "billOfMaterialsType": { "type": "integer", "description": "The SalesOrderLineItem BillOfMaterialsType", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.BillOfMaterialsType" }, "configurationItemType": { "type": "integer", "description": "The SalesOrderLineItem ConfigurationItemType", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ConfigurationItemType" }, "discountPercent": { "type": "number", "description": "The discount of the line item.", "format": "decimal" }, "fnSku": { "type": "string", "description": "The SalesOrderLineItem FNSKU" }, "name": { "type": "string", "description": "Name of the position." }, "note": { "type": "string", "description": "The SalesOrderLineItem Note" }, "purchasePriceNet": { "type": "number", "description": "The purchase price of the item.", "format": "decimal" }, "quantity": { "type": "number", "description": "The quantity of the line item.", "format": "decimal" }, "salesPriceNet": { "type": "number", "description": "The net sales price of the item. Only net or gross price can be entered. The other price will then be calculated.", "format": "decimal" }, "salesUnit": { "type": "string", "description": "The sales unit of the line item." }, "sku": { "type": "string", "description": "SKU of the sales order line item." }, "taxRate": { "type": "number", "description": "The tax rate of the line item.", "format": "decimal" }, "type": { "type": "integer", "description": "The SalesOrderLineItem LineItemType", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.LineItemType" }, "variants": { "type": "array", "description": "List of SalesOrderLineItemVariant", "items": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderLineItemVariant" } } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderLineItemVariant": { "type": "object", "description": "Sales order line item variant details.", "additionalProperties": false, "required": [ "Name", "ItemVariantId" ], "properties": { "extraWeight": { "type": "number", "description": "The SalesOrderLineItemVariant ExtraWeight", "format": "decimal" }, "name": { "type": "string", "description": "The SalesOrderLineItemVariant Name" }, "surchargeNet": { "type": "number", "description": "The SalesOrderLineItemVariant SurchargeNet", "format": "decimal" }, "value": { "type": "string", "description": "The SalesOrderLineItemVariant Value" }, "itemVariantId": { "description": "The SalesOrderLineItemVariant ItemVariantId", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey" }, "itemVariantValueId": { "description": "The SalesOrderLineItemVariant ItemVariantValueId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationWertKey" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderPaymentDetails": { "type": "object", "description": "Payment details for the new sales order.", "additionalProperties": false, "required": [ "CurrencyIso" ], "properties": { "cashDiscount": { "type": "number", "description": "The SalesOrder CashDiscount", "format": "decimal" }, "cashDiscountDays": { "type": "integer", "description": "The SalesOrder CashDiscountDays", "format": "int32" }, "paymentDueDateInDays": { "type": "integer", "description": "The SalesOrder PaymentDueDateInDays", "format": "int32" }, "currencyIso": { "type": "string", "description": "The sales order departure country currency iso", "maxLength": 3, "minLength": 3 }, "currencyFactor": { "type": "number", "description": "The sales order departure country currency factor", "format": "decimal" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderPaymentInfo": { "type": "object", "description": "Payment info for the new sales order.", "additionalProperties": false, "properties": { "accountHolder": { "type": "string", "description": "The SalesOrderPaymentInfo AccountHolder" }, "bankName": { "type": "string", "description": "The SalesOrderPaymentInfo BankName" }, "bIC": { "type": "string", "description": "The SalesOrderPaymentInfo BIC" }, "creditorId": { "type": "string", "description": "The SalesOrderPaymentInfo CreditorId" }, "dueDate": { "type": "string", "description": "The SalesOrderPaymentInfo DueDate", "format": "date-time" }, "endToEndId": { "type": "string", "description": "The SalesOrderPaymentInfo EndToEndId" }, "iBAN": { "type": "string", "description": "The SalesOrderPaymentInfo IBAN" }, "mandateReference": { "type": "string", "description": "The SalesOrderPaymentInfo MandateReference" }, "paymentInfo": { "type": "string", "description": "The SalesOrderPaymentInfo PaymentInfo" }, "paymentReference": { "type": "string", "description": "The SalesOrderPaymentInfo PaymentReference" }, "referenceEmail": { "type": "string", "description": "The SalesOrderPaymentInfo ReferenceEmail" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderShippingDetails": { "type": "object", "description": "Shipping details for the new sales order.", "additionalProperties": false, "properties": { "deliveryFromDate": { "type": "string", "description": "The SalesOrder DeliveryFromDate", "format": "date-time" }, "estimatedDeliveryDate": { "type": "string", "description": "The SalesOrder EstimatedDeliveryDate", "format": "date-time" }, "extraWeight": { "type": "number", "description": "The SalesOrder ExtraWeight", "format": "decimal" }, "maxDeliveryDays": { "type": "integer", "description": "The SalesOrder MaxDeliveryDays", "format": "int32" }, "shippingDate": { "type": "string", "description": "The SalesOrder ShippingDate", "format": "date-time" }, "shippingPriority": { "type": "integer", "description": "The SalesOrder ShippingPriority", "format": "int32" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderTaxDetails": { "type": "object", "description": "Tax details for the new sales order.", "additionalProperties": false, "properties": { "taxReference": { "type": "integer", "description": "The SalesOrder TaxReference. This setting controls which data is used during tax calculation.", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.TaxReference" }, "specialTaxTreatment": { "type": "integer", "description": "The SalesOrder SpecialTaxTreatment", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.SpecialTaxTreatment" }, "taxSetting": { "type": "integer", "description": "The SalesOrder TaxSetting", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.TaxSetting" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderText": { "type": "object", "description": "Tax details for the new sales order.", "additionalProperties": false, "properties": { "comment": { "type": "string", "description": "The SalesOrderText Comment" }, "customerComment": { "type": "string", "description": "The SalesOrderText CustomerComment" }, "printText": { "type": "string", "description": "The SalesOrderText PrintText" }, "processStatus": { "type": "string", "description": "The SalesOrderText ProcessStatus" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateSalesOrderCommandRequest": { "type": "object", "description": "Creates a new sales order. - Request", "additionalProperties": false, "required": [ "CompanyId", "CustomerId", "BillingAddress", "DepartureCountry", "LineItems", "PaymentDetails", "LanguageIso", "VatId" ], "properties": { "disableAutomaticWorkflows": { "type": "boolean", "description": "Indicates whether automatic workflows should be disabled for this sales order." }, "useBillingAddressAsShipmentAddress": { "type": "boolean", "description": "Indicates whether the billing address should be used as the shipment address. If no shipment address is provided and the flag ist not set, the billing address will also be used as shipment address. If the shipment address is provided, this flag will be ignored." }, "cartonItemId": { "description": "The SalesOrder CartonItemId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "companyId": { "description": "The SalesOrder CompanyId", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "customerId": { "description": "The customer ID.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "onHoldReasonId": { "description": "The SalesOrder OnHoldReasonId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RueckhaltegrundKey" }, "paymentMethodId": { "description": "The SalesOrder PaymentMethodId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "processColourId": { "description": "The SalesOrder ProcessColourId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FarbeKey" }, "processStatusId": { "description": "The SalesOrder ProcessStatusId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VorgangsstatusKey" }, "billingAddress": { "description": "SalesOrderBillingAddress", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderAddress" }, "departureCountry": { "description": "DepartureCountry", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderDepartureCountry" }, "externalDetails": { "description": "ExternalDetails", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderExternalDetails" }, "lineItems": { "type": "array", "description": "List of SalesOrderLineItem", "items": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderLineItem" } }, "paymentDetails": { "description": "PaymentDetails", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderPaymentDetails" }, "paymentInfo": { "description": "SalesOrderPaymentInfo", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderPaymentInfo" }, "shipmentAddress": { "description": "SalesOrderShipmentAddress", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderAddress" }, "shippingDetails": { "description": "ShippingDetails", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderShippingDetails" }, "taxDetails": { "description": "TaxDetails", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderTaxDetails" }, "text": { "description": "SalesOrderText", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.CreateCreateSalesOrderText" }, "customerSalesOrderNumber": { "type": "string", "description": "The SalesOrder CustomerSalesOrderNumber" }, "itemDescriptionType": { "type": "integer", "description": "The SalesOrder ItemDescriptionType", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ItemDescriptionType" }, "languageIso": { "type": "string", "description": "The SalesOrder LanguageISO", "maxLength": 5, "minLength": 2 }, "readOnlyType": { "type": "integer", "description": "The SalesOrder ReadOnlyType", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ReadOnlyType" }, "salesOrderDate": { "type": "string", "description": "The SalesOrder Date", "format": "date-time" }, "salesOrderNumber": { "type": "string", "description": "The SalesOrder SalesOrderNumber" }, "shippingMethodId": { "description": "The SalesOrder ShippingMethodId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey" }, "vatId": { "type": "string", "description": "The SalesOrder VATId" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.RecalculateTaxMode": { "type": "integer", "description": "0 = NoRecalculation, 1 = KeepNetPrices, 2 = KeepGrossPrices", "format": "int32", "x-enumNames": [ "NoRecalculation", "KeepNetPrices", "KeepGrossPrices" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.UpdateSalesOrderCommandRequest": { "type": "object", "description": "Modifies an existing sales order. - Request", "additionalProperties": false, "required": [ "SalesOrderId" ], "properties": { "salesOrderId": { "description": "Unique ID of the sales order to be modified.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "companyId": { "description": "Unique ID of the company.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "customerId": { "description": "The ID of the customer associated with the sales order.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "billingAddress": { "description": "SalesOrderBillingAddress", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.UpdateUpdateSalesOrderAddress" }, "shipmentAddress": { "description": "SalesOrderBillingAddress", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.UpdateUpdateSalesOrderAddress" }, "shippingMethodId": { "description": "The ID of the shipping method for the sales order.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey" }, "paymentMethodId": { "description": "The ID of the payment method for the sales order.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "lineItems": { "type": "array", "description": "The line items included in the sales order.", "items": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.UpdateUpdateSalesOrderLineItem" } } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.UpdateUpdateSalesOrderAddress": { "type": "object", "description": "address details for the sales order.", "additionalProperties": false, "properties": { "salutation": { "type": "string", "description": "The SalesOrderAddress Salutation" }, "title": { "type": "string", "description": "The SalesOrderAddress Title" }, "firstName": { "type": "string", "description": "The SalesOrderAddress FirstName" }, "lastName": { "type": "string", "description": "The SalesOrderAddress LastName" }, "company": { "type": "string", "description": "The SalesOrderAddress Company" }, "additionalCompanyLine": { "type": "string", "description": "The SalesOrderAddress AdditionalCompanyLine" }, "street": { "type": "string", "description": "The SalesOrderAddress Street" }, "additionalAddressLine": { "type": "string", "description": "The SalesOrderAddress AdditionalAddressLine" }, "city": { "type": "string", "description": "The SalesOrderAddress City" }, "postalCode": { "type": "string", "description": "The SalesOrderAddress PostalCode" }, "state": { "type": "string", "description": "The SalesOrderAddress State" }, "countryIso": { "type": "string", "description": "The SalesOrderAddress CountryISO" }, "postId": { "type": "string", "description": "The SalesOrderAddress PostId" }, "emailAddress": { "type": "string", "description": "The SalesOrderAddress EmailAddress" }, "phoneNumber": { "type": "string", "description": "The SalesOrderAddress PhoneNumber" }, "mobilePhoneNumber": { "type": "string", "description": "The SalesOrderAddress MobilePhoneNumber" }, "fax": { "type": "string", "description": "The SalesOrderAddress Fax" }, "vatId": { "type": "string", "description": "The SalesOrderAddress VAT ID" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.UpdateUpdateSalesOrderLineItem": { "type": "object", "description": "Line item details for the sales order line item to be modified.", "additionalProperties": false, "properties": { "salesOrderLineItemId": { "description": "Unique ID of the sales order line item to be modified.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "taxClassId": { "description": "The SalesOrderLineItem TaxClassId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey" }, "taxCodeId": { "description": "The SalesOrderLineItem TaxCodeId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerschluesselKey" }, "discountPercent": { "type": "number", "description": "The discount of the line item.", "format": "decimal" }, "itemId": { "description": "Unique ID to identify an item.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "name": { "type": "string", "description": "Name of the position." }, "note": { "type": "string", "description": "The SalesOrderLineItem Note" }, "quantity": { "type": "number", "description": "The quantity of the line item.", "format": "decimal" }, "salesPriceNet": { "type": "number", "description": "The net sales price of the item. Only net or gross price can be entered. The other price will then be calculated.", "format": "decimal" }, "salesUnit": { "type": "string", "description": "The sales unit of the line item." }, "sku": { "type": "string", "description": "SKU of the sales order line item." }, "taxRate": { "type": "number", "description": "The tax rate of the line item.", "format": "decimal" }, "type": { "type": "integer", "description": "The SalesOrderLineItem LineItemType", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.LineItemType" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CancelSalesQuotationCommandRequest": { "type": "object", "description": "Cancel a sales quotation - Request", "additionalProperties": false, "required": [ "SalesQuotationId", "CancellationReasonId" ], "properties": { "salesQuotationId": { "description": "The ID of the sales quotation to cancel.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" }, "cancellationReasonId": { "description": "The reason for cancelling the quotation.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AuftragStornogrundKey" }, "cancellationComment": { "type": "string", "description": "An optional comment explaining the cancellation." } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationAddress": { "type": "object", "description": "Billing address details for the sales quotation.", "additionalProperties": false, "required": [ "Street", "City", "CountryIso" ], "properties": { "salutation": { "type": "string", "description": "The SalesQuotationAddress Salutation" }, "title": { "type": "string", "description": "The SalesQuotationAddress Title" }, "firstName": { "type": "string", "description": "The SalesQuotationAddress FirstName" }, "lastName": { "type": "string", "description": "The SalesQuotationAddress LastName" }, "company": { "type": "string", "description": "The SalesQuotationAddress Company" }, "additionalCompanyLine": { "type": "string", "description": "The SalesQuotationAddress AdditionalCompanyLine" }, "street": { "type": "string", "description": "The SalesQuotationAddress Street" }, "additionalAddressLine": { "type": "string", "description": "The SalesQuotationAddress AdditionalAddressLine" }, "city": { "type": "string", "description": "The SalesQuotationAddress City" }, "postalCode": { "type": "string", "description": "The SalesQuotationAddress PostalCode" }, "state": { "type": "string", "description": "The SalesQuotationAddress State" }, "countryIso": { "type": "string", "description": "The SalesQuotationAddress CountryISO", "maxLength": 2, "minLength": 2 }, "postId": { "type": "string", "description": "The SalesQuotationAddress PostId" }, "emailAddress": { "type": "string", "description": "The SalesQuotationAddress EmailAddress" }, "phoneNumber": { "type": "string", "description": "The SalesQuotationAddress PhoneNumber" }, "mobilePhoneNumber": { "type": "string", "description": "The SalesQuotationAddress MobilePhoneNumber" }, "fax": { "type": "string", "description": "The SalesQuotationAddress Fax" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationDepartureCountry": { "type": "object", "description": "Defines the departure country information for a sales quotation during its creation.", "additionalProperties": false, "required": [ "CountryIso", "CurrencyIso" ], "properties": { "countryIso": { "type": "string", "description": "The ISO code of the departure country.", "maxLength": 2, "minLength": 2 }, "currencyIso": { "type": "string", "description": "The sales quotation departure country currency iso", "maxLength": 3, "minLength": 3 }, "currencyFactor": { "type": "number", "description": "The sales quotation departure country currency factor", "format": "decimal" }, "state": { "type": "string", "description": "The SalesQuotation State" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationExternalDetails": { "type": "object", "description": "External details for the sales quotation.", "additionalProperties": false, "properties": { "externalCreatedDate": { "type": "string", "description": "The SalesQuotation ExternalCreatedDate", "format": "date-time" }, "externalInvoiceType": { "type": "integer", "description": "The SalesQuotation ExternalInvoiceType", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ExternalSalesInvoiceType" }, "externalSalesQuotationNumber": { "type": "string", "description": "The SalesQuotation ExternalSalesQuotationNumber" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationLineItem": { "type": "object", "description": "Line item details for the new sales quotation.", "additionalProperties": false, "properties": { "itemId": { "description": "Unique ID to identify an item.", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "parentSalesQuotationLineItemId": { "description": "The SalesQuotationLineItem ParentSalesQuotationLineItemId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey" }, "taxClassId": { "description": "The SalesQuotationLineItem TaxClassId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey" }, "taxCodeId": { "description": "The SalesQuotationLineItem TaxCodeId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerschluesselKey" }, "billOfMaterialsType": { "type": "integer", "description": "The SalesQuotationLineItem BillOfMaterialsType", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.BillOfMaterialsType" }, "configurationItemType": { "type": "integer", "description": "The SalesQuotationLineItem ConfigurationItemType", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ConfigurationItemType" }, "discountPercent": { "type": "number", "description": "The discount of the line item.", "format": "decimal" }, "fnSku": { "type": "string", "description": "The SalesQuotationLineItem FNSKU" }, "name": { "type": "string", "description": "Name of the position." }, "note": { "type": "string", "description": "The SalesQuotationLineItem Note" }, "purchasePriceNet": { "type": "number", "description": "The purchase price of the item.", "format": "decimal" }, "quantity": { "type": "number", "description": "The quantity of the line item.", "format": "decimal" }, "salesPriceNet": { "type": "number", "description": "The net sales price of the item. Only net or gross price can be entered. The other price will then be calculated.", "format": "decimal" }, "salesUnit": { "type": "string", "description": "The sales unit of the line item." }, "sku": { "type": "string", "description": "SKU of the sales quotation line item." }, "taxRate": { "type": "number", "description": "The tax rate of the line item.", "format": "decimal" }, "type": { "type": "integer", "description": "The SalesQuotationLineItem LineItemType", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.LineItemType" }, "variants": { "type": "array", "description": "List of SalesQuotationLineItemVariant", "items": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationLineItemVariant" } } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationLineItemVariant": { "type": "object", "description": "Sales quotation line item variant details.", "additionalProperties": false, "required": [ "Name", "ItemVariantId" ], "properties": { "extraWeight": { "type": "number", "description": "The SalesQuotationLineItemVariant ExtraWeight", "format": "decimal" }, "name": { "type": "string", "description": "The SalesQuotationLineItemVariant Name" }, "surchargeNet": { "type": "number", "description": "The SalesQuotationLineItemVariant SurchargeNet", "format": "decimal" }, "value": { "type": "string", "description": "The SalesQuotationLineItemVariant Value" }, "itemVariantId": { "description": "The SalesQuotationLineItemVariant ItemVariantId", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey" }, "itemVariantValueId": { "description": "The SalesQuotationLineItemVariant ItemVariantValueId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationWertKey" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationPaymentDetails": { "type": "object", "description": "Payment details for the new sales quotation.", "additionalProperties": false, "required": [ "CurrencyIso" ], "properties": { "cashDiscount": { "type": "number", "description": "The SalesQuotation CashDiscount", "format": "decimal" }, "cashDiscountDays": { "type": "integer", "description": "The SalesQuotation CashDiscountDays", "format": "int32" }, "financingCosts": { "type": "number", "description": "The SalesQuotation FinancingCosts", "format": "decimal" }, "paymentDueDateInDays": { "type": "integer", "description": "The SalesQuotation PaymentDueDateInDays", "format": "int32" }, "currencyIso": { "type": "string", "description": "The sales quotation departure country currency iso", "maxLength": 3, "minLength": 3 }, "currencyFactor": { "type": "number", "description": "The sales quotation departure country currency factor", "format": "decimal" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationPaymentInfo": { "type": "object", "description": "Payment info for the new sales quotation.", "additionalProperties": false, "properties": { "accountHolder": { "type": "string", "description": "The SalesQuotationPaymentInfo AccountHolder" }, "bankName": { "type": "string", "description": "The SalesQuotationPaymentInfo BankName" }, "bIC": { "type": "string", "description": "The SalesQuotationPaymentInfo BIC" }, "creditorId": { "type": "string", "description": "The SalesQuotationPaymentInfo CreditorId" }, "dueDate": { "type": "string", "description": "The SalesQuotationPaymentInfo DueDate", "format": "date-time" }, "endToEndId": { "type": "string", "description": "The SalesQuotationPaymentInfo EndToEndId" }, "iBAN": { "type": "string", "description": "The SalesQuotationPaymentInfo IBAN" }, "mandateReference": { "type": "string", "description": "The SalesQuotationPaymentInfo MandateReference" }, "paymentInfo": { "type": "string", "description": "The SalesQuotationPaymentInfo PaymentInfo" }, "paymentReference": { "type": "string", "description": "The SalesQuotationPaymentInfo PaymentReference" }, "referenceEmail": { "type": "string", "description": "The SalesQuotationPaymentInfo ReferenceEmail" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationShippingDetails": { "type": "object", "description": "Shipping details for the new sales quotation.", "additionalProperties": false, "properties": { "deliveryFromDate": { "type": "string", "description": "The SalesQuotation DeliveryFromDate", "format": "date-time" }, "estimatedDeliveryDate": { "type": "string", "description": "The SalesQuotation EstimatedDeliveryDate", "format": "date-time" }, "extraWeight": { "type": "number", "description": "The SalesQuotation ExtraWeight", "format": "decimal" }, "maxDeliveryDays": { "type": "integer", "description": "The SalesQuotation MaxDeliveryDays", "format": "int32" }, "shippingDate": { "type": "string", "description": "The SalesQuotation ShippingDate", "format": "date-time" }, "shippingPriority": { "type": "integer", "description": "The SalesQuotation ShippingPriority", "format": "int32" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationTaxDetails": { "type": "object", "description": "Tax details for the new sales quotation.", "additionalProperties": false, "properties": { "specialTaxTreatment": { "type": "integer", "description": "The SalesQuotation SpecialTaxTreatment", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.SpecialTaxTreatment" }, "taxSetting": { "type": "integer", "description": "The SalesQuotation TaxSetting", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.TaxSetting" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationText": { "type": "object", "description": "Text details for the new sales quotation.", "additionalProperties": false, "properties": { "comment": { "type": "string", "description": "The SalesQuotationText Comment" }, "customerComment": { "type": "string", "description": "The SalesQuotationText CustomerComment" }, "printText": { "type": "string", "description": "The SalesQuotationText PrintText" }, "processStatus": { "type": "string", "description": "The SalesQuotationText ProcessStatus" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateSalesOrderFromSalesQuotationCommandRequest": { "type": "object", "description": "Create a new sales order for a sales quotation - Request", "additionalProperties": false, "required": [ "SalesQuotationId" ], "properties": { "salesQuotationId": { "description": "The ID of the sales quotation to create the order from.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateSalesQuotationCommandRequest": { "type": "object", "description": "Creates a new sales quotation. - Request", "additionalProperties": false, "required": [ "CompanyId", "CustomerId", "BillingAddress", "DepartureCountry", "LineItems", "PaymentDetails", "LanguageIso", "VatId" ], "properties": { "disableAutomaticWorkflows": { "type": "boolean", "description": "Indicates whether automatic workflows should be disabled for this sales quotation." }, "useBillingAddressAsShipmentAddress": { "type": "boolean", "description": "Indicates whether the billing address should be used as the shipment address. If no shipment address is provided and the flag ist not set, the billing address will also be used as shipment address. If the shipment address is provided, this flag will be ignored." }, "cartonItemId": { "description": "The SalesQuotation CartonItemId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey" }, "companyId": { "description": "The SalesQuotation CompanyId", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey" }, "customerId": { "description": "The customer ID.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey" }, "onHoldReasonId": { "description": "The SalesQuotation OnHoldReasonId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.RueckhaltegrundKey" }, "paymentMethodId": { "description": "The SalesQuotation PaymentMethodId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey" }, "processColourId": { "description": "The SalesQuotation ProcessColourId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FarbeKey" }, "processStatusId": { "description": "The SalesQuotation ProcessStatusId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VorgangsstatusKey" }, "billingAddress": { "description": "SalesQuotationBillingAddress", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationAddress" }, "departureCountry": { "description": "DepartureCountry", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationDepartureCountry" }, "externalDetails": { "description": "ExternalDetails", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationExternalDetails" }, "lineItems": { "type": "array", "description": "List of SalesQuotationLineItem", "items": { "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationLineItem" } }, "paymentDetails": { "description": "PaymentDetails", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationPaymentDetails" }, "paymentInfo": { "description": "SalesQuotationPaymentInfo", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationPaymentInfo" }, "shipmentAddress": { "description": "SalesQuotationShipmentAddress", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationAddress" }, "shippingDetails": { "description": "ShippingDetails", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationShippingDetails" }, "taxDetails": { "description": "TaxDetails", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationTaxDetails" }, "text": { "description": "SalesQuotationText", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesQuotationDomain.CreateCreateSalesQuotationText" }, "customerSalesQuotationNumber": { "type": "string", "description": "The SalesQuotation CustomerSalesQuotationNumber" }, "customerVatId": { "type": "string", "description": "The VAT ID of the customer." }, "itemDescriptionType": { "type": "integer", "description": "The SalesQuotation ItemDescriptionType", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ItemDescriptionType" }, "languageIso": { "type": "string", "description": "The SalesQuotation LanguageISO", "maxLength": 5, "minLength": 2 }, "readOnlyType": { "type": "integer", "description": "The SalesQuotation ReadOnlyType", "format": "int32", "$ref": "#/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ReadOnlyType" }, "salesQuotationDate": { "type": "string", "description": "The SalesQuotation Date", "format": "date-time" }, "salesQuotationNumber": { "type": "string", "description": "The SalesQuotation SalesQuotationNumber" }, "shippingMethodId": { "description": "The SalesQuotation ShippingMethodId", "example": "b45f6432-2462-4c6f-b00f-1d9d01000000", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey" }, "vatId": { "type": "string", "description": "The SalesQuotation VATId" } } }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.BillOfMaterialsType": { "type": "integer", "description": "0 = None, 1 = BillOfMaterials, 2 = Component", "format": "int32", "x-enumNames": [ "None", "BillOfMaterials", "Component" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ConfigurationItemType": { "type": "integer", "description": "0 = None, 1 = ConfigurationItem, 2 = Component", "format": "int32", "x-enumNames": [ "None", "ConfigurationItem", "Component" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ExternalSalesInvoiceType": { "type": "integer", "description": "0 = None, 1 = NoInvoiceNoOutput, 2 = NoInvoice", "format": "int32", "x-enumNames": [ "None", "NoInvoiceNoOutput", "NoInvoice" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ItemDescriptionType": { "type": "integer", "description": "0 = None, 1 = Brief, 2 = Long", "format": "int32", "x-enumNames": [ "None", "Brief", "Long" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.LineItemType": { "type": "integer", "description": "0 = Custom, 1 = Item, 2 = Shipping, 3 = Coupon, 4 = Voucher, 5 = Payment, 6 = ShippingSurcharge, 7 = NewCustomerCoupon, 8 = CashOnDelivery, 9 = ShippingSurchargeItem, 10 = Packing, 11 = GiftForFree, 12 = TrustedShops, 13 = InterestPremium, 14 = ProcessingFee, 15 = Carton, 16 = ReturnDelivery, 17 = MultiPurposeVoucher, 18 = MultiPurposeVoucherDigital, 19 = SinglePurposeVoucher, 20 = SinglePurposeVoucherDigital, 21 = SinglePurposeVoucherRedemption", "format": "int32", "x-enumNames": [ "Custom", "Item", "Shipping", "Coupon", "Voucher", "Payment", "ShippingSurcharge", "NewCustomerCoupon", "CashOnDelivery", "ShippingSurchargeItem", "Packing", "GiftForFree", "TrustedShops", "InterestPremium", "ProcessingFee", "Carton", "ReturnDelivery", "MultiPurposeVoucher", "MultiPurposeVoucherDigital", "SinglePurposeVoucher", "SinglePurposeVoucherDigital", "SinglePurposeVoucherRedemption" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21 ] }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ReadOnlyType": { "type": "integer", "description": "0 = ChangesAllowed, 1 = InvoicedExternally, 2 = ChangesForbidden", "format": "int32", "x-enumNames": [ "ChangesAllowed", "InvoicedExternally", "ChangesForbidden" ], "enum": [ 0, 1, 2 ] }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.SpecialTaxTreatment": { "type": "integer", "description": "0 = None, 1 = ReverseCharge, 2 = ExemptFromVat, 3 = SubjectToVat", "format": "int32", "x-enumNames": [ "None", "ReverseCharge", "ExemptFromVat", "SubjectToVat" ], "enum": [ 0, 1, 2, 3 ] }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.TaxReference": { "type": "integer", "description": "0 = ShipmentAddress, 1 = BillingAddress", "format": "int32", "x-enumNames": [ "ShipmentAddress", "BillingAddress" ], "enum": [ 0, 1 ] }, "JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.TaxSetting": { "type": "integer", "description": "0 = DeliveryWithVat, 10 = IntraCommunityDelivery, 15 = ExemptFromVatReverseCharge, 20 = ExemptFromVat", "format": "int32", "x-enumNames": [ "DeliveryWithVat", "IntraCommunityDelivery", "ExemptFromVatReverseCharge", "ExemptFromVat" ], "enum": [ 0, 10, 15, 20 ] }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.BinLocationManagement.ActivateBinLocationCommandRequest": { "type": "object", "description": "Activates a bin location, making it available for operations. - Request", "additionalProperties": false, "required": [ "BinLocationId" ], "properties": { "binLocationId": { "description": "Unique identifier of the bin location to activate.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.BinLocationManagement.CreateBinLocationCommandRequest": { "type": "object", "description": "Creates a new bin location in a warehouse. - Request", "additionalProperties": false, "required": [ "WarehouseId", "Name", "Type" ], "properties": { "warehouseId": { "description": "Warehouse where the bin location should be created.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "name": { "type": "string", "description": "Name of the bin location (must be unique within the warehouse, max 50 chars, no apostrophes)." }, "type": { "type": "integer", "description": "Type of the bin location (0=Standard, 1=Shelf, 2=Floor, 3=Rack, 4=Picking, 5=Transfer, 6=Clarification).", "format": "int32" }, "sort": { "type": "integer", "description": "Optional sort order.", "format": "int32" } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.BinLocationManagement.DeactivateBinLocationCommandRequest": { "type": "object", "description": "Deactivates a bin location, making it unavailable for operations. - Request", "additionalProperties": false, "required": [ "BinLocationId" ], "properties": { "binLocationId": { "description": "Unique identifier of the bin location to deactivate.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.BinLocationManagement.DeleteBinLocationCommandRequest": { "type": "object", "description": "Deletes a bin location from the warehouse. - Request", "additionalProperties": false, "properties": { "binLocationId": { "description": "Unique identifier of the bin location to delete.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.BinLocationManagement.LockBinLocationCommandRequest": { "type": "object", "description": "Locks a bin location, preventing stock movements. - Request", "additionalProperties": false, "required": [ "BinLocationId" ], "properties": { "binLocationId": { "description": "Unique identifier of the bin location to lock.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.BinLocationManagement.LockBinLocationForAvailableStockCommandRequest": { "type": "object", "description": "Locks a bin location for available stock, preventing it from being used for stock allocation. - Request", "additionalProperties": false, "required": [ "BinLocationId" ], "properties": { "binLocationId": { "description": "Unique identifier of the bin location to lock for available stock.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.BinLocationManagement.UnlockBinLocationForAvailableStockCommandRequest": { "type": "object", "description": "Unlocks a bin location for available stock, allowing it to be used for stock allocation. - Request", "additionalProperties": false, "required": [ "BinLocationId" ], "properties": { "binLocationId": { "description": "Unique identifier of the bin location to unlock for available stock.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.BinLocationManagement.UpdateBinLocationMetadataCommandRequest": { "type": "object", "description": "Updates metadata of an existing bin location (name, type, sort order). - Request", "additionalProperties": false, "required": [ "BinLocationId" ], "properties": { "binLocationId": { "description": "Unique identifier of the bin location to update.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" }, "name": { "type": "string", "description": "New name for the bin location (must be unique within the warehouse, max 50 chars, no apostrophes)." }, "type": { "type": "integer", "description": "New type for the bin location (0=Standard, 1=Shelf, 2=Floor, 3=Rack, 4=Picking, 5=Transfer, 6=Clarification).", "format": "int32" }, "sort": { "type": "integer", "description": "New sort order.", "format": "int32" } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.ShipmentPackages.ChangePackageWeightCommandRequest": { "type": "object", "description": "Modifies an existing Package Weight - Request", "additionalProperties": false, "required": [ "PackageId", "Weight" ], "properties": { "packageId": { "type": "string", "description": "ID of the Package to be modified" }, "weight": { "type": "number", "description": "The new Weight of the Package", "format": "decimal" } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.ShipmentPackages.CreateDeliverPackageCommandRequest": { "type": "object", "description": "Delivers an existing Package - Request", "additionalProperties": false, "required": [ "PackageId" ], "properties": { "packageId": { "type": "string", "description": "ID of the Package to be modified" }, "trackingCode": { "type": "string", "description": "The Tracking Code of the Package. Only required if configured in the Shipping Method" }, "shippingDate": { "type": "string", "description": "The Shipping Date of the Package. Only required if configured in the Shipping Method", "format": "date-time" } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseAssistant.AssignShippingBoxToLocationCommandRequest": { "type": "object", "description": "Reassigns a shipping box to a different bin location (Rule SB-5). - Request", "additionalProperties": false, "required": [ "ShippingBoxId", "BinLocationId" ], "properties": { "shippingBoxId": { "description": "The shipping box to reassign.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LhmKey" }, "binLocationId": { "description": "New bin location.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseAssistant.CreateShippingBoxCommandRequest": { "type": "object", "description": "Creates a new shipping box within a warehouse. - Request", "additionalProperties": false, "required": [ "WarehouseId", "DisplayId", "TypeId", "BinLocationId", "Attributes" ], "properties": { "warehouseId": { "description": "Warehouse to create the box in.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "displayId": { "type": "string", "description": "Display name for the box (must be unique within warehouse)." }, "typeId": { "description": "Box type (immutable after creation).", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LhmTypeKey" }, "binLocationId": { "description": "Bin location to assign the box to.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" }, "attributes": { "type": "array", "description": "Optional list of free-form attributes.", "items": { "type": "string" } } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseAssistant.DeleteShippingBoxCommandRequest": { "type": "object", "description": "Permanently deletes a shipping box and all its attributes (Rule SB-8). - Request", "additionalProperties": false, "properties": { "shippingBoxId": { "description": "The shipping box to delete.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LhmKey" } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseAssistant.UpdateShippingBoxMetadataCommandRequest": { "type": "object", "description": "Updates mutable metadata of an existing shipping box. TypeId is immutable (Rule SB-3). - Request", "additionalProperties": false, "required": [ "ShippingBoxId", "DisplayId", "Attributes" ], "properties": { "shippingBoxId": { "description": "The shipping box to update.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LhmKey" }, "displayId": { "type": "string", "description": "New display name (omit to keep existing)." }, "attributes": { "type": "array", "description": "Replacement attribute list (omit to keep existing).", "items": { "type": "string" } } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseZone.AddBinLocationsToZoneCommandRequest": { "type": "object", "description": "Adds bin locations to a warehouse zone. - Request", "additionalProperties": false, "required": [ "ZoneId", "BinLocationIds" ], "properties": { "zoneId": { "description": "The zone to add bin locations to.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerBereichKey" }, "binLocationIds": { "type": "array", "description": "Bin locations to add to the zone.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" } } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseZone.CreateWarehouseZoneCommandRequest": { "type": "object", "description": "Creates a new warehouse zone. - Request", "additionalProperties": false, "required": [ "WarehouseId", "Code", "ZoneType" ], "properties": { "warehouseId": { "description": "Warehouse to create the zone in.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey" }, "code": { "type": "string", "description": "Zone short code (must be unique within the warehouse)." }, "zoneType": { "type": "integer", "description": "Zone type (0=Standard, 1=Picking, 2=Replenishment, 3=Reserve).", "format": "int32" }, "description": { "type": "string", "description": "Optional zone description." } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseZone.DeleteWarehouseZoneCommandRequest": { "type": "object", "description": "Deletes a warehouse zone. - Request", "additionalProperties": false, "properties": { "zoneId": { "description": "The zone to delete.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerBereichKey" } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseZone.RemoveBinLocationsFromZoneCommandRequest": { "type": "object", "description": "Removes bin locations from a warehouse zone. - Request", "additionalProperties": false, "required": [ "ZoneId", "BinLocationIds" ], "properties": { "zoneId": { "description": "The zone to remove bin locations from.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerBereichKey" }, "binLocationIds": { "type": "array", "description": "Bin locations to remove from the zone.", "items": { "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey" } } } }, "JTL.Wawi.Warenlagerverwaltung.PublicApi.DataTransferObjects.V2.WarehouseZone.UpdateWarehouseZoneMetadataCommandRequest": { "type": "object", "description": "Updates mutable metadata (code, description, type) of an existing warehouse zone. - Request", "additionalProperties": false, "required": [ "ZoneId", "Code", "ZoneType", "Description" ], "properties": { "zoneId": { "description": "The zone to update.", "$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerBereichKey" }, "code": { "type": "string", "description": "New zone short code (omit to keep existing)." }, "zoneType": { "type": "integer", "description": "New zone type (omit to keep existing).", "format": "int32" }, "description": { "type": "string", "description": "New zone description (omit to keep existing)." } } } }, "securitySchemes": { "oauth2-authorization-code": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://auth.jtl-cloud.com/oauth2/auth", "tokenUrl": "https://auth.jtl-cloud.com/oauth2/token", "scopes": { "items.read": "Artikel lesen", "items.write": "Artikel schreiben", "accountings.read": "", "all.read": "Erlaubt der Anwendung, alle Daten zu lesen.", "authentication.updateforeignapp": "", "cusomters.read": "", "customers.read": "", "customers.write": "", "customfields.read": "", "customfields.write": "", "deliveries.read": "", "deliveries.write": "", "deliverynotes.print": "", "deliverynotes.read": "", "deliverynotes.write": "", "extensibility.integration": "", "foreignapps.manage": "", "inventories.read": "", "inventories.write": "", "invoices.print": "", "invoices.read": "", "invoices.write": "", "labels.read": "", "labels.write": "", "offers.print": "", "offers.read": "", "orders.read": "", "picklists.read": "", "picklists.write": "", "returns.read": "", "returns.write": "", "saleschannels.read": "", "salesinvoicecorrections.print": "", "salesinvoicecorrections.read": "", "salesinvoicecorrections.write": "", "salesorders.print": "", "salesorders.read": "", "salesorders.write": "", "suppliers.read": "", "system.config.read": "", "system.config.write": "", "system.read": "", "system.worker.read": "", "system.worker.write": "", "taxes.read": "", "warehouse.read": "", "wawiapp.all": "Ermöglicht den Zugriff auf Wawi-App bezogene Opperationen.", "currencies.read": "Grants read access to currencies.", "jera.read": "Grants read access to JERA internal endpoints.", "paymentmethods.read": "Grants read access to payment methods.", "salesinvoices.read": "Grants read access to sales invoices.", "salesinvoices.write": "Grants write access to sales invoices.", "salesquotations.read": "Grants read access to sales quotations.", "salesquotations.write": "Grants write access to sales quotations.", "resources.read": "Ressourcen lesen", "resources.write": "Ressourcen schreiben", "pps.read": "Produktionsdaten lesen", "pps.write": "Produktionsdaten schreiben", "inventory.read": "Lagerbestand lesen", "inventory.write": "Lagerbestand schreiben", "taxes.write": "Steuern schreiben", "application.runas": "Ermöglicht der Anwendung, Anfragen im Namen eines anderen Benutzers auszuführen." } } } }, "oauth2-client-credentials": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://auth.jtl-cloud.com/oauth2/token", "scopes": { "items.read": "Artikel lesen", "items.write": "Artikel schreiben", "accountings.read": "", "all.read": "Erlaubt der Anwendung, alle Daten zu lesen.", "authentication.updateforeignapp": "", "cusomters.read": "", "customers.read": "", "customers.write": "", "customfields.read": "", "customfields.write": "", "deliveries.read": "", "deliveries.write": "", "deliverynotes.print": "", "deliverynotes.read": "", "deliverynotes.write": "", "extensibility.integration": "", "foreignapps.manage": "", "inventories.read": "", "inventories.write": "", "invoices.print": "", "invoices.read": "", "invoices.write": "", "labels.read": "", "labels.write": "", "offers.print": "", "offers.read": "", "orders.read": "", "picklists.read": "", "picklists.write": "", "returns.read": "", "returns.write": "", "saleschannels.read": "", "salesinvoicecorrections.print": "", "salesinvoicecorrections.read": "", "salesinvoicecorrections.write": "", "salesorders.print": "", "salesorders.read": "", "salesorders.write": "", "suppliers.read": "", "system.config.read": "", "system.config.write": "", "system.read": "", "system.worker.read": "", "system.worker.write": "", "taxes.read": "", "warehouse.read": "", "wawiapp.all": "Ermöglicht den Zugriff auf Wawi-App bezogene Opperationen.", "currencies.read": "Grants read access to currencies.", "jera.read": "Grants read access to JERA internal endpoints.", "paymentmethods.read": "Grants read access to payment methods.", "salesinvoices.read": "Grants read access to sales invoices.", "salesinvoices.write": "Grants write access to sales invoices.", "salesquotations.read": "Grants read access to sales quotations.", "salesquotations.write": "Grants write access to sales quotations.", "resources.read": "Ressourcen lesen", "resources.write": "Ressourcen schreiben", "pps.read": "Produktionsdaten lesen", "pps.write": "Produktionsdaten schreiben", "inventory.read": "Lagerbestand lesen", "inventory.write": "Lagerbestand schreiben", "taxes.write": "Steuern schreiben", "application.runas": "Ermöglicht der Anwendung, Anfragen im Namen eines anderen Benutzers auszuführen." } } } } } }, "tags": [ { "name": "worker", "description": "Planned" }, { "name": "wms", "description": "

Query all pick lists for a specific wms warehouse that are not completed." }, { "name": "WawiApp", "description": "Development" }, { "name": "warehouse", "description": "

Query all warehouses" }, { "name": "unitsOfMeasure", "description": "Development" }, { "name": "transactionStatus", "description": "

Query all transaction status for sales order" }, { "name": "tax", "description": "

Returns the Taxrate for the given Item" }, { "name": "item", "description": "

Query all tax classes" }, { "name": "supplier", "description": "

Query all suppliers" }, { "name": "stock", "description": "

Query stocks for a specific item, warehouse or storage location" }, { "name": "shippingmethod", "description": "

Query all shipping methods" }, { "name": "shipment", "description": "

Download a PDF Shipping Label from database by ID" }, { "name": "salesorder", "description": "

Query all sales orders" }, { "name": "cancellationreason", "description": "Planned" }, { "name": "salesinvoicecorrection", "description": "Development" }, { "name": "saleschannel", "description": "

Get all sales channels" }, { "name": "return", "description": "

Create a new return with associated items and packages." }, { "name": "returnstate", "description": "Planned" }, { "name": "returnreason", "description": "Planned" }, { "name": "property", "description": "

Query all properties for items" }, { "name": "printer", "description": "

Returns all Installed Printers" }, { "name": "paymentmethod", "description": "

Query all payment methods" }, { "name": "onholdreason", "description": "

Query all on hold reasons for sales orders" }, { "name": "offer", "description": "

Execute the printing of a Offer" }, { "name": "Configuration", "description": "Planned" }, { "name": "manufacturer", "description": "Development" }, { "name": "label", "description": "Development" }, { "name": "duplicateItem", "description": "Development" }, { "name": "copyItem", "description": "Development" }, { "name": "invoice", "description": "Planned" }, { "name": "info", "description": "

Returns the status of the API" }, { "name": "features", "description": "

Returns the available feature sets with release state and API version" }, { "name": "Extensibility", "description": "Planned" }, { "name": "shipping", "description": "Development" }, { "name": "deliverynote", "description": "Planned" }, { "name": "customfields", "description": "Development" }, { "name": "customfield", "description": "Development" }, { "name": "customer", "description": "

Query all customers" }, { "name": "customerGroup", "description": "

Query all customer groups" }, { "name": "customerCategory", "description": "

Query all customer categories" }, { "name": "creditnote", "description": "

Execute the printing of a CreditNote" }, { "name": "company", "description": "

Query all companies" }, { "name": "colorcodes", "description": "

Query all color codes for sales orders" }, { "name": "category", "description": "Development" }, { "name": "appRegistration", "description": "

Send a registration request for an (external) application" }, { "name": "login", "description": "

Sends a request to log in the user / dynamically assign the WAWI user. Only use this request if your API uses SSL." }, { "name": "logout", "description": "

Sends a request to log out the user" }, { "name": "attribute", "description": "Development" }, { "name": "accountingData", "description": "Planned" } ] }