{
"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: 0.0.0\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": "1.0",
"x-application-version": "0.0.0.0"
},
"servers": [
{
"url": "https://api.jtl-cloud.com/erp",
"description": "Production Environment Cloud API Gateway"
}
],
"paths": {
"/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": "AccountingDataHeader_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": {
"$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.V1.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"
}
}
],
"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.V1.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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "draft"
}
},
"/authentication": {
"post": {
"tags": [
"appRegistration"
],
"summary": "Register App",
"description": "Send a registration request for an (external) application",
"operationId": "AuthenticationHeader_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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/authentication/{registrationId}": {
"get": {
"tags": [
"appRegistration"
],
"summary": "Fetch Registration Status",
"description": "Obtain information about a registration request",
"operationId": "AuthenticationHeader_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": {}
}
}
},
"deprecated": true,
"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": "AuthenticationHeader_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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/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": "AuthenticationHeader_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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "beta"
}
},
"/authentication/logout": {
"post": {
"tags": [
"logout"
],
"summary": "Logout",
"description": "Sends a request to log out the user",
"operationId": "AuthenticationHeader_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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "beta"
}
},
"/availabilities": {
"get": {
"tags": [
"item"
],
"summary": "Query Availabilities",
"description": "Query all availabilites for items",
"operationId": "AvailabilityHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/cancellationReasons": {
"get": {
"tags": [
"cancellationreason"
],
"summary": "Query Cancellation Reasons",
"description": "Query all cancellation reasons for sales orders",
"operationId": "CancellationReasonHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/categories": {
"get": {
"tags": [
"category"
],
"summary": "Query Categories",
"description": "Query all categories",
"operationId": "CategoryHeader_QueryCategoriesAsync",
"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"
}
}
],
"responses": {
"200": {
"description": "Returns all categories.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Category.Category"
}
}
}
},
"401": {
"description": "",
"content": {
"application/json": {}
}
},
"402": {
"description": "No licence available or the app has not been authorised by JTL.",
"content": {
"application/json": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "stable"
},
"post": {
"tags": [
"category"
],
"summary": "Create Category",
"description": "Create a new category",
"operationId": "CategoryHeader_CreateCategoryAsync",
"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"
}
}
],
"requestBody": {
"x-name": "category",
"description": "The category to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.CreateCategory"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created category.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.Category"
}
}
}
},
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 210,
"x-stability-level": "stable"
}
},
"/categories/{categoryId}": {
"get": {
"tags": [
"category"
],
"summary": "Get Category",
"description": "Get a specific category",
"operationId": "CategoryHeader_GetCategoryAsync",
"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",
"in": "path",
"required": true,
"description": "The id of the category to return.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "Returns the category for the given id.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.Category"
}
}
}
},
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "stable"
},
"patch": {
"tags": [
"category"
],
"summary": "Update Category",
"description": "Update a specific category",
"operationId": "CategoryHeader_UpdateCategoryAsync",
"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",
"in": "path",
"required": true,
"description": "The id of the category to update.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "category",
"description": "The category to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.UpdateCategory"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The updated category.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.Category"
}
}
}
},
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 220,
"x-stability-level": "stable"
}
},
"/categories/{categoryId}/descriptions": {
"get": {
"tags": [
"category"
],
"summary": "Query Category Descriptions",
"description": "Query all descriptions for a specific category",
"operationId": "CategoryHeader_QueryCategoryDescriptionsAsync",
"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",
"in": "path",
"required": true,
"description": "The id of the category that the descriptions belong to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested category descriptions.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.CategoryDescription"
}
}
}
}
},
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 300,
"x-stability-level": "stable"
},
"post": {
"tags": [
"category"
],
"summary": "Create Category Description",
"description": "Create a new description for a specific category",
"operationId": "CategoryHeader_CreateCategoryDescriptionAsync",
"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",
"in": "path",
"required": true,
"description": "The id of the category that the descriptions belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "categoryDescription",
"description": "The categoryDescription to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.CreateCategoryDescription"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created category description.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.CategoryDescription"
}
}
}
},
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 310,
"x-stability-level": "stable"
}
},
"/categories/{categoryId}/descriptions/{salesChannelId}/{languageIso}": {
"patch": {
"tags": [
"category"
],
"summary": "Update Category Description",
"description": "Update a description for a specific category",
"operationId": "CategoryHeader_UpdateCategoryDescriptionAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "salesChannelId",
"in": "path",
"required": true,
"description": "The id of the sales channel that the descriptions belong to.",
"schema": {
"type": "string"
},
"x-position": 2
},
{
"name": "languageIso",
"in": "path",
"required": true,
"description": "The iso code of the language that the descriptions belong to.",
"schema": {
"type": "string"
},
"x-position": 3
},
{
"name": "categoryId",
"in": "path",
"required": true,
"description": "The id of the category that the descriptions belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "categoryDescription",
"description": "The category to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.UpdateCategoryDescription"
}
}
},
"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 category with the given ID exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 320,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"category"
],
"summary": "Delete Category Description",
"description": "Delete a description for a specific category",
"operationId": "CategoryHeader_DeleteCategoryDescriptionAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "salesChannelId",
"in": "path",
"required": true,
"description": "The id of the sales channel that the descriptions belong to.",
"schema": {
"type": "string"
},
"x-position": 1
},
{
"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": "categoryId",
"in": "path",
"required": true,
"description": "The id of the category that the descriptions belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
},
"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"
}
}
],
"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 category with the given ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 330,
"x-stability-level": "stable"
}
},
"/categories/{categoryId}/items": {
"post": {
"tags": [
"category"
],
"summary": "Add Category Items",
"description": "Add items to a specific category",
"operationId": "CategoryHeader_AddCategoryItemsAsync",
"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",
"in": "path",
"required": true,
"description": "The id of the category where the items should be assigned.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "items",
"description": "The item Ids to be assigned to the category.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The assigned item ids.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
}
},
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1000,
"x-stability-level": "stable"
}
},
"/colorCodes": {
"get": {
"tags": [
"colorcodes"
],
"summary": "Query Color Codes",
"description": "Query all color codes for sales orders",
"operationId": "ColorCodeHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/companies": {
"get": {
"tags": [
"company"
],
"summary": "Query Companies",
"description": "Query all companies",
"operationId": "CompanyHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/conditions": {
"get": {
"tags": [
"item"
],
"summary": "Query Conditions",
"description": "Query all item conditions",
"operationId": "ConditionHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/configuration/numberRanges": {
"get": {
"tags": [
"Configuration"
],
"summary": "Get Number Ranges",
"description": "Returns all available Number Ranges",
"operationId": "NumberRangesHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/configuration/numberRanges/{numberRangeId}": {
"get": {
"tags": [
"Configuration"
],
"summary": "Get Number Range",
"description": "Returns the requested NumberRange",
"operationId": "NumberRangesHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "NumberRangesHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
},
"put": {
"tags": [
"Configuration"
],
"summary": "Update Number Range",
"description": "Updates an Existing NumberRange",
"operationId": "NumberRangesHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
},
"delete": {
"tags": [
"Configuration"
],
"summary": "Delete Number Range",
"description": "Delete a NumberRange, but only Deletable Numberranges",
"operationId": "NumberRangesHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/configuration/numberRanges/{numberRangeId}/increment": {
"post": {
"tags": [
"Configuration"
],
"summary": "Number Range Increment",
"description": "Increment and returns the Next Number for the given NumberRange",
"operationId": "NumberRangesHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/configuration/numberRanges/{numberRangeId}/preview": {
"get": {
"tags": [
"Configuration"
],
"summary": "Number Range Preview",
"description": "Returns a Preview of the Next Number for the given NumberRange",
"operationId": "NumberRangesHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/creditNotes/{creditNoteId}/output/mail": {
"post": {
"tags": [
"creditnote"
],
"summary": "Mail Credit Note",
"description": "Execute the mailing of a CreditNote",
"operationId": "CreditNoteHeader_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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/creditNotes/{creditNoteId}/output/pdf": {
"post": {
"tags": [
"creditnote"
],
"summary": "Pdf Credit Note",
"description": "Execute the pdf creation of a CreditNote",
"operationId": "CreditNoteHeader_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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/creditNotes/{creditNoteId}/output/print": {
"post": {
"tags": [
"creditnote"
],
"summary": "Print Credit Note",
"description": "Execute the printing of a CreditNote",
"operationId": "CreditNoteHeader_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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/customerCategories": {
"get": {
"tags": [
"customerCategory"
],
"summary": "Query Customer Categories",
"description": "Query all customer categories",
"operationId": "CustomerCategoryHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
},
"post": {
"tags": [
"customerCategory"
],
"summary": "Create Customer Category",
"description": "Create a new customer category",
"operationId": "CustomerCategoryHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/customerCategories/{customercategoryId}": {
"get": {
"tags": [
"customerCategory"
],
"summary": "Get Customer Category",
"description": "Get a specific customercategory",
"operationId": "CustomerCategoryHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "stable"
},
"patch": {
"tags": [
"customerCategory"
],
"summary": "Update Customer Category",
"description": "Update a specific customer category",
"operationId": "CustomerCategoryHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"customerCategory"
],
"summary": "Delete Customer Category",
"description": "Delete a specific customercategory",
"operationId": "CustomerCategoryHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "stable"
}
},
"/customerGroups": {
"get": {
"tags": [
"customerGroup"
],
"summary": "Query Customer Groups",
"description": "Query all customer groups",
"operationId": "CustomerGroupHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
},
"post": {
"tags": [
"customerGroup"
],
"summary": "Create Customer Group",
"description": "Create a new customer group",
"operationId": "CustomerGroupHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/customerGroups/{customergroupId}": {
"get": {
"tags": [
"customerGroup"
],
"summary": "Get Customer Group",
"description": "Get a specific customergroup",
"operationId": "CustomerGroupHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "stable"
},
"patch": {
"tags": [
"customerGroup"
],
"summary": "Update Customer Group",
"description": "Update a specific customer group",
"operationId": "CustomerGroupHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"customerGroup"
],
"summary": "Delete Customer Group",
"description": "Delete a specific customergroup",
"operationId": "CustomerGroupHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/customers": {
"get": {
"tags": [
"customer"
],
"summary": "Query Customers",
"description": "Query all customers",
"operationId": "CustomerHeader_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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey"
},
"x-position": 3
},
{
"name": "categoryId",
"in": "query",
"schema": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "stable"
},
"post": {
"tags": [
"customer"
],
"summary": "Create Customer",
"description": "Create a new customer",
"operationId": "CustomerHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 210,
"x-stability-level": "stable"
}
},
"/customers/{customerId}": {
"get": {
"tags": [
"customer"
],
"summary": "Get Customer",
"description": "Get a specific customer",
"operationId": "CustomerHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "stable"
},
"patch": {
"tags": [
"customer"
],
"summary": "Update Customer",
"description": "Update a specific customer",
"operationId": "CustomerHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 220,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"customer"
],
"summary": "Delete Customer",
"description": "Delete a specific customer",
"operationId": "CustomerHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 230,
"x-stability-level": "stable"
}
},
"/customers/{customerId}/bankaccounts": {
"get": {
"tags": [
"customer"
],
"summary": "Query Customer Bank Accounts",
"description": "Query all bank accounts for a specific customer",
"operationId": "CustomerHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "CustomerHeader_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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 510,
"x-stability-level": "stable"
}
},
"/customers/{customerId}/bankaccounts/{customerBankAccountId}": {
"get": {
"tags": [
"customer"
],
"summary": "Get Customer Bank Account",
"description": "Get a specific bank account",
"operationId": "CustomerHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 505,
"x-stability-level": "stable"
},
"patch": {
"tags": [
"customer"
],
"summary": "Update Customer Bank Account",
"description": "Update a specific bank account",
"operationId": "CustomerHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 520,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"customer"
],
"summary": "Delete Customer Bank Account",
"description": "Delete a specific bank account",
"operationId": "CustomerHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 530,
"x-stability-level": "stable"
}
},
"/customers/{customerId}/contacts": {
"get": {
"tags": [
"customer"
],
"summary": "Query Customer Contacts",
"description": "Query all contacts for a specific customer",
"operationId": "CustomerHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 400,
"x-stability-level": "stable"
},
"post": {
"tags": [
"customer"
],
"summary": "Create Customer Contact",
"description": "Create a new customer contact",
"operationId": "CustomerHeader_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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 410,
"x-stability-level": "stable"
}
},
"/customers/{customerId}/contacts/{customerContactId}": {
"get": {
"tags": [
"customer"
],
"summary": "Get Customer Contact",
"description": "Get a specific contact from a customer",
"operationId": "CustomerHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 405,
"x-stability-level": "stable"
},
"patch": {
"tags": [
"customer"
],
"summary": "Update Customer Contact",
"description": "Update a specific customer contact",
"operationId": "CustomerHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 420,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"customer"
],
"summary": "Delete Customer Contact",
"description": "Delete a specific customer concact",
"operationId": "CustomerHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 430,
"x-stability-level": "stable"
}
},
"/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": "CustomerHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 710,
"x-stability-level": "stable"
}
},
"/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": "CustomerHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "CustomerHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 730,
"x-stability-level": "stable"
}
},
"/customers/{customerId}/lastChange": {
"get": {
"tags": [
"customer"
],
"summary": "Get Customer Last Change",
"description": "Get the date of the last change for a customer",
"operationId": "CustomerHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 640,
"x-stability-level": "beta"
}
},
"/customers/{customerId}/notes": {
"get": {
"tags": [
"customer"
],
"summary": "Query Customer Notes",
"description": "Query all notes for a specific customer",
"operationId": "CustomerHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 600,
"x-stability-level": "stable"
},
"post": {
"tags": [
"customer"
],
"summary": "Create Customer Note",
"description": "Create a new note for a specific customer",
"operationId": "CustomerHeader_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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 610,
"x-stability-level": "stable"
}
},
"/customers/{customerId}/notes/{noteId}": {
"patch": {
"tags": [
"customer"
],
"summary": "Update Customer Note",
"description": "Update a specific note for a customer",
"operationId": "CustomerHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 620,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"customer"
],
"summary": "Delete Customer Note",
"description": "Delete a specific note for a customer",
"operationId": "CustomerHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 630,
"x-stability-level": "stable"
},
"get": {
"tags": [
"customer"
],
"summary": "Get Customer Note",
"description": "Get a specific note from a customer",
"operationId": "CustomerHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 630,
"x-stability-level": "stable"
}
},
"/customers/{customerId}/workflow/{workflowEventId}": {
"post": {
"tags": [
"customer"
],
"summary": "Trigger Customer Workflow",
"description": "Trigger a specific workflow event for a given customer",
"operationId": "CustomerHeader_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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/customers/{customerId}/workflowEvents": {
"post": {
"tags": [
"customer"
],
"summary": "Trigger Customer Workflow Event",
"description": "Trigger a specific workflow event for a given customer",
"operationId": "CustomerHeader_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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 2010,
"x-stability-level": "stable"
}
},
"/customers/customfields": {
"get": {
"tags": [
"customer"
],
"summary": "Query Customer Custom Fields",
"description": "Query all custom fields available for a customer",
"operationId": "CustomerHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 700,
"x-stability-level": "stable"
}
},
"/customers/workflowEvents": {
"get": {
"tags": [
"customer"
],
"summary": "Query Customer Workflow Events",
"description": "Query all workflow events for customers",
"operationId": "CustomerHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 2000,
"x-stability-level": "stable"
}
},
"/deliveryNotes": {
"get": {
"tags": [
"deliverynote"
],
"summary": "Query Delivery Notes",
"description": "Query all delivery notes",
"operationId": "DeliveryNoteHeader_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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey"
},
"x-position": 2
},
{
"name": "customerId",
"in": "query",
"description": "Gets the unique identifier for the customer.",
"schema": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "draft"
}
},
"/deliveryNotes/{deliveryNoteId}": {
"get": {
"tags": [
"deliverynote"
],
"summary": "Get Delivery Note",
"description": "Get a specific delivery note",
"operationId": "DeliveryNoteHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "draft"
}
},
"/deliveryNotes/{deliveryNoteId}/output/mail": {
"post": {
"tags": [
"deliverynote"
],
"summary": "Mail Delivery Note",
"description": "Execute the mailing of a DeliveryNote",
"operationId": "DeliveryNoteHeader_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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/deliveryNotes/{deliveryNoteId}/output/pdf": {
"post": {
"tags": [
"deliverynote"
],
"summary": "Pdf Delivery Note",
"description": "Execute the pdf creation of a DeliveryNote",
"operationId": "DeliveryNoteHeader_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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/deliveryNotes/{deliveryNoteId}/output/print": {
"post": {
"tags": [
"deliverynote"
],
"summary": "Print Delivery Note",
"description": "Execute the printing of a DeliveryNote",
"operationId": "DeliveryNoteHeader_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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/deliveryNotes/{deliveryNoteId}/packages": {
"get": {
"tags": [
"deliverynote"
],
"summary": "Get Delivery Note Packages",
"description": "Get all packages for a specific delivery note",
"operationId": "DeliveryNoteHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "draft"
},
"post": {
"tags": [
"deliverynote"
],
"summary": "Post Package Data For Delivery Note",
"description": "Transmit Package Data",
"operationId": "DeliveryNoteHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "draft"
}
},
"/deliveryNotes/{deliveryNoteId}/workflow/{workflowEventId}": {
"post": {
"tags": [
"deliverynote"
],
"summary": "Trigger Delivery Note Workflow",
"description": "Trigger a specific workflow event for a given delivery Note",
"operationId": "DeliveryNoteHeader_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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/deliveryNotes/packages/{packageId}": {
"patch": {
"tags": [
"deliverynote"
],
"summary": "Patch Package Data",
"description": "Transmit Package Data",
"operationId": "DeliveryNoteHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "draft"
}
},
"/extensions": {
"get": {
"tags": [
"Extensibility"
],
"summary": "Get Extensions",
"description": "Returns the installed Extensions",
"operationId": "ExtensibilityHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "ExtensibilityHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/extensions/{extensionId}": {
"get": {
"tags": [
"Extensibility"
],
"summary": "Get Extension",
"description": "Returns the requested Extension",
"operationId": "ExtensibilityHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
},
"patch": {
"tags": [
"Extensibility"
],
"summary": "Update Extension",
"description": "Updates an Existing Extension",
"operationId": "ExtensibilityHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
},
"delete": {
"tags": [
"Extensibility"
],
"summary": "Delete Extension",
"description": "DELETE an existing Extension",
"operationId": "ExtensibilityHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/extensions/{extensionId}/manifest": {
"put": {
"tags": [
"Extensibility"
],
"summary": "Put Extension Manifest",
"description": "Push the Extension Manifest",
"operationId": "ExtensibilityHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/feature": {
"get": {
"tags": [
"features"
],
"summary": "Get Features",
"description": "Returns the available feature sets with release state and API version",
"operationId": "FeaturesHeader_GetFeaturesAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
}
],
"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"
}
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/info": {
"get": {
"tags": [
"info"
],
"summary": "Get Status",
"description": "Returns the status of the API",
"operationId": "InfoHeader_GetStatusAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/invoices": {
"get": {
"tags": [
"invoice"
],
"summary": "Query Invoices",
"description": "Query all Invoices",
"operationId": "InvoiceHeader_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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 4
},
{
"name": "customerId",
"in": "query",
"description": "Gets the unique identifier for the customer.",
"schema": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "draft"
}
},
"/invoices/{invoiceId}": {
"get": {
"tags": [
"invoice"
],
"summary": "Get Invoice",
"description": "Get a specific invoice",
"operationId": "InvoiceHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "draft"
}
},
"/invoices/{invoiceId}/lineitems": {
"get": {
"tags": [
"invoice"
],
"summary": "Query Invoice Line Items",
"description": "Query all line items for a specific invoice",
"operationId": "InvoiceHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 300,
"x-stability-level": "draft"
}
},
"/invoices/{invoiceId}/output/mail": {
"post": {
"tags": [
"invoice"
],
"summary": "Mail Invoice",
"description": "Execute the mailing of a Invoice",
"operationId": "InvoiceHeader_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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/invoices/{invoiceId}/output/pdf": {
"post": {
"tags": [
"invoice"
],
"summary": "Pdf Invoice",
"description": "Execute the pdf creation of a Invoice",
"operationId": "InvoiceHeader_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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/invoices/{invoiceId}/output/print": {
"post": {
"tags": [
"invoice"
],
"summary": "Print Invoice",
"description": "Execute the printing of a Invoice",
"operationId": "InvoiceHeader_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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/invoices/{invoiceId}/workflow/{workflowEventId}": {
"post": {
"tags": [
"invoice"
],
"summary": "Trigger Invoice Workflow",
"description": "Trigger a specific workflow event for a given invoice",
"operationId": "InvoiceHeader_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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/invoices/{invoiceId}/workflowEvents": {
"post": {
"tags": [
"invoice"
],
"summary": "Trigger Invoice Workflow Event",
"description": "Trigger a specific workflow event for a given invoice",
"operationId": "InvoiceHeader_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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 2100,
"x-stability-level": "draft"
}
},
"/invoices/cancellationReasons": {
"get": {
"tags": [
"cancellationreason"
],
"summary": "Query Invoice Cancellation Reasons",
"description": "Query all cancellation reasons for invoices",
"operationId": "InvoiceHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/invoices/workflowEvents": {
"get": {
"tags": [
"invoice"
],
"summary": "Query Invoice Workflow Events",
"description": "Query all available workflow events for invoices",
"operationId": "InvoiceHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 2000,
"x-stability-level": "draft"
}
},
"/items": {
"get": {
"tags": [
"item"
],
"summary": "Query Items",
"description": "Query all items",
"operationId": "ItemHeader_QueryItemsAsync",
"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": "A search key word which is using many important item identificators. For more info see documentation or the configuration in the search in items in JTL-Wawi.",
"schema": {
"type": "string"
},
"x-position": 1
},
{
"name": "categoryId",
"in": "query",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
},
"x-position": 2
},
{
"name": "manufacturerId",
"in": "query",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.HerstellerKey"
},
"x-position": 3
},
{
"name": "parentItemId",
"in": "query",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 4
},
{
"name": "changedSince",
"in": "query",
"description": "The date last changes were made to the item.",
"schema": {
"type": "string",
"format": "date-time"
},
"x-position": 5
},
{
"name": "isActiveOnSalesChannelId",
"in": "query",
"description": "The ID of the sales channel on which this item is active.",
"schema": {
"type": "string"
},
"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"
}
}
],
"responses": {
"200": {
"description": "Returns all items, can be filtered by searchKeyWord and postalCode.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Item.Item"
}
}
}
},
"401": {
"description": "",
"content": {
"application/json": {}
}
},
"402": {
"description": "No licence available or the app has not been authorised by JTL.",
"content": {
"application/json": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item",
"description": "Create a new item",
"operationId": "ItemHeader_CreateItemAsync",
"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"
}
}
],
"requestBody": {
"x-name": "item",
"description": "The item to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItem"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created item.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.Item"
}
}
}
},
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 210,
"x-stability-level": "stable"
}
},
"/items/{itemId}": {
"get": {
"tags": [
"item"
],
"summary": "Get Item",
"description": "Get a specific item",
"operationId": "ItemHeader_GetItemAsync",
"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,
"description": "The id of the Item to return.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "Returns the Item for the given id.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.Item"
}
}
}
},
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "stable"
},
"patch": {
"tags": [
"item"
],
"summary": "Update Item",
"description": "Update a specific item",
"operationId": "ItemHeader_UpdateItemAsync",
"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": "itemId",
"in": "path",
"required": true,
"description": "The id of the Item to update.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "item",
"description": "The item to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItem"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The updated item.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.Item"
}
}
}
},
"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 item with the given ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 220,
"x-stability-level": "stable"
}
},
"/items/{itemId}/children/{childItemId}": {
"post": {
"tags": [
"item"
],
"summary": "Assign Child Item To Parent",
"description": "Assign child items to a specific parent",
"operationId": "ItemHeader_AssignChildItemToParentAsync",
"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,
"description": "The unique id of the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 2
},
{
"name": "childItemId",
"in": "path",
"required": true,
"description": "The unique id of the item that should be assigned as a variation child to the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "variationValueIds",
"description": "The unique IDs of the variation values from the parent that should be assigned to the child. This must be an exact match and no other child can have these exact variation values.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
},
"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 ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1090,
"x-stability-level": "stable"
}
},
"/items/{itemId}/customerPrices": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Customer Prices",
"description": "Query all customer prices for a specific item",
"operationId": "ItemHeader_QueryItemCustomerPricesAsync",
"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,
"description": "The id of the item that the customer specific price belongs to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested item prices.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemCustomerPrice"
}
}
}
}
},
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1360,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item Customer Price",
"description": "Create a new customer price for a specific item",
"operationId": "ItemHeader_CreateItemCustomerPriceAsync",
"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,
"description": "The id of the item that the customer specific price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemCustomerPrice",
"description": "The item customer price to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemCustomerPrice"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created item price.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemCustomerPrice"
}
}
}
},
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1370,
"x-stability-level": "stable"
}
},
"/items/{itemId}/customerPrices/{customerId}/{fromQuantity}": {
"patch": {
"tags": [
"item"
],
"summary": "Update Item Customer Price",
"description": "Update a specific customer price for a given item",
"operationId": "ItemHeader_UpdateItemCustomerPriceAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "fromQuantity",
"in": "path",
"required": true,
"description": "The quantity the customer must buy to find the sales price.",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 2
},
{
"name": "itemId",
"in": "path",
"required": true,
"description": "The id of the item that the customer specific price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 3
},
{
"name": "customerId",
"in": "path",
"required": true,
"description": "The customer Id of the item that the customer specific price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemCustomerPrice",
"description": "The item customer price to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemCustomerPrice"
}
}
},
"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 ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1380,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Customer Price",
"description": "Delete a specific customer price for a given item",
"operationId": "ItemHeader_DeleteItemCustomerPriceAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "fromQuantity",
"in": "path",
"required": true,
"description": "The quantity for the bulk price",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 1
},
{
"name": "itemId",
"in": "path",
"required": true,
"description": "The id of the item that the customer specific price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 2
},
{
"name": "customerId",
"in": "path",
"required": true,
"description": "The customer Id of the item that the customer specific price belongs to.",
"schema": {
"$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"
}
}
],
"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 ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1390,
"x-stability-level": "stable"
}
},
"/items/{itemId}/customfields": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Custom Field Values",
"description": "Query all custom field values for a specific item",
"operationId": "ItemHeader_QueryItemCustomFieldValuesAsync",
"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,
"description": "The id of the item that the custom field belongs to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested custom fields values for an item .",
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1010,
"x-stability-level": "stable"
}
},
"/items/{itemId}/customfields/{customfieldId}": {
"patch": {
"tags": [
"item"
],
"summary": "Update Item Custom Field",
"description": "Update the value of a specific custom field for a given item",
"operationId": "ItemHeader_UpdateItemCustomFieldAsync",
"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,
"description": "The id of the item that the custom field belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 2
},
{
"name": "customfieldId",
"in": "path",
"required": true,
"description": "The id of the customfield that should be updated.",
"schema": {
"$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"
}
}
],
"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 item with the given ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1020,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Custom Field",
"description": "Delete the value for a specific custom field for a given item",
"operationId": "ItemHeader_DeleteItemCustomFieldAsync",
"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,
"description": "The id of the item that the custom field belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 1
},
{
"name": "customfieldId",
"in": "path",
"required": true,
"description": "The id of the customfield that should be updated.",
"schema": {
"$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"
}
}
],
"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 item with the given ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1030,
"x-stability-level": "stable"
}
},
"/items/{itemId}/descriptions": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Descriptions",
"description": "Query all descriptions for a specific item",
"operationId": "ItemHeader_QueryItemDescriptionsAsync",
"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,
"description": "The id of the item that the descriptions belong to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested item descriptions.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemDescription"
}
}
}
}
},
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 400,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item Description",
"description": "Create a new description for a specific item",
"operationId": "ItemHeader_CreateItemDescriptionAsync",
"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,
"description": "The id of the item that the descriptions belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemDescription",
"description": "The itemDescription to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemDescription"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created item description.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemDescription"
}
}
}
},
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 410,
"x-stability-level": "stable"
}
},
"/items/{itemId}/descriptions/{salesChannelId}/{languageIso}": {
"patch": {
"tags": [
"item"
],
"summary": "Update Item Description",
"description": "Update a specific description for a given item",
"operationId": "ItemHeader_UpdateItemDescriptionAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "salesChannelId",
"in": "path",
"required": true,
"description": "The id of the sales channel that the descriptions belong to.",
"schema": {
"type": "string"
},
"x-position": 2
},
{
"name": "languageIso",
"in": "path",
"required": true,
"description": "The iso code of the language that the descriptions belong to.",
"schema": {
"type": "string"
},
"x-position": 3
},
{
"name": "itemId",
"in": "path",
"required": true,
"description": "The id of the item that the descriptions belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemDescription",
"description": "The item to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemDescription"
}
}
},
"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 item with the given ID exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 420,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Description",
"description": "Delete a specific item description",
"operationId": "ItemHeader_DeleteItemDescriptionAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "salesChannelId",
"in": "path",
"required": true,
"description": "The id of the sales channel that the descriptions belong to.",
"schema": {
"type": "string"
},
"x-position": 1
},
{
"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": "itemId",
"in": "path",
"required": true,
"description": "The id of the item that the descriptions belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"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 item with the given ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 430,
"x-stability-level": "stable"
}
},
"/items/{itemId}/images": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Images",
"description": "Query all images for a specific item",
"operationId": "ItemHeader_QueryItemImagesAsync",
"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,
"description": "The id of the item that the descriptions belong to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested item images.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemImage"
}
}
}
}
},
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 600,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item Image",
"description": "Create a new image for a specific item",
"operationId": "ItemHeader_CreateItemImageAsync",
"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,
"description": "The id of the item that the image should belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemImage",
"description": "The ItemImage to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemImage"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created item image.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemImage"
}
}
}
},
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 620,
"x-stability-level": "stable"
}
},
"/items/{itemId}/images/{imageId}": {
"patch": {
"tags": [
"item"
],
"summary": "Update Item Image",
"description": "Update a specific image for a given item",
"operationId": "ItemHeader_UpdateItemImageAsync",
"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,
"description": "The id of the item that the descriptions belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 2
},
{
"name": "imageId",
"in": "path",
"required": true,
"description": "The id of the image.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.BildKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemImage",
"description": "The itemImage to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemImage"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The updated item image.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemImage"
}
}
}
},
"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 item with the given ID exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 630,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Image",
"description": "Delete a specific image for a given item",
"operationId": "ItemHeader_DeleteItemImageAsync",
"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,
"description": "The id of the item that the descriptions belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 1
},
{
"name": "imageId",
"in": "path",
"required": true,
"description": "The id of the image.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.BildKey"
},
"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"
}
}
],
"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 item with the given ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 640,
"x-stability-level": "stable"
}
},
"/items/{itemId}/properties": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Properties",
"description": "Query all properties for a specific item",
"operationId": "ItemHeader_QueryItemPropertiesAsync",
"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,
"description": "The id of the item that the property values belong to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested property values for the item.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemProperties"
}
}
}
},
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1200,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item Property",
"description": "Assign a property value to a specific item",
"operationId": "ItemHeader_CreateItemPropertyAsync",
"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,
"description": "The id of the item that the property values belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemPropertyValue",
"description": "The ItemPropertyValue to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemPropertyValue"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created ItemPropertyValue.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemPropertyValue"
}
}
}
},
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1210,
"x-stability-level": "stable"
}
},
"/items/{itemId}/properties/{propertyValueId}": {
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Property",
"description": "Delete properties from a specific item",
"operationId": "ItemHeader_DeleteItemPropertyAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "propertyValueId",
"in": "path",
"required": true,
"description": "The unique id of the property value.",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 1
},
{
"name": "itemId",
"in": "path",
"required": true,
"description": "The unique id of the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"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 item and property value with the given Ids exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1220,
"x-stability-level": "stable"
}
},
"/items/{itemId}/salesChannelPrices": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Sales Channel Price",
"description": "Query all sales channel prices for a specific item",
"operationId": "ItemHeader_QueryItemSalesChannelPriceAsync",
"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,
"description": "The id of the item that the sales channel prices belong to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested item prices for sales channel.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemSalesChannelPrice"
}
}
}
}
},
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1300,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item Sales Channel Price",
"description": "Create new sales channel prices for a specific item",
"operationId": "ItemHeader_CreateItemSalesChannelPriceAsync",
"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,
"description": "The id of the item that the sales channel price belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemSalesChannelPrice",
"description": "The sales channel price for an item to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemSalesChannelPrice"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created item sales channel price.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemSalesChannelPrice"
}
}
}
},
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1310,
"x-stability-level": "stable"
}
},
"/items/{itemId}/salesChannelPrices/{salesChannelId}/{customerGroupId}/{fromQuantity}": {
"patch": {
"tags": [
"item"
],
"summary": "Update Item Sales Channel Price",
"description": "Update a specific sales channel price for a given item",
"operationId": "ItemHeader_UpdateItemSalesChannelPriceAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "salesChannelId",
"in": "path",
"required": true,
"description": "The sales channel Id of the item that the sales channel price belongs to. Only online shops and JTL-POS are allowed.",
"schema": {
"type": "string"
},
"x-position": 2
},
{
"name": "fromQuantity",
"in": "path",
"required": true,
"description": "The quantity the customer must buy to find the sales price.",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 3
},
{
"name": "itemId",
"in": "path",
"required": true,
"description": "The item Id of the item that the sales channel price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 4
},
{
"name": "customerGroupId",
"in": "path",
"required": true,
"description": "The customer Group Id of the item that the sales channel price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemSalesChannelPrice",
"description": "The item sales channel price to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemSalesChannelPrice"
}
}
},
"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 ID exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1320,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Sales Channel Price",
"description": "DElete a specific sales channel price for a given item",
"operationId": "ItemHeader_DeleteItemSalesChannelPriceAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "salesChannelId",
"in": "path",
"required": true,
"description": "The sales channel Id of the item that the sales channel price belongs to. Only online shops and JTL-POS are allowed.",
"schema": {
"type": "string"
},
"x-position": 1
},
{
"name": "fromQuantity",
"in": "path",
"required": true,
"description": "The quantity the customer must buy to find the sales price.",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 2
},
{
"name": "itemId",
"in": "path",
"required": true,
"description": "The item Id of the item that the sales channel price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 3
},
{
"name": "customerGroupId",
"in": "path",
"required": true,
"description": "The customer Group Id of the item that the sales channel price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey"
},
"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"
}
}
],
"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 ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1330,
"x-stability-level": "stable"
}
},
"/items/{itemId}/specialprices": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Special Price",
"description": "Query the special prices for a specific item",
"operationId": "ItemHeader_QueryItemSpecialPriceAsync",
"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,
"description": "The id of the item that the special price details belong to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested special price details of the item .",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemSpecialPrice"
}
}
}
},
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1500,
"x-stability-level": "stable"
},
"patch": {
"tags": [
"item"
],
"summary": "Update Item Special Price",
"description": "Update the special prices for a specific item",
"operationId": "ItemHeader_UpdateItemSpecialPriceAsync",
"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,
"description": "The id of the item that the special price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemSpecialPrice",
"description": "The special price details of the item to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemSpecialPrice"
}
}
},
"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 item with the given ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1520,
"x-stability-level": "stable"
}
},
"/items/{itemId}/suppliers": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Suppliers",
"description": "Query all suppliers for a specific item",
"operationId": "ItemHeader_QueryItemSuppliersAsync",
"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,
"description": "The id of the item that the supplier belong to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested item suppliers.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemSupplier"
}
}
}
}
},
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 700,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item Supplier",
"description": "Assign a supplier to a specific item",
"operationId": "ItemHeader_CreateItemSupplierAsync",
"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,
"description": "The id of the item that the supplier belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemSupplier",
"description": "The itemSupplier to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemSupplier"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created itemSupplier.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemSupplier"
}
}
}
},
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 710,
"x-stability-level": "stable"
}
},
"/items/{itemId}/suppliers/{supplierId}": {
"patch": {
"tags": [
"item"
],
"summary": "Update Item Supplier",
"description": "Update the information for a specific supplier for a given item",
"operationId": "ItemHeader_UpdateItemSupplierAsync",
"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,
"description": "The unique id of the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 2
},
{
"name": "supplierId",
"in": "path",
"required": true,
"description": "The unique id of the supplier.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemSupplier",
"description": "The itemSupplier to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemSupplier"
}
}
},
"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 item and supplier with the given Ids exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 720,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Supplier",
"description": "Delete the connection between a specific supplier and item",
"operationId": "ItemHeader_DeleteItemSupplierAsync",
"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,
"description": "The unique id of the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 1
},
{
"name": "supplierId",
"in": "path",
"required": true,
"description": "The unique id of the supplier.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey"
},
"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"
}
}
],
"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 item and supplier with the given Ids exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 730,
"x-stability-level": "stable"
}
},
"/items/{itemId}/variations": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Variations",
"description": "Query all variations for a specific item",
"operationId": "ItemHeader_QueryItemVariationsAsync",
"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,
"description": "The id of the item that the variations belong to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested item variations.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemVariation"
}
}
}
}
},
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1000,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item Variation",
"description": "Create a new variation for a specific item",
"operationId": "ItemHeader_CreateItemVariationAsync",
"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,
"description": "The id of the item that the supplier belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemVariation",
"description": "The ItemVariation to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemVariation"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created ItemVariation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemVariation"
}
}
}
},
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1010,
"x-stability-level": "stable"
}
},
"/items/{itemId}/variations/{variationId}": {
"patch": {
"tags": [
"item"
],
"summary": "Update Item Variation",
"description": "Update a specific variation for a given item",
"operationId": "ItemHeader_UpdateItemVariationAsync",
"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,
"description": "The unique id of the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 2
},
{
"name": "variationId",
"in": "path",
"required": true,
"description": "The unique id of the variation.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemVariation",
"description": "The ItemVariation to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemVariation"
}
}
},
"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 item and variation with the given Ids exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1020,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Variation",
"description": "Delete a specific variation for a given item",
"operationId": "ItemHeader_DeleteItemVariationAsync",
"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,
"description": "The unique id of the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 1
},
{
"name": "variationId",
"in": "path",
"required": true,
"description": "The unique id of the variation.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey"
},
"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"
}
}
],
"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 item and variation with the given Ids exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1030,
"x-stability-level": "stable"
}
},
"/items/{itemId}/variations/{variationId}/values": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Variation Values",
"description": "Query all values for a specific item variation",
"operationId": "ItemHeader_QueryItemVariationValuesAsync",
"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,
"description": "The id of the item that the variations belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 1
},
{
"name": "variationId",
"in": "path",
"required": true,
"description": "The unique id of the variation.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey"
},
"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"
}
}
],
"responses": {
"200": {
"description": "The requested values for the item variation.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemVariationValue"
}
}
}
}
},
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1040,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item Variation Value",
"description": "Create new values for a specific item variation",
"operationId": "ItemHeader_CreateItemVariationValueAsync",
"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,
"description": "The id of the item that the supplier belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 2
},
{
"name": "variationId",
"in": "path",
"required": true,
"description": "The unique id of the variation.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemVariationValue",
"description": "The ItemVariationValue to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemVariationValue"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created ItemVariationValue.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemVariationValue"
}
}
}
},
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1050,
"x-stability-level": "stable"
}
},
"/items/{itemId}/variations/{variationId}/values/{variationValueId}": {
"patch": {
"tags": [
"item"
],
"summary": "Update Item Variation Value",
"description": "Update the value for a specific item variation",
"operationId": "ItemHeader_UpdateItemVariationValueAsync",
"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,
"description": "The unique id of the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 2
},
{
"name": "variationId",
"in": "path",
"required": true,
"description": "The unique id of the variation.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey"
},
"x-position": 3
},
{
"name": "variationValueId",
"in": "path",
"required": true,
"description": "The unique id of the variation value.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationWertKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemVariationValue",
"description": "The ItemVariationValue to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemVariationValue"
}
}
},
"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 item and variation or variation value with the given Ids exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1060,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Variation Value",
"description": "Delete a specific value for a item variation",
"operationId": "ItemHeader_DeleteItemVariationValueAsync",
"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,
"description": "The unique id of the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 1
},
{
"name": "variationId",
"in": "path",
"required": true,
"description": "The unique id of the variation.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey"
},
"x-position": 2
},
{
"name": "variationValueId",
"in": "path",
"required": true,
"description": "The unique id of the variation value.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationWertKey"
},
"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"
}
}
],
"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 item and variation or variation value with the given Ids exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1070,
"x-stability-level": "stable"
}
},
"/items/{itemId}/workflow/{workflowEventId}": {
"post": {
"tags": [
"item"
],
"summary": "Trigger Item Workflow",
"description": "Trigger a specific workflow event for a given item",
"operationId": "ItemHeader_TriggerItemWorkflowAsync",
"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.Item.ItemWorkflowEvent"
},
"x-position": 1
},
{
"name": "itemId",
"in": "path",
"required": true,
"description": "The id of the item for that the manual workflow event should be started.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/items/{itemId}/workflowEvents": {
"post": {
"tags": [
"item"
],
"summary": "Trigger Item Workflow Event",
"description": "Trigger a specific workflow event for a given item",
"operationId": "ItemHeader_TriggerItemWorkflowEventAsync",
"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,
"description": "The id of the item for that the manual workflow event should be started.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/items/customfields": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Custom Fields",
"description": "Query all custom fields for items",
"operationId": "ItemHeader_QueryItemCustomFieldsAsync",
"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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1000,
"x-stability-level": "stable"
}
},
"/items/imagedata/{imageId}": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Image Data",
"description": "Query the data for a specific item image",
"operationId": "ItemHeader_QueryItemImageDataAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "imageId",
"in": "path",
"required": true,
"description": "The id of the image.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.BildKey"
},
"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"
}
}
],
"responses": {
"200": {
"description": "The requested item 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 image could be found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 610,
"x-stability-level": "stable"
}
},
"/items/workflowEvents": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Workflow Events",
"description": "Query all workflow events for items",
"operationId": "ItemHeader_QueryItemWorkflowEventsAsync",
"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"
}
}
],
"responses": {
"200": {
"description": "All manual workflow events for items 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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5000,
"x-stability-level": "stable"
}
},
"/manufacturers": {
"get": {
"tags": [
"item"
],
"summary": "Query Manufacturers",
"description": "Query all manufacturers",
"operationId": "ManufacturerHeader_QueryManufacturersAsync",
"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"
}
}
],
"responses": {
"200": {
"description": "Returns all manufacturers.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Manufacturer.Manufacturer"
}
}
}
}
},
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/offer/{offerId}/output/mail": {
"post": {
"tags": [
"offer"
],
"summary": "Mail Offer",
"description": "Execute the mailing of a Offer",
"operationId": "OfferHeader_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": {
"$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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AngebotKey"
},
"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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/offer/{offerId}/output/pdf": {
"post": {
"tags": [
"offer"
],
"summary": "Pdf Offer",
"description": "Execute the pdf creation of a Offer",
"operationId": "OfferHeader_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": {
"$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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AngebotKey"
},
"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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/offer/{offerId}/output/print": {
"post": {
"tags": [
"offer"
],
"summary": "Print Offer",
"description": "Execute the printing of a Offer",
"operationId": "OfferHeader_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": {
"$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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AngebotKey"
},
"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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/onHoldReasons": {
"get": {
"tags": [
"onholdreason"
],
"summary": "Query On Hold Reasons",
"description": "Query all on hold reasons for sales orders",
"operationId": "OnHoldReasonHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/paymentMethods": {
"get": {
"tags": [
"paymentmethod"
],
"summary": "Query Payment Methods",
"description": "Query all payment methods",
"operationId": "PaymentMethodHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/printers": {
"get": {
"tags": [
"printer"
],
"summary": "Installed Printers",
"description": "Returns all Installed Printers",
"operationId": "PrintersHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "beta"
}
},
"/productGroups": {
"get": {
"tags": [
"item"
],
"summary": "Query Product Groups",
"description": "Query all product groups",
"operationId": "ProductGroupHeader_QueryProductGroupsAsync",
"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"
}
}
],
"responses": {
"200": {
"description": "Returns all product groups.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.ProductGroup.ProductGroup"
}
}
}
}
},
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/properties": {
"get": {
"tags": [
"property"
],
"summary": "Query Properties",
"description": "Query all properties for items",
"operationId": "PropertyHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "stable"
},
"post": {
"tags": [
"property"
],
"summary": "Create Property",
"description": "Create a new property",
"operationId": "PropertyHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 110,
"x-stability-level": "stable"
}
},
"/properties/{propertyId}/values": {
"get": {
"tags": [
"property"
],
"summary": "Query Property Values",
"description": "Query all velues for a specific property",
"operationId": "PropertyHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 300,
"x-stability-level": "stable"
},
"post": {
"tags": [
"property"
],
"summary": "Create Property Value",
"description": "Create a new value for a specific property",
"operationId": "PropertyHeader_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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 310,
"x-stability-level": "stable"
}
},
"/properties/{propertyId}/values/{propertyValueId}": {
"patch": {
"tags": [
"property"
],
"summary": "Update Property Value",
"description": "Update the value of a specific property",
"operationId": "PropertyHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 320,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"property"
],
"summary": "Delete Property Value",
"description": "Delete a specific value for a given property",
"operationId": "PropertyHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 330,
"x-stability-level": "stable"
}
},
"/properties/{propertyId}/values/{propertyValueId}/descriptions": {
"get": {
"tags": [
"property"
],
"summary": "Query Property Value Descriptions",
"description": "Query all descriptions for a specific property value",
"operationId": "PropertyHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "PropertyHeader_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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 410,
"x-stability-level": "stable"
}
},
"/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": "PropertyHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "PropertyHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 430,
"x-stability-level": "stable"
}
},
"/properties/groups": {
"get": {
"tags": [
"property"
],
"summary": "Query Property Groups",
"description": "Query all groups for properties",
"operationId": "PropertyHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "stable"
},
"post": {
"tags": [
"property"
],
"summary": "Create Property Group",
"description": "Create a new property group",
"operationId": "PropertyHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 210,
"x-stability-level": "stable"
}
},
"/refunds/cancellationReasons": {
"get": {
"tags": [
"cancellationreason"
],
"summary": "Query Refund Cancellation Reasons",
"description": "Query all cancellation reasons for refunds",
"operationId": "RefundHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/responsiblePersons": {
"get": {
"tags": [
"item"
],
"summary": "Query Responsible Persons",
"description": "Query all ResponsiblePerson",
"operationId": "ResponsiblePersonHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "beta"
}
},
"/returnReasons": {
"get": {
"tags": [
"returnreason"
],
"summary": "Query Return Reasons",
"description": "Query all return reasons",
"operationId": "ReturnReasonHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/returns": {
"post": {
"tags": [
"return"
],
"summary": "Create Return",
"description": "Create a new return with associated items and packages.",
"operationId": "ReturnHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 400,
"x-stability-level": "beta"
},
"get": {
"tags": [
"return"
],
"summary": "Query Returns",
"description": "Query all returns",
"operationId": "ReturnHeader_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": {
"$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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey"
},
"x-position": 4
},
{
"name": "returnStateId",
"in": "query",
"schema": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "draft"
}
},
"/returns/{returnId}": {
"get": {
"tags": [
"return"
],
"summary": "Get Return",
"description": "Get a specific return",
"operationId": "ReturnHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "draft"
}
},
"/returns/{returnId}/lineitems": {
"get": {
"tags": [
"return"
],
"summary": "Query Return Line Items",
"description": "Query all line items for a specific return",
"operationId": "ReturnHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 300,
"x-stability-level": "draft"
}
},
"/returns/{returnId}/packages": {
"get": {
"tags": [
"return"
],
"summary": "Query Return Packages",
"description": "Query all packages for a specific return",
"operationId": "ReturnHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 400,
"x-stability-level": "draft"
}
},
"/returnStates": {
"get": {
"tags": [
"returnstate"
],
"summary": "Query Return States",
"description": "Query all return states",
"operationId": "ReturnStateHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/salesChannels": {
"get": {
"tags": [
"saleschannel"
],
"summary": "Get Sales Channels",
"description": "Get all sales channels",
"operationId": "SalesChannelHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/salesInvoiceCorrections/cancellationReasons": {
"get": {
"tags": [
"cancellationreason"
],
"summary": "Query Sales Invoice Correction Cancellation Reasons",
"description": "Query all cancellation reasons for sales invoice corrections",
"operationId": "SalesInvoiceCorrectionHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/salesOrders": {
"get": {
"tags": [
"salesorder"
],
"summary": "Query Sales Orders",
"description": "Query all sales orders",
"operationId": "SalesOrderHeader_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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 4
},
{
"name": "customerId",
"in": "query",
"description": "Gets the unique identifier for the customer.",
"schema": {
"$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": {
"$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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.BenutzerKey"
},
"x-position": 10
},
{
"name": "companyId",
"in": "query",
"description": "Gets the unique identifier for the firm.",
"schema": {
"$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": {
"$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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "stable"
},
"post": {
"tags": [
"salesorder"
],
"summary": "Create Sales Order",
"description": "Create a new sales order",
"operationId": "SalesOrderHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 210,
"x-stability-level": "stable"
}
},
"/salesOrders/{salesOrderId}": {
"get": {
"tags": [
"salesorder"
],
"summary": "Get Sales Order",
"description": "Get a specific sales order",
"operationId": "SalesOrderHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "stable"
},
"patch": {
"tags": [
"salesorder"
],
"summary": "Update Sales Order",
"description": "Update a specific sales order",
"operationId": "SalesOrderHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 220,
"x-stability-level": "stable"
}
},
"/salesOrders/{salesOrderId}/cancel": {
"post": {
"tags": [
"salesorder"
],
"summary": "Cancel Sales Order",
"description": "Cancel a specific sales order",
"operationId": "SalesOrderHeader_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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1000,
"x-stability-level": "stable"
}
},
"/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": "SalesOrderHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 710,
"x-stability-level": "stable"
}
},
"/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": "SalesOrderHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "SalesOrderHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 730,
"x-stability-level": "stable"
}
},
"/salesOrders/{salesOrderId}/files": {
"get": {
"tags": [
"salesorder"
],
"summary": "Query Sales Order Files",
"description": "Query all files for a specific sales order",
"operationId": "SalesOrderHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "SalesOrderHeader_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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 520,
"x-stability-level": "stable"
}
},
"/salesOrders/{salesOrderId}/files/{salesOrderFileId}": {
"get": {
"tags": [
"salesorder"
],
"summary": "Query Sales Order File Data",
"description": "Query the data for a specific sales order file",
"operationId": "SalesOrderHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "SalesOrderHeader_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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "SalesOrderHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 530,
"x-stability-level": "stable"
}
},
"/salesOrders/{salesOrderId}/lineitems": {
"get": {
"tags": [
"salesorder"
],
"summary": "Query Sales Order Line Items",
"description": "Query all line items for a specific sales order",
"operationId": "SalesOrderHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "SalesOrderHeader_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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 310,
"x-stability-level": "stable"
}
},
"/salesOrders/{salesOrderId}/lineitems/{salesOrderLineItemId}": {
"patch": {
"tags": [
"salesorder"
],
"summary": "Update Sales Order Line Item",
"description": "Update a line item for a specific sales order",
"operationId": "SalesOrderHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "SalesOrderHeader_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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 330,
"x-stability-level": "stable"
}
},
"/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": "SalesOrderHeader_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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "SalesOrderHeader_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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 520,
"x-stability-level": "stable"
}
},
"/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": "SalesOrderHeader_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": {
"$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": {
"$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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "SalesOrderHeader_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": {
"$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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey"
},
"x-position": 2
},
{
"name": "salesOrderLineItemFileId",
"in": "path",
"required": true,
"description": "Delete a specific file.",
"schema": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "SalesOrderHeader_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": {
"$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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 540,
"x-stability-level": "stable"
}
},
"/salesOrders/{salesOrderId}/notes": {
"get": {
"tags": [
"salesorder"
],
"summary": "Query Sales Order Notes",
"description": "Query all notes for a specific sales order",
"operationId": "SalesOrderHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "SalesOrderHeader_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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 410,
"x-stability-level": "stable"
}
},
"/salesOrders/{salesOrderId}/notes/{noteId}": {
"patch": {
"tags": [
"salesorder"
],
"summary": "Update Sales Order Note",
"description": "Update a specific note for a given sales order",
"operationId": "SalesOrderHeader_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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey"
},
"x-position": 2
},
{
"name": "noteId",
"in": "path",
"required": true,
"description": "The id of the note.",
"schema": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "SalesOrderHeader_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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey"
},
"x-position": 1
},
{
"name": "noteId",
"in": "path",
"required": true,
"description": "The id of the note.",
"schema": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 730,
"x-stability-level": "stable"
}
},
"/salesOrders/{salesOrderId}/output/mail": {
"post": {
"tags": [
"salesorder"
],
"summary": "Mail Sales Order",
"description": "Execute the mailing of a SalesOrder",
"operationId": "SalesOrderHeader_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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/salesOrders/{salesOrderId}/output/pdf": {
"post": {
"tags": [
"salesorder"
],
"summary": "Pdf Sales Order",
"description": "Execute the pdf creation of a SalesOrder",
"operationId": "SalesOrderHeader_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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/salesOrders/{salesOrderId}/output/print": {
"post": {
"tags": [
"salesorder"
],
"summary": "Print Sales Order",
"description": "Execute the printing of a SalesOrder",
"operationId": "SalesOrderHeader_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": {
"$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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/salesOrders/{salesOrderId}/workflow/{workflowEventId}": {
"post": {
"tags": [
"salesorder"
],
"summary": "Trigger Sales Order Workflow",
"description": "Trigger a specific workflow event for a given sales order",
"operationId": "SalesOrderHeader_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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/salesOrders/{salesOrderId}/workflowEvents": {
"post": {
"tags": [
"salesorder"
],
"summary": "Trigger Sales Order Workflow Event",
"description": "Trigger a specific workflow event for a given sales order",
"operationId": "SalesOrderHeader_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": {
"$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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 2100,
"x-stability-level": "stable"
}
},
"/salesOrders/cancellationReasons": {
"get": {
"tags": [
"cancellationreason"
],
"summary": "Query Sales Order Cancellation Reasons",
"description": "Query all cancellation reasons for sales orders",
"operationId": "SalesOrderHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/salesOrders/customfields": {
"get": {
"tags": [
"salesorder"
],
"summary": "Query Sales Order Custom Fields",
"description": "Query all custom fields for a sales order",
"operationId": "SalesOrderHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 700,
"x-stability-level": "stable"
}
},
"/salesOrders/workflowEvents": {
"get": {
"tags": [
"salesorder"
],
"summary": "Query Sales Order Workflow Events",
"description": "Query all available workflow events for sales orders",
"operationId": "SalesOrderHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 2000,
"x-stability-level": "stable"
}
},
"/shippingClasses": {
"get": {
"tags": [
"item"
],
"summary": "Query Shipping Classes",
"description": "Query all shipping classes",
"operationId": "ShippingClassHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/shippingMethods": {
"get": {
"tags": [
"shippingmethod"
],
"summary": "Query Shipping Methods",
"description": "Query all shipping methods",
"operationId": "ShippingMethodHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/stocks": {
"get": {
"tags": [
"stock"
],
"summary": "Query Stocks Per Item",
"description": "Query stocks for a specific item, warehouse or storage location",
"operationId": "StockHeader_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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 1
},
{
"name": "warehouseId",
"in": "query",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey"
},
"x-position": 2
},
{
"name": "storageLocationId",
"in": "query",
"schema": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "StockHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 400,
"x-stability-level": "stable"
}
},
"/stocks/changes": {
"get": {
"tags": [
"stock"
],
"summary": "Query Stock Changes",
"description": "Returns all stock changes for a specific item from a given start date",
"operationId": "StockHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 300,
"x-stability-level": "stable"
}
},
"/stocks/serialnumbers": {
"get": {
"tags": [
"stock"
],
"summary": "Query Serial Number Per Warehouse",
"description": "Query the serial numbers for a specific item and warehouse",
"operationId": "StockHeader_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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 1
},
{
"name": "warehouseId",
"in": "query",
"schema": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 500,
"x-stability-level": "stable"
}
},
"/suppliers": {
"get": {
"tags": [
"supplier"
],
"summary": "Query Suppliers",
"description": "Query all suppliers",
"operationId": "SupplierHeader_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": "x-runas",
"in": "header",
"description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns all suppliers.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/tax/item/{itemId}/{companyId}/{departureCountryISO}/{shipmentCountryISO}": {
"get": {
"tags": [
"tax"
],
"summary": "Get Tax For Item",
"description": "Returns the Taxrate for the given Item",
"operationId": "TaxHeader_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": {
"$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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey"
},
"x-position": 8
}
],
"responses": {
"200": {
"description": "The TaxRate for the given Item.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Tax.TaxRate"
}
}
}
},
"404": {
"description": "No item with the given ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/tax/taxclass/{taxClassId}/{companyId}/{departureCountryISO}/{shipmentCountryISO}": {
"get": {
"tags": [
"tax"
],
"summary": "Get Tax For Tax Class",
"description": "Returns the Taxrate for the given Item",
"operationId": "TaxHeader_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": {
"$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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey"
},
"x-position": 8
}
],
"responses": {
"200": {
"description": "The TaxRate for the given TaxClassId.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Tax.TaxRate"
}
}
}
},
"404": {
"description": "No TaxClass with the given ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/taxClasses": {
"get": {
"tags": [
"item"
],
"summary": "Query Tax Classes",
"description": "Query all tax classes",
"operationId": "TaxClassHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/transactionStatuses": {
"get": {
"tags": [
"transactionStatus"
],
"summary": "Query Transaction Status",
"description": "Query all transaction status for sales order",
"operationId": "TransactionStatusHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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.V1.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"
}
}
],
"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.V1.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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "draft"
}
},
"/v1/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"
}
},
"/v1/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"
}
},
"/v1/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"
}
},
"/v1/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"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/categories": {
"get": {
"tags": [
"category"
],
"summary": "Query Categories",
"description": "Query all categories",
"operationId": "Category_QueryCategoriesAsync",
"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"
}
}
],
"responses": {
"200": {
"description": "Returns all categories.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Category.Category"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "stable"
},
"post": {
"tags": [
"category"
],
"summary": "Create Category",
"description": "Create a new category",
"operationId": "Category_CreateCategoryAsync",
"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"
}
}
],
"requestBody": {
"x-name": "category",
"description": "The category to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.CreateCategory"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created category.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.Category"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 210,
"x-stability-level": "stable"
}
},
"/v1/categories/{categoryId}": {
"get": {
"tags": [
"category"
],
"summary": "Get Category",
"description": "Get a specific category",
"operationId": "Category_GetCategoryAsync",
"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",
"in": "path",
"required": true,
"description": "The id of the category to return.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "Returns the category for the given id.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.Category"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "stable"
},
"patch": {
"tags": [
"category"
],
"summary": "Update Category",
"description": "Update a specific category",
"operationId": "Category_UpdateCategoryAsync",
"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",
"in": "path",
"required": true,
"description": "The id of the category to update.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "category",
"description": "The category to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.UpdateCategory"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The updated category.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.Category"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 220,
"x-stability-level": "stable"
}
},
"/v1/categories/{categoryId}/descriptions": {
"get": {
"tags": [
"category"
],
"summary": "Query Category Descriptions",
"description": "Query all descriptions for a specific category",
"operationId": "Category_QueryCategoryDescriptionsAsync",
"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",
"in": "path",
"required": true,
"description": "The id of the category that the descriptions belong to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested category descriptions.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.CategoryDescription"
}
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 300,
"x-stability-level": "stable"
},
"post": {
"tags": [
"category"
],
"summary": "Create Category Description",
"description": "Create a new description for a specific category",
"operationId": "Category_CreateCategoryDescriptionAsync",
"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",
"in": "path",
"required": true,
"description": "The id of the category that the descriptions belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "categoryDescription",
"description": "The categoryDescription to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.CreateCategoryDescription"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created category description.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.CategoryDescription"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 310,
"x-stability-level": "stable"
}
},
"/v1/categories/{categoryId}/descriptions/{salesChannelId}/{languageIso}": {
"patch": {
"tags": [
"category"
],
"summary": "Update Category Description",
"description": "Update a description for a specific category",
"operationId": "Category_UpdateCategoryDescriptionAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "salesChannelId",
"in": "path",
"required": true,
"description": "The id of the sales channel that the descriptions belong to.",
"schema": {
"type": "string"
},
"x-position": 2
},
{
"name": "languageIso",
"in": "path",
"required": true,
"description": "The iso code of the language that the descriptions belong to.",
"schema": {
"type": "string"
},
"x-position": 3
},
{
"name": "categoryId",
"in": "path",
"required": true,
"description": "The id of the category that the descriptions belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "categoryDescription",
"description": "The category to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Category.UpdateCategoryDescription"
}
}
},
"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 category with the given ID exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 320,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"category"
],
"summary": "Delete Category Description",
"description": "Delete a description for a specific category",
"operationId": "Category_DeleteCategoryDescriptionAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "salesChannelId",
"in": "path",
"required": true,
"description": "The id of the sales channel that the descriptions belong to.",
"schema": {
"type": "string"
},
"x-position": 1
},
{
"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": "categoryId",
"in": "path",
"required": true,
"description": "The id of the category that the descriptions belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
},
"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"
}
}
],
"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 category with the given ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 330,
"x-stability-level": "stable"
}
},
"/v1/categories/{categoryId}/items": {
"post": {
"tags": [
"category"
],
"summary": "Add Category Items",
"description": "Add items to a specific category",
"operationId": "Category_AddCategoryItemsAsync",
"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",
"in": "path",
"required": true,
"description": "The id of the category where the items should be assigned.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "items",
"description": "The item Ids to be assigned to the category.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The assigned item ids.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1000,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey"
},
"x-position": 3
},
{
"name": "categoryId",
"in": "query",
"schema": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 210,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 230,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 510,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 530,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 410,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 430,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 710,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 730,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 640,
"x-stability-level": "beta"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 610,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 630,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 2010,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 700,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 2000,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey"
},
"x-position": 2
},
{
"name": "customerId",
"in": "query",
"description": "Gets the unique identifier for the customer.",
"schema": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "draft"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "draft"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "draft"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "draft"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/v1/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."
}
]
}
},
"/v1/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."
}
]
}
},
"/v1/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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 4
},
{
"name": "customerId",
"in": "query",
"description": "Gets the unique identifier for the customer.",
"schema": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "draft"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "draft"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 300,
"x-stability-level": "draft"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 2100,
"x-stability-level": "draft"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 2000,
"x-stability-level": "draft"
}
},
"/v1/items": {
"get": {
"tags": [
"item"
],
"summary": "Query Items",
"description": "Query all items",
"operationId": "Item_QueryItemsAsync",
"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": "A search key word which is using many important item identificators. For more info see documentation or the configuration in the search in items in JTL-Wawi.",
"schema": {
"type": "string"
},
"x-position": 1
},
{
"name": "categoryId",
"in": "query",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
},
"x-position": 2
},
{
"name": "manufacturerId",
"in": "query",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.HerstellerKey"
},
"x-position": 3
},
{
"name": "parentItemId",
"in": "query",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 4
},
{
"name": "changedSince",
"in": "query",
"description": "The date last changes were made to the item.",
"schema": {
"type": "string",
"format": "date-time"
},
"x-position": 5
},
{
"name": "isActiveOnSalesChannelId",
"in": "query",
"description": "The ID of the sales channel on which this item is active.",
"schema": {
"type": "string"
},
"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"
}
}
],
"responses": {
"200": {
"description": "Returns all items, can be filtered by searchKeyWord and postalCode.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Item.Item"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item",
"description": "Create a new item",
"operationId": "Item_CreateItemAsync",
"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"
}
}
],
"requestBody": {
"x-name": "item",
"description": "The item to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItem"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created item.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.Item"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 210,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}": {
"get": {
"tags": [
"item"
],
"summary": "Get Item",
"description": "Get a specific item",
"operationId": "Item_GetItemAsync",
"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,
"description": "The id of the Item to return.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "Returns the Item for the given id.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.Item"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "stable"
},
"patch": {
"tags": [
"item"
],
"summary": "Update Item",
"description": "Update a specific item",
"operationId": "Item_UpdateItemAsync",
"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": "itemId",
"in": "path",
"required": true,
"description": "The id of the Item to update.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "item",
"description": "The item to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItem"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The updated item.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.Item"
}
}
}
},
"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 item with the given ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 220,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/children/{childItemId}": {
"post": {
"tags": [
"item"
],
"summary": "Assign Child Item To Parent",
"description": "Assign child items to a specific parent",
"operationId": "Item_AssignChildItemToParentAsync",
"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,
"description": "The unique id of the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 2
},
{
"name": "childItemId",
"in": "path",
"required": true,
"description": "The unique id of the item that should be assigned as a variation child to the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "variationValueIds",
"description": "The unique IDs of the variation values from the parent that should be assigned to the child. This must be an exact match and no other child can have these exact variation values.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
},
"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 ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1090,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/customerPrices": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Customer Prices",
"description": "Query all customer prices for a specific item",
"operationId": "Item_QueryItemCustomerPricesAsync",
"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,
"description": "The id of the item that the customer specific price belongs to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested item prices.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemCustomerPrice"
}
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1360,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item Customer Price",
"description": "Create a new customer price for a specific item",
"operationId": "Item_CreateItemCustomerPriceAsync",
"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,
"description": "The id of the item that the customer specific price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemCustomerPrice",
"description": "The item customer price to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemCustomerPrice"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created item price.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemCustomerPrice"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1370,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/customerPrices/{customerId}/{fromQuantity}": {
"patch": {
"tags": [
"item"
],
"summary": "Update Item Customer Price",
"description": "Update a specific customer price for a given item",
"operationId": "Item_UpdateItemCustomerPriceAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "fromQuantity",
"in": "path",
"required": true,
"description": "The quantity the customer must buy to find the sales price.",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 2
},
{
"name": "itemId",
"in": "path",
"required": true,
"description": "The id of the item that the customer specific price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 3
},
{
"name": "customerId",
"in": "path",
"required": true,
"description": "The customer Id of the item that the customer specific price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemCustomerPrice",
"description": "The item customer price to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemCustomerPrice"
}
}
},
"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 ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1380,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Customer Price",
"description": "Delete a specific customer price for a given item",
"operationId": "Item_DeleteItemCustomerPriceAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "fromQuantity",
"in": "path",
"required": true,
"description": "The quantity for the bulk price",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 1
},
{
"name": "itemId",
"in": "path",
"required": true,
"description": "The id of the item that the customer specific price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 2
},
{
"name": "customerId",
"in": "path",
"required": true,
"description": "The customer Id of the item that the customer specific price belongs to.",
"schema": {
"$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"
}
}
],
"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 ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1390,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/customfields": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Custom Field Values",
"description": "Query all custom field values for a specific item",
"operationId": "Item_QueryItemCustomFieldValuesAsync",
"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,
"description": "The id of the item that the custom field belongs to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested custom fields values for an item .",
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1010,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/customfields/{customfieldId}": {
"patch": {
"tags": [
"item"
],
"summary": "Update Item Custom Field",
"description": "Update the value of a specific custom field for a given item",
"operationId": "Item_UpdateItemCustomFieldAsync",
"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,
"description": "The id of the item that the custom field belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 2
},
{
"name": "customfieldId",
"in": "path",
"required": true,
"description": "The id of the customfield that should be updated.",
"schema": {
"$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"
}
}
],
"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 item with the given ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1020,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Custom Field",
"description": "Delete the value for a specific custom field for a given item",
"operationId": "Item_DeleteItemCustomFieldAsync",
"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,
"description": "The id of the item that the custom field belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 1
},
{
"name": "customfieldId",
"in": "path",
"required": true,
"description": "The id of the customfield that should be updated.",
"schema": {
"$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"
}
}
],
"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 item with the given ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1030,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/descriptions": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Descriptions",
"description": "Query all descriptions for a specific item",
"operationId": "Item_QueryItemDescriptionsAsync",
"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,
"description": "The id of the item that the descriptions belong to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested item descriptions.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemDescription"
}
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 400,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item Description",
"description": "Create a new description for a specific item",
"operationId": "Item_CreateItemDescriptionAsync",
"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,
"description": "The id of the item that the descriptions belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemDescription",
"description": "The itemDescription to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemDescription"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created item description.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemDescription"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 410,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/descriptions/{salesChannelId}/{languageIso}": {
"patch": {
"tags": [
"item"
],
"summary": "Update Item Description",
"description": "Update a specific description for a given item",
"operationId": "Item_UpdateItemDescriptionAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "salesChannelId",
"in": "path",
"required": true,
"description": "The id of the sales channel that the descriptions belong to.",
"schema": {
"type": "string"
},
"x-position": 2
},
{
"name": "languageIso",
"in": "path",
"required": true,
"description": "The iso code of the language that the descriptions belong to.",
"schema": {
"type": "string"
},
"x-position": 3
},
{
"name": "itemId",
"in": "path",
"required": true,
"description": "The id of the item that the descriptions belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemDescription",
"description": "The item to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemDescription"
}
}
},
"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 item with the given ID exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 420,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Description",
"description": "Delete a specific item description",
"operationId": "Item_DeleteItemDescriptionAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "salesChannelId",
"in": "path",
"required": true,
"description": "The id of the sales channel that the descriptions belong to.",
"schema": {
"type": "string"
},
"x-position": 1
},
{
"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": "itemId",
"in": "path",
"required": true,
"description": "The id of the item that the descriptions belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"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 item with the given ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 430,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/images": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Images",
"description": "Query all images for a specific item",
"operationId": "Item_QueryItemImagesAsync",
"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,
"description": "The id of the item that the descriptions belong to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested item images.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemImage"
}
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 600,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item Image",
"description": "Create a new image for a specific item",
"operationId": "Item_CreateItemImageAsync",
"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,
"description": "The id of the item that the image should belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemImage",
"description": "The ItemImage to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemImage"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created item image.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemImage"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 620,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/images/{imageId}": {
"patch": {
"tags": [
"item"
],
"summary": "Update Item Image",
"description": "Update a specific image for a given item",
"operationId": "Item_UpdateItemImageAsync",
"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,
"description": "The id of the item that the descriptions belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 2
},
{
"name": "imageId",
"in": "path",
"required": true,
"description": "The id of the image.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.BildKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemImage",
"description": "The itemImage to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemImage"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The updated item image.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemImage"
}
}
}
},
"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 item with the given ID exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 630,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Image",
"description": "Delete a specific image for a given item",
"operationId": "Item_DeleteItemImageAsync",
"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,
"description": "The id of the item that the descriptions belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 1
},
{
"name": "imageId",
"in": "path",
"required": true,
"description": "The id of the image.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.BildKey"
},
"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"
}
}
],
"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 item with the given ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 640,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/properties": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Properties",
"description": "Query all properties for a specific item",
"operationId": "Item_QueryItemPropertiesAsync",
"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,
"description": "The id of the item that the property values belong to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested property values for the item.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemProperties"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1200,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item Property",
"description": "Assign a property value to a specific item",
"operationId": "Item_CreateItemPropertyAsync",
"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,
"description": "The id of the item that the property values belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemPropertyValue",
"description": "The ItemPropertyValue to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemPropertyValue"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created ItemPropertyValue.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemPropertyValue"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1210,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/properties/{propertyValueId}": {
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Property",
"description": "Delete properties from a specific item",
"operationId": "Item_DeleteItemPropertyAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "propertyValueId",
"in": "path",
"required": true,
"description": "The unique id of the property value.",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 1
},
{
"name": "itemId",
"in": "path",
"required": true,
"description": "The unique id of the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"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 item and property value with the given Ids exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1220,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/salesChannelPrices": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Sales Channel Price",
"description": "Query all sales channel prices for a specific item",
"operationId": "Item_QueryItemSalesChannelPriceAsync",
"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,
"description": "The id of the item that the sales channel prices belong to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested item prices for sales channel.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemSalesChannelPrice"
}
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1300,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item Sales Channel Price",
"description": "Create new sales channel prices for a specific item",
"operationId": "Item_CreateItemSalesChannelPriceAsync",
"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,
"description": "The id of the item that the sales channel price belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemSalesChannelPrice",
"description": "The sales channel price for an item to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemSalesChannelPrice"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created item sales channel price.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemSalesChannelPrice"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1310,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/salesChannelPrices/{salesChannelId}/{customerGroupId}/{fromQuantity}": {
"patch": {
"tags": [
"item"
],
"summary": "Update Item Sales Channel Price",
"description": "Update a specific sales channel price for a given item",
"operationId": "Item_UpdateItemSalesChannelPriceAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "salesChannelId",
"in": "path",
"required": true,
"description": "The sales channel Id of the item that the sales channel price belongs to. Only online shops and JTL-POS are allowed.",
"schema": {
"type": "string"
},
"x-position": 2
},
{
"name": "fromQuantity",
"in": "path",
"required": true,
"description": "The quantity the customer must buy to find the sales price.",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 3
},
{
"name": "itemId",
"in": "path",
"required": true,
"description": "The item Id of the item that the sales channel price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 4
},
{
"name": "customerGroupId",
"in": "path",
"required": true,
"description": "The customer Group Id of the item that the sales channel price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemSalesChannelPrice",
"description": "The item sales channel price to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemSalesChannelPrice"
}
}
},
"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 ID exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1320,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Sales Channel Price",
"description": "DElete a specific sales channel price for a given item",
"operationId": "Item_DeleteItemSalesChannelPriceAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "salesChannelId",
"in": "path",
"required": true,
"description": "The sales channel Id of the item that the sales channel price belongs to. Only online shops and JTL-POS are allowed.",
"schema": {
"type": "string"
},
"x-position": 1
},
{
"name": "fromQuantity",
"in": "path",
"required": true,
"description": "The quantity the customer must buy to find the sales price.",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 2
},
{
"name": "itemId",
"in": "path",
"required": true,
"description": "The item Id of the item that the sales channel price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 3
},
{
"name": "customerGroupId",
"in": "path",
"required": true,
"description": "The customer Group Id of the item that the sales channel price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey"
},
"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"
}
}
],
"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 ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1330,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/specialprices": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Special Price",
"description": "Query the special prices for a specific item",
"operationId": "Item_QueryItemSpecialPriceAsync",
"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,
"description": "The id of the item that the special price details belong to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested special price details of the item .",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemSpecialPrice"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1500,
"x-stability-level": "stable"
},
"patch": {
"tags": [
"item"
],
"summary": "Update Item Special Price",
"description": "Update the special prices for a specific item",
"operationId": "Item_UpdateItemSpecialPriceAsync",
"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,
"description": "The id of the item that the special price belongs to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemSpecialPrice",
"description": "The special price details of the item to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemSpecialPrice"
}
}
},
"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 item with the given ID exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1520,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/suppliers": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Suppliers",
"description": "Query all suppliers for a specific item",
"operationId": "Item_QueryItemSuppliersAsync",
"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,
"description": "The id of the item that the supplier belong to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested item suppliers.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemSupplier"
}
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 700,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item Supplier",
"description": "Assign a supplier to a specific item",
"operationId": "Item_CreateItemSupplierAsync",
"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,
"description": "The id of the item that the supplier belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemSupplier",
"description": "The itemSupplier to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemSupplier"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created itemSupplier.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemSupplier"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 710,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/suppliers/{supplierId}": {
"patch": {
"tags": [
"item"
],
"summary": "Update Item Supplier",
"description": "Update the information for a specific supplier for a given item",
"operationId": "Item_UpdateItemSupplierAsync",
"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,
"description": "The unique id of the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 2
},
{
"name": "supplierId",
"in": "path",
"required": true,
"description": "The unique id of the supplier.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemSupplier",
"description": "The itemSupplier to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemSupplier"
}
}
},
"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 item and supplier with the given Ids exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 720,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Supplier",
"description": "Delete the connection between a specific supplier and item",
"operationId": "Item_DeleteItemSupplierAsync",
"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,
"description": "The unique id of the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 1
},
{
"name": "supplierId",
"in": "path",
"required": true,
"description": "The unique id of the supplier.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey"
},
"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"
}
}
],
"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 item and supplier with the given Ids exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 730,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/variations": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Variations",
"description": "Query all variations for a specific item",
"operationId": "Item_QueryItemVariationsAsync",
"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,
"description": "The id of the item that the variations belong to.",
"schema": {
"$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"
}
}
],
"responses": {
"200": {
"description": "The requested item variations.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemVariation"
}
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1000,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item Variation",
"description": "Create a new variation for a specific item",
"operationId": "Item_CreateItemVariationAsync",
"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,
"description": "The id of the item that the supplier belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemVariation",
"description": "The ItemVariation to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemVariation"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created ItemVariation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemVariation"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1010,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/variations/{variationId}": {
"patch": {
"tags": [
"item"
],
"summary": "Update Item Variation",
"description": "Update a specific variation for a given item",
"operationId": "Item_UpdateItemVariationAsync",
"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,
"description": "The unique id of the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 2
},
{
"name": "variationId",
"in": "path",
"required": true,
"description": "The unique id of the variation.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemVariation",
"description": "The ItemVariation to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemVariation"
}
}
},
"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 item and variation with the given Ids exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1020,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Variation",
"description": "Delete a specific variation for a given item",
"operationId": "Item_DeleteItemVariationAsync",
"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,
"description": "The unique id of the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 1
},
{
"name": "variationId",
"in": "path",
"required": true,
"description": "The unique id of the variation.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey"
},
"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"
}
}
],
"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 item and variation with the given Ids exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1030,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/variations/{variationId}/values": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Variation Values",
"description": "Query all values for a specific item variation",
"operationId": "Item_QueryItemVariationValuesAsync",
"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,
"description": "The id of the item that the variations belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 1
},
{
"name": "variationId",
"in": "path",
"required": true,
"description": "The unique id of the variation.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey"
},
"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"
}
}
],
"responses": {
"200": {
"description": "The requested values for the item variation.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemVariationValue"
}
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1040,
"x-stability-level": "stable"
},
"post": {
"tags": [
"item"
],
"summary": "Create Item Variation Value",
"description": "Create new values for a specific item variation",
"operationId": "Item_CreateItemVariationValueAsync",
"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,
"description": "The id of the item that the supplier belong to.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 2
},
{
"name": "variationId",
"in": "path",
"required": true,
"description": "The unique id of the variation.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemVariationValue",
"description": "The ItemVariationValue to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemVariationValue"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The created ItemVariationValue.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemVariationValue"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1050,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/variations/{variationId}/values/{variationValueId}": {
"patch": {
"tags": [
"item"
],
"summary": "Update Item Variation Value",
"description": "Update the value for a specific item variation",
"operationId": "Item_UpdateItemVariationValueAsync",
"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,
"description": "The unique id of the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 2
},
{
"name": "variationId",
"in": "path",
"required": true,
"description": "The unique id of the variation.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey"
},
"x-position": 3
},
{
"name": "variationValueId",
"in": "path",
"required": true,
"description": "The unique id of the variation value.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationWertKey"
},
"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"
}
}
],
"requestBody": {
"x-name": "itemVariationValue",
"description": "The ItemVariationValue to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemVariationValue"
}
}
},
"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 item and variation or variation value with the given Ids exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1060,
"x-stability-level": "stable"
},
"delete": {
"tags": [
"item"
],
"summary": "Delete Item Variation Value",
"description": "Delete a specific value for a item variation",
"operationId": "Item_DeleteItemVariationValueAsync",
"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,
"description": "The unique id of the item.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 1
},
{
"name": "variationId",
"in": "path",
"required": true,
"description": "The unique id of the variation.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey"
},
"x-position": 2
},
{
"name": "variationValueId",
"in": "path",
"required": true,
"description": "The unique id of the variation value.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationWertKey"
},
"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"
}
}
],
"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 item and variation or variation value with the given Ids exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse"
}
}
}
}
},
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1070,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/workflow/{workflowEventId}": {
"post": {
"tags": [
"item"
],
"summary": "Trigger Item Workflow",
"description": "Trigger a specific workflow event for a given item",
"operationId": "Item_TriggerItemWorkflowAsync",
"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.Item.ItemWorkflowEvent"
},
"x-position": 1
},
{
"name": "itemId",
"in": "path",
"required": true,
"description": "The id of the item for that the manual workflow event should be started.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/v1/items/{itemId}/workflowEvents": {
"post": {
"tags": [
"item"
],
"summary": "Trigger Item Workflow Event",
"description": "Trigger a specific workflow event for a given item",
"operationId": "Item_TriggerItemWorkflowEventAsync",
"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,
"description": "The id of the item for that the manual workflow event should be started.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/v1/items/customfields": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Custom Fields",
"description": "Query all custom fields for items",
"operationId": "Item_QueryItemCustomFieldsAsync",
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1000,
"x-stability-level": "stable"
}
},
"/v1/items/imagedata/{imageId}": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Image Data",
"description": "Query the data for a specific item image",
"operationId": "Item_QueryItemImageDataAsync",
"parameters": [
{
"name": "x-tenant-id",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The tenant ID for the target ERP instance."
},
{
"name": "imageId",
"in": "path",
"required": true,
"description": "The id of the image.",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.BildKey"
},
"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"
}
}
],
"responses": {
"200": {
"description": "The requested item 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 image 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": 610,
"x-stability-level": "stable"
}
},
"/v1/items/workflowEvents": {
"get": {
"tags": [
"item"
],
"summary": "Query Item Workflow Events",
"description": "Query all workflow events for items",
"operationId": "Item_QueryItemWorkflowEventsAsync",
"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"
}
}
],
"responses": {
"200": {
"description": "All manual workflow events for items 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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5000,
"x-stability-level": "stable"
}
},
"/v1/manufacturers": {
"get": {
"tags": [
"item"
],
"summary": "Query Manufacturers",
"description": "Query all manufacturers",
"operationId": "Manufacturer_QueryManufacturersAsync",
"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"
}
}
],
"responses": {
"200": {
"description": "Returns all manufacturers.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Manufacturer.Manufacturer"
}
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AngebotKey"
},
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/v1/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": {
"$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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AngebotKey"
},
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/v1/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": {
"$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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.AngebotKey"
},
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "beta"
}
},
"/v1/productGroups": {
"get": {
"tags": [
"item"
],
"summary": "Query Product Groups",
"description": "Query all product groups",
"operationId": "ProductGroup_QueryProductGroupsAsync",
"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"
}
}
],
"responses": {
"200": {
"description": "Returns all product groups.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.ProductGroup.ProductGroup"
}
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 110,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 310,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 330,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 410,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 430,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 210,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "beta"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey"
},
"x-position": 4
},
{
"name": "returnStateId",
"in": "query",
"schema": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "draft"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 200,
"x-stability-level": "draft"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 300,
"x-stability-level": "draft"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 400,
"x-stability-level": "draft"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/v1/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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 4
},
{
"name": "customerId",
"in": "query",
"description": "Gets the unique identifier for the customer.",
"schema": {
"$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": {
"$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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.BenutzerKey"
},
"x-position": 10
},
{
"name": "companyId",
"in": "query",
"description": "Gets the unique identifier for the firm.",
"schema": {
"$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": {
"$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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 210,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 220,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 1000,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 710,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 730,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 520,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 530,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 310,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 330,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 520,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey"
},
"x-position": 2
},
{
"name": "salesOrderLineItemFileId",
"in": "path",
"required": true,
"description": "Delete a specific file.",
"schema": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 540,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 410,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey"
},
"x-position": 2
},
{
"name": "noteId",
"in": "path",
"required": true,
"description": "The id of the note.",
"schema": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey"
},
"x-position": 1
},
{
"name": "noteId",
"in": "path",
"required": true,
"description": "The id of the note.",
"schema": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 730,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "beta"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 5010,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 2100,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "draft"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 700,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 2000,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 1
},
{
"name": "warehouseId",
"in": "query",
"schema": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey"
},
"x-position": 2
},
{
"name": "storageLocationId",
"in": "query",
"schema": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 400,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 300,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"x-position": 1
},
{
"name": "warehouseId",
"in": "query",
"schema": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 500,
"x-stability-level": "stable"
}
},
"/v1/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": "x-runas",
"in": "header",
"description": "The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns all suppliers.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JTL.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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey"
},
"x-position": 8
}
],
"responses": {
"200": {
"description": "The TaxRate for the given Item.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Tax.TaxRate"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey"
},
"x-position": 8
}
],
"responses": {
"200": {
"description": "The TaxRate for the given TaxClassId.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Tax.TaxRate"
}
}
}
},
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 110,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 110,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 110,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"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": {
"$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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 320,
"x-stability-level": "stable"
}
},
"/v1/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": {
"$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": {
"$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"
}
}
],
"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.V1.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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 310,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 350,
"x-stability-level": "stable"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "beta"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "beta"
},
"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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "beta"
}
},
"/v1/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"
}
}
],
"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": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "beta"
}
},
"/warehouses": {
"get": {
"tags": [
"warehouse"
],
"summary": "Query Warehouses",
"description": "Query all warehouses",
"operationId": "WarehouseHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 100,
"x-stability-level": "stable"
}
},
"/warehouses/{warehouseId}/storagelocations": {
"get": {
"tags": [
"warehouse"
],
"summary": "Query Storage Locations",
"description": "Query all storage locations for a given warehouse",
"operationId": "WarehouseHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 110,
"x-stability-level": "stable"
}
},
"/warehouses/storagelocationtypes": {
"get": {
"tags": [
"warehouse"
],
"summary": "Query Storage Location Type",
"description": "Query all storage location types",
"operationId": "WarehouseHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 110,
"x-stability-level": "stable"
}
},
"/warehouses/types": {
"get": {
"tags": [
"warehouse"
],
"summary": "Query Warehouse Types",
"description": "Query all warehouse types",
"operationId": "WarehouseHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 110,
"x-stability-level": "stable"
}
},
"/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": "WMSHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"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": "WMSHeader_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": {
"$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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 320,
"x-stability-level": "stable"
}
},
"/wms/{warehouseId}/picklists/{picklistId}": {
"get": {
"tags": [
"wms"
],
"summary": "Query Pick List Position",
"description": "Query all positions for a given pick list",
"operationId": "WMSHeader_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": {
"$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": {
"$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"
}
}
],
"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.V1.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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 310,
"x-stability-level": "stable"
}
},
"/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": "WMSHeader_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"
}
}
],
"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": {}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 350,
"x-stability-level": "stable"
}
},
"/workers": {
"get": {
"tags": [
"worker"
],
"summary": "Get Worker Syncs",
"description": "Returns the Available Syncs of the Worker",
"operationId": "WorkerHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "beta"
}
},
"/workers/{syncId}": {
"post": {
"tags": [
"worker"
],
"summary": "Configure Sync",
"description": "Restart the Worker",
"operationId": "WorkerHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "beta"
},
"put": {
"tags": [
"worker"
],
"summary": "Sync Control",
"description": "Control the Sync Processes",
"operationId": "WorkerHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "beta"
}
},
"/workers/status": {
"get": {
"tags": [
"worker"
],
"summary": "Get Worker Status",
"description": "Returns the Status of the Worker",
"operationId": "WorkerHeader_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"
}
}
],
"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"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2-authorization-code": []
},
{
"oauth2-client-credentials": []
}
],
"x-sort": 0,
"x-stability-level": "beta"
}
}
},
"components": {
"schemas": {
"JTL.Data.Contracts.Keys.AdresseKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.AmazonUserKey": {
"type": "integer",
"description": "Represents a unique key for identifying an Amazon user within the system.\n ",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.AngebotKey": {
"type": "integer",
"description": "Represents a key that uniquely identifies an offer in the system.\n ",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.AnsprechpartnerKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.ArtikelKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.AuftragStornogrundKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.BenutzerKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.BildKey": {
"type": "integer",
"format": "int32",
"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.EbayUserKey": {
"type": "integer",
"description": "Represents a unique key for identifying an eBay user within the system.\n ",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.EigenesFeldKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.FarbeKey": {
"type": "integer",
"description": "Represents a key for identifying a color entity in the system.",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.FileKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.FirmaKey": {
"type": "integer",
"description": "Represents a key for identifying a firm within the application.",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.FormularKey": {
"type": "integer",
"description": "Represents a unique key for identifying a form (Formular) entity within the system.\n ",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.GutschriftKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.GutschriftStornogrundKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.HerstellerKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.KategorieKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.KontoDatenKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.KundeKey": {
"type": "integer",
"description": "Represents a unique key for identifying a customer in the JTL system.",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.KundenGruppeKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.KundenKategorieKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.LieferantKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.LieferscheinKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.LieferstatusKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.MerkmalGruppeKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.MerkmalKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.MerkmalWertKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.NotizKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.PicklisteKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.PicklistePosKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.PicklisteVorlageKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.PlattformKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.RechnungKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.RechnungPositionKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.RechnungStornogrundKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.RetoureEtikettKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.RetoureKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.RetourenLieferscheinPositionKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.RetourePosKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.RetoureStatusKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.RueckgabegrundKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.RueckhaltegrundKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.ShopKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.ShopSubshopKey": {
"type": "integer",
"description": "Represents a key for identifying a shop subshop in the system.\n ",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.SpracheKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.SteuerklasseKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.VariationKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.VariationWertKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.VerkaufAuftragFileKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.VerkaufAuftragKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.VerkaufAuftragPositionFileKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.VersandartKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.VersandKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.VersandklasseKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.VorgangsstatusKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.WarengruppeKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.WarenlagerKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.WarenLagerPlatzKey": {
"type": "integer",
"format": "int32",
"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.ZahlungsartKey": {
"type": "integer",
"format": "int32",
"additionalProperties": false
},
"JTL.Data.Contracts.Keys.ZustandKey": {
"type": "integer",
"format": "int32",
"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": "byte"
},
"IstFreifeld": {
"type": "integer",
"description": "Gibt an ob es sich bei dem Attribut um ein Benutzerdefiniertes Attribut handelt",
"format": "byte"
},
"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": "byte"
},
"Ausgabeweg": {
"type": "integer",
"description": "Bestimmt wo dieses Attribut für Benutzer dargestellt werden soll. Wenn > 0, dann ist es z.B. ein Freifeld.",
"format": "byte"
},
"IstStandard": {
"type": "integer",
"description": "Gibt an, ob das Attribut von uns vorgegeben ist und nicht gelöscht werden darf",
"format": "byte"
},
"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": "byte"
},
"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": "byte"
},
"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.Wawi.ContactManagement.Core.Contracts.Domain.Keys.ContactKey": {
"type": "integer",
"description": "Stellt den Schlüssel eines Kontaktes dar.",
"format": "int32",
"additionalProperties": false
},
"JTL.Wawi.ContactManagement.Core.Contracts.Domain.Keys.ProductComplianceContactKey": {
"type": "integer",
"description": "Produktverantwortlichen Schlüssel",
"format": "int32",
"additionalProperties": false
},
"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.Marktplatz.Scx.Types.Keys.ScxChannelKey": {
"type": "integer",
"description": "Represents a key for a SCX channel.",
"format": "int32",
"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.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.V1.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.V1.Category.Category": {
"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.Category.Category"
}
},
"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.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.Item.Item": {
"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.Item.Item"
}
},
"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.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.V1.AccountingData.AccountingData": {
"type": "object",
"description": "Model Class: AccountingData ",
"additionalProperties": false,
"required": [
"DocumentNumber",
"DocumentId",
"DocumentDate",
"SalesOrderNumber",
"SalesOrderId",
"ExternalSalesOrderNumber",
"DepartureCountry",
"ShipmentCountry",
"BillingAddress",
"ShipmentAddress",
"CurrencyIso",
"Type",
"CompanyId",
"CompanyVatId",
"CustomerVatId",
"SalesChannelId",
"IsCancelled",
"AccountDataLineItems"
],
"properties": {
"DocumentNumber": {
"type": "string",
"description": "The number of the document."
},
"DocumentId": {
"type": "integer",
"description": "The identifier of the document.",
"format": "int32"
},
"DocumentDate": {
"type": "string",
"description": "The date and time when the document was created.",
"format": "date-time"
},
"SalesOrderNumber": {
"type": "string",
"description": "The internal number of the sales order."
},
"SalesOrderId": {
"description": "The identifier of the sales order.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey"
},
"ExternalSalesOrderNumber": {
"type": "string",
"description": "The external number of the sales order."
},
"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"
},
"CurrencyIso": {
"type": "string",
"description": "ISO code of the currency of the departure country."
},
"Type": {
"description": "0 = Invoice, 1 = Credit, 2 = Invoice correction, 3 = Invoice cancellation, 4 = credit cancellation, 5 = invoice correction cancellation",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.DocumentType"
},
"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."
},
"AccountDataLineItems": {
"type": "array",
"description": "Detailed list of items included in the document.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.AccountingDataLineItem"
}
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.AccountingDataLineItem": {
"type": "object",
"description": "Model Class: AccountingDataLineItem ",
"additionalProperties": false,
"required": [
"ItemId",
"Type",
"Name",
"TaxClassId",
"GeneralLedgerAccount",
"Quantity",
"VatRate",
"VatAmount",
"TotalDiscountGrossAmount",
"TotalDiscountNetAmount",
"TotalGrossAmount",
"TotalNetAmount",
"SortOrder"
],
"properties": {
"ItemId": {
"description": "The identifier of the item",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"Type": {
"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"
},
"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"
},
"VatRate": {
"type": "number",
"description": "Applicable VAT rate in percentage",
"format": "decimal"
},
"VatAmount": {
"type": "number",
"description": "Total VAT charged for this 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.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.DocumentType": {
"type": "integer",
"description": "0 = Invoice, 1 = Credit, 2 = InvoiceCorrection, 3 = InvoiceCancellation, 4 = CreditCancellation, 5 = InvoiceCorrectionCancellation, 6 = Liquidation, 7 = LiquidationCancellation",
"format": "int32",
"x-enumNames": [
"Invoice",
"Credit",
"InvoiceCorrection",
"InvoiceCancellation",
"CreditCancellation",
"InvoiceCorrectionCancellation",
"Liquidation",
"LiquidationCancellation"
],
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
]
},
"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.Category.Category": {
"type": "object",
"description": "Model Class: Category ",
"additionalProperties": false,
"required": [
"Id",
"Name",
"Description",
"ParentCategoryId",
"Level",
"SortNumber",
"ActiveSalesChannels"
],
"properties": {
"Id": {
"description": "Unique ID to identify a category.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
},
"Name": {
"type": "string",
"description": "Name of the category in the default language of JTL-Wawi."
},
"Description": {
"type": "string",
"description": "Category description in the default language of JTL-Wawi."
},
"ParentCategoryId": {
"description": "ID of the parent category, if the category is a child category.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
},
"Level": {
"type": "integer",
"description": "Returns the category level number within its category tree. A root category without a parent has a level 1.",
"format": "int32"
},
"SortNumber": {
"type": "integer",
"description": "The category sort number used in some sales channels for arranging the categories.",
"format": "int32"
},
"ActiveSalesChannels": {
"type": "array",
"description": "The list of active sales channels for this category. The items must be activated individually. Only online shops and JTL-POS are allowed. Sales channels removed from this list will be deactivated for this category.",
"items": {
"type": "string"
},
"x-delete-saleschannel": {
"PrimitiveType": 7,
"AnyType": 0,
"Value": true
}
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Category.CategoryDescription": {
"type": "object",
"description": "Model Class: CategoryDescription ",
"additionalProperties": false,
"required": [
"CategoryId",
"Name",
"Description",
"SeoPath",
"SeoMetaDescription",
"SeoTitleTag",
"SeoMetaKeywords",
"LanguageIso",
"SalesChannelId"
],
"properties": {
"CategoryId": {
"description": "Unique ID to identify a category.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
},
"Name": {
"type": "string",
"description": "The category name in the given language and sales channel. The name in JTL-Wawi and the default language is the default name of the category."
},
"Description": {
"type": "string",
"description": "The category description in the given language and sales channel."
},
"SeoPath": {
"type": "string",
"description": "The SEO path in the given language and sales channel."
},
"SeoMetaDescription": {
"type": "string",
"description": "The SEO metadescription in the given language and sales channel."
},
"SeoTitleTag": {
"type": "string",
"description": "The title tag (SEO) in the given language and sales channel."
},
"SeoMetaKeywords": {
"type": "string",
"description": "The meta keywords in the given language and sales channel."
},
"LanguageIso": {
"type": "string",
"description": "The ISO code of the language of the description."
},
"SalesChannelId": {
"type": "string",
"description": "The sales channel ID of the description. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint(GET)."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Category.CreateCategory": {
"type": "object",
"description": "Model Class: CreateCategory ",
"additionalProperties": false,
"required": [
"Name"
],
"properties": {
"Name": {
"type": "string",
"description": "Name of the category in the default language of JTL-Wawi."
},
"Description": {
"type": "string",
"description": "Category description in the default language of JTL-Wawi."
},
"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"
},
"ActiveSalesChannels": {
"type": "array",
"description": "The list of active sales channels for this category. The items must be activated individually. Only online shops and JTL-POS are allowed. Sales channels removed from this list will be deactivated for this category.",
"items": {
"type": "string"
},
"x-delete-saleschannel": {
"PrimitiveType": 7,
"AnyType": 0,
"Value": true
}
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Category.CreateCategoryDescription": {
"type": "object",
"description": "Model Class: CreateCategoryDescription ",
"additionalProperties": false,
"required": [
"Name",
"LanguageIso",
"SalesChannelId"
],
"properties": {
"Name": {
"type": "string",
"description": "The category name in the given language and sales channel. The name in JTL-Wawi and the default language is the default name of the category."
},
"Description": {
"type": "string",
"description": "The category description in the given language and sales channel."
},
"SeoPath": {
"type": "string",
"description": "The SEO path in the given language and sales channel."
},
"SeoMetaDescription": {
"type": "string",
"description": "The SEO metadescription in the given language and sales channel."
},
"SeoTitleTag": {
"type": "string",
"description": "The title tag (SEO) in the given language and sales channel."
},
"SeoMetaKeywords": {
"type": "string",
"description": "The meta keywords in the given language and sales channel."
},
"LanguageIso": {
"type": "string",
"description": "The ISO code of the language of the description."
},
"SalesChannelId": {
"type": "string",
"description": "The sales channel ID of the description. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint(GET)."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Category.UpdateCategory": {
"type": "object",
"description": "Model Class: UpdateCategory ",
"additionalProperties": false,
"properties": {
"Name": {
"type": "string",
"description": "Name of the category in the default language of JTL-Wawi."
},
"Description": {
"type": "string",
"description": "Category description in the default language of JTL-Wawi."
},
"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"
},
"ActiveSalesChannels": {
"type": "array",
"description": "The list of active sales channels for this category. The items must be activated individually. Only online shops and JTL-POS are allowed. Sales channels removed from this list will be deactivated for this category.",
"items": {
"type": "string"
},
"x-delete-saleschannel": {
"PrimitiveType": 7,
"AnyType": 0,
"Value": true
}
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Category.UpdateCategoryDescription": {
"type": "object",
"description": "Model Class: UpdateCategoryDescription ",
"additionalProperties": false,
"properties": {
"Name": {
"type": "string",
"description": "The category name in the given language and sales channel. The name in JTL-Wawi and the default language is the default name of the category."
},
"Description": {
"type": "string",
"description": "The category description in the given language and sales channel."
},
"SeoPath": {
"type": "string",
"description": "The SEO path in the given language and sales channel."
},
"SeoMetaDescription": {
"type": "string",
"description": "The SEO metadescription in the given language and sales channel."
},
"SeoTitleTag": {
"type": "string",
"description": "The title tag (SEO) in the given language and sales channel."
},
"SeoMetaKeywords": {
"type": "string",
"description": "The meta keywords in the given language and sales channel."
}
}
},
"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.CreateDimensions": {
"type": "object",
"description": "Model Class: CreateDimensions ",
"additionalProperties": false,
"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.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.UpdateDimensions": {
"type": "object",
"description": "Model Class: UpdateDimensions ",
"additionalProperties": false,
"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.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.",
"$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.",
"$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.",
"$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",
"$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.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.",
"$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",
"$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",
"$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.Item.CategoryReference": {
"type": "object",
"description": "Model Class: CategoryReference ",
"additionalProperties": false,
"required": [
"CategoryId",
"Name"
],
"properties": {
"CategoryId": {
"description": "Unique ID to identify a category.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
},
"Name": {
"type": "string",
"description": "Name in the default language of the category."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateCategoryReference": {
"type": "object",
"description": "Model Class: CreateCategoryReference ",
"additionalProperties": false,
"required": [
"CategoryId"
],
"properties": {
"CategoryId": {
"description": "Unique ID to identify a category.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItem": {
"type": "object",
"description": "Model Class: CreateItem ",
"additionalProperties": false,
"required": [
"Categories",
"Name"
],
"properties": {
"SKU": {
"type": "string",
"description": "Item SKU. If no SKU is given when posting an item, the SKU will be generated automatically."
},
"ManufacturerId": {
"description": "The manufacturer ID.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.HerstellerKey"
},
"ResponsiblePersonId": {
"description": "The Responsible person ID.",
"$ref": "#/components/schemas/JTL.Wawi.ContactManagement.Core.Contracts.Domain.Keys.ProductComplianceContactKey"
},
"Categories": {
"type": "array",
"description": "List of all the categories for the item.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateCategoryReference"
}
},
"Name": {
"type": "string",
"description": "Name of the item in the default language in JTL-Wawi.",
"maxLength": 2147483647
},
"Description": {
"type": "string",
"description": "Full textdescription for the item"
},
"ShortDescription": {
"type": "string",
"description": "Short description of the item in the default language in JTL-Wawi."
},
"Identifiers": {
"description": "Identifiers for items like EAN and UPC.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemIdentifiers"
},
"Components": {
"type": "array",
"description": "Components for the item if the item is a bill of material.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemComponent"
}
},
"ItemPriceData": {
"description": "Price data of the item.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemPrice"
},
"ActiveSalesChannels": {
"type": "array",
"description": "The list of active sales channels of the item. Only online shops and JTL-POS are permitted. Sales channels that are removed from this list will be deactivated for this item.",
"items": {
"type": "string"
},
"x-delete-saleschannel": {
"PrimitiveType": 7,
"AnyType": 0,
"Value": true
}
},
"SortNumber": {
"type": "integer",
"description": "The sort number of the item, used in some sales channels for ordering items.",
"format": "int32"
},
"Annotation": {
"type": "string",
"description": "The item annotation."
},
"ReleasedOnDate": {
"type": "string",
"description": "The date when the item was put up for sale.",
"format": "date-time"
},
"StorageOptions": {
"description": "Storage options for the item.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemStorageOption"
},
"CountryOfOrigin": {
"type": "string",
"description": "The country of origin of the item."
},
"ConditionId": {
"description": "Condition ID of the item. Default if nothing is specified.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZustandKey"
},
"ShippingClassId": {
"description": "The shipping class ID.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandklasseKey"
},
"ProductGroupId": {
"description": "The ID of the item group.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarengruppeKey"
},
"TaxClassId": {
"description": "The ID of the tax class.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey"
},
"Dimensions": {
"description": "The dimensions of the item.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateDimensions"
},
"Weights": {
"description": "The weight of the item.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemWeights"
},
"AllowNegativeStock": {
"type": "boolean",
"description": "This option allows you to sell a higher quantity of the item than is actually in stock."
},
"Quantities": {
"description": "Quantities of the item.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemQuantities"
},
"DangerousGoods": {
"description": "Any information about dangerous goods.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemDangerousGoods"
},
"Taric": {
"type": "string",
"description": "Taric code of the item."
},
"SearchTerms": {
"type": "string",
"description": "Search terms for the item."
},
"PriceListActive": {
"type": "boolean",
"description": "Indicates if the item is in the price list."
},
"IgnoreDiscounts": {
"type": "boolean",
"description": "Indicates if discounts are to be disregarded."
},
"AvailabilityId": {
"description": "Availability ID of the item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferstatusKey"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemComponent": {
"type": "object",
"description": "Model Class: CreateItemComponent ",
"additionalProperties": false,
"required": [
"ItemId",
"Quantity"
],
"properties": {
"ItemId": {
"description": "Item ID of the item's component.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"Quantity": {
"type": "number",
"description": "Quantity of the component in the bill of material.",
"format": "decimal"
},
"SortNumber": {
"type": "integer",
"description": "Defines the order of the components when shown in lists and sales channels.",
"format": "int32"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemCustomerPrice": {
"type": "object",
"description": "Model Class: CreateItemCustomerPrice ",
"additionalProperties": false,
"required": [
"CustomerId"
],
"properties": {
"CustomerId": {
"description": "Unique ID to identify a customer.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey"
},
"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 ReduceStandardSpBy% too. Only one can be used.",
"format": "decimal"
},
"ReduceStandardPriceByPercent": {
"type": "number",
"description": "Reduces the default sales price by a percentage. If you use NetPrice, you can't use ReduceStandardSpBy% too. Only one can be used.",
"format": "decimal"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemDangerousGoods": {
"type": "object",
"description": "Model Class: CreateItemDangerousGoods ",
"additionalProperties": false,
"properties": {
"UnNumber": {
"type": "string",
"description": "The UN number for the item."
},
"HazardNo": {
"type": "string",
"description": "The hazard number for the item."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemDescription": {
"type": "object",
"description": "Model Class: CreateItemDescription ",
"additionalProperties": false,
"required": [
"Name",
"LanguageIso",
"SalesChannelId"
],
"properties": {
"Name": {
"type": "string",
"description": "The item name in the given language and sales channel. The name in JTL-Wawi and the default language is the default name of the item."
},
"Description": {
"type": "string",
"description": "The item description for the given language and sales channel."
},
"ShortDescription": {
"type": "string",
"description": "An item's short description in the given language and sales channel."
},
"SeoPath": {
"type": "string",
"description": "The SEO path in the given language and sales channel."
},
"SeoMetaDescription": {
"type": "string",
"description": "The SEO meta description in the given language and sales channel."
},
"SeoTitleTag": {
"type": "string",
"description": "The title tag (SEO) in the given language and sales channel."
},
"SeoMetaKeywords": {
"type": "string",
"description": "Meta keywords in the given language and sales channel."
},
"LanguageIso": {
"type": "string",
"description": "The ISO code of the language for the description."
},
"SalesChannelId": {
"type": "string",
"description": "The ID of the sales channel for this description. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint(GET)."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemIdentifiers": {
"type": "object",
"description": "Model Class: CreateItemIdentifiers ",
"additionalProperties": false,
"properties": {
"Gtin": {
"type": "string",
"description": "GTIN"
},
"ManufacturerNumber": {
"type": "string",
"description": "Manufacturer number."
},
"ISBN": {
"type": "string",
"description": "ISBN"
},
"UPC": {
"type": "string",
"description": "UPC"
},
"AmazonFnsku": {
"type": "string",
"description": "An item's Amazon FNSKU."
},
"Asins": {
"type": "array",
"description": "A list of the item's ASINs.",
"items": {
"type": "string"
}
},
"OwnIdentifier": {
"type": "string",
"description": "A custom identifier for the item."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemImage": {
"type": "object",
"description": "Model Class: CreateItemImage ",
"additionalProperties": false,
"required": [
"ImageData",
"Filename",
"SalesChannelId"
],
"properties": {
"ImageData": {
"type": "string",
"description": "Base64 encoded data of an image.",
"format": "byte"
},
"Filename": {
"type": "string",
"description": "Name of the file."
},
"SalesChannelId": {
"type": "string",
"description": "The sales channel ID for an image. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint(GET)."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemMinimumPurchaseQuantityForCustomerGroup": {
"type": "object",
"description": "Model Class: CreateItemMinimumPurchaseQuantityForCustomerGroup ",
"additionalProperties": false,
"required": [
"CustomerGroupId"
],
"properties": {
"CustomerGroupId": {
"description": "Unique ID to identify a customer group.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey"
},
"PermissibleOrderQuantity": {
"type": "number",
"description": "The permissible order quantity for the item. Indicates the increments in which the item is sold.",
"format": "decimal"
},
"MinimumPurchaseQuantity": {
"type": "number",
"description": "The minimum purchase quantity for a customer group.",
"format": "decimal"
},
"IsActive": {
"type": "boolean",
"description": "Indicates if this setting is active or deactivated."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemPrice": {
"type": "object",
"description": "Model Class: CreateItemPrice ",
"additionalProperties": false,
"properties": {
"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"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemPropertyValue": {
"type": "object",
"description": "Model Class: CreateItemPropertyValue ",
"additionalProperties": false,
"required": [
"PropertyValueId"
],
"properties": {
"PropertyValueId": {
"description": "A unique property value ID for an item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalWertKey"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemQuantities": {
"type": "object",
"description": "Model Class: CreateItemQuantities ",
"additionalProperties": false,
"properties": {
"MinimumOrderQuantity": {
"type": "number",
"description": "The minimum order quantity of the item.",
"format": "decimal"
},
"MinimumPurchaseQuantityForCustomerGroup": {
"type": "array",
"description": "A collection of minimum order quantities for different customer groups.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemMinimumPurchaseQuantityForCustomerGroup"
}
},
"PermissibleOrderQuantity": {
"type": "number",
"description": "The permissible order quantity for the item. Indicates the increments in which the item is sold.",
"format": "decimal"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemSalesChannelPrice": {
"type": "object",
"description": "Model Class: CreateItemSalesChannelPrice ",
"additionalProperties": false,
"required": [
"SalesChannelId"
],
"properties": {
"SalesChannelId": {
"type": "string",
"description": "The ID of the sales channel for this description. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint (GET)."
},
"CustomerGroupId": {
"description": "Unique ID to identify a customer group. If CustomerGroupId is 0, the price will be the default value for all customer groups.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey"
},
"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": "Reduce the default sales price by a percentage. If you use NetPrice, you can't use ReduceStandardPriceByPercent too. Only one can be used.",
"format": "decimal"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemStorageOption": {
"type": "object",
"description": "Model Class: CreateItemStorageOption ",
"additionalProperties": false,
"properties": {
"InventoryManagementActive": {
"type": "boolean",
"description": "Indicates if inventory management for the item is active, meaning that the item displays stock quantities."
},
"SplitQuantity": {
"type": "boolean",
"description": "Indicates if the item can be split into quantities less than 1."
},
"GlobalMinimumStockLevel": {
"type": "number",
"description": "Defines the minimum quantity that should always be in stock. For example, when calculating purchasing orders.",
"format": "decimal"
},
"Buffer": {
"type": "integer",
"description": "The buffer of the item. Used when selling time-delayed across different sales channels, so as not to sell more than is in stock.",
"format": "int32"
},
"SerialNumberItem": {
"type": "boolean",
"description": "Indicates the item's serial number when shipping the sales orders."
},
"SerialNumberTracking": {
"type": "boolean",
"description": "Indicates if serial numbers are to be identified during a goods receipt process from a supplier."
},
"SubjectToShelfLifeExpirationDate": {
"type": "boolean",
"description": "Indicates if the item has an expiration date, also known as a best before date."
},
"SubjectToBatchItem": {
"type": "boolean",
"description": "Indicates whether the item is a batch item or not."
},
"ProcurementTime": {
"type": "integer",
"description": "The procurement time indicates how many days it will take for the goods to be ready for shipment if they are currently out of stock. Procurement time is determined automatically on the basis of the supplier’s delivery time. By default, the delivery time of the default supplier is used as the procurement time. If additional processing time (in days) has been specified, this is added to the procurement time.",
"format": "int32"
},
"DetermineProcurementTimeAutomatically": {
"type": "boolean",
"description": "If this option is set, the procurement time will be calculated from the default supplier's shipment time."
},
"AdditionalHandlingTime": {
"type": "integer",
"description": "Indicates the additional processing time in days required to process. It is always added to the delivery time.",
"format": "int32"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemSupplier": {
"type": "object",
"description": "Model Class: CreateItemSupplier ",
"additionalProperties": false,
"required": [
"SupplierId"
],
"properties": {
"SupplierId": {
"description": "Unique ID to identify a supplier.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey"
},
"Sku": {
"type": "string",
"description": "Item SKU from the supplier."
},
"ItemName": {
"type": "string",
"description": "Item name from the supplier."
},
"IsStandard": {
"type": "boolean",
"description": "Defines the main supplier for the given item."
},
"PurchasePriceNet": {
"type": "number",
"description": "Net purchase price from the supplier.",
"format": "decimal"
},
"TaxRate": {
"type": "number",
"description": "Percent of VAT tax rate.",
"format": "decimal"
},
"MinimumPurchaseQuantity": {
"type": "number",
"description": "The minimum purchase quantity from the supplier.",
"format": "decimal"
},
"PermissibleOrderQuantity": {
"type": "number",
"description": "The permissible order quantity for the item from the supplier. The increments in which the item can be sold.",
"format": "decimal"
},
"DeliveryTime": {
"type": "integer",
"description": "Delivery time in days.",
"format": "int32"
},
"UseSupplierDeliveryTime": {
"type": "boolean",
"description": "If set to true, Wawi will use the delivery time provided by the supplier and not by the item information. DeliveryTime will then be ignored."
},
"Stocklevel": {
"type": "number",
"description": "Stock level of the item at the supplier.",
"format": "decimal"
},
"IsDropshipping": {
"type": "boolean",
"description": "Activates drop shipping for a given item and supplier."
},
"MergeStockLevel": {
"type": "boolean",
"description": "Forces Wawi to add the supplier's stock to your own stock."
},
"Comment": {
"type": "string",
"description": "Comment for the supplier."
},
"PackagingUnit": {
"type": "string",
"description": "Name of the packaging unit."
},
"AmountPackagingUnit": {
"type": "number",
"description": "Quantity in a packaging unit.",
"format": "decimal"
},
"ScalePrices": {
"type": "array",
"description": "Scale prices from this supplier for the item.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateSupplierItemScalePrice"
}
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemVariation": {
"type": "object",
"description": "Model Class: CreateItemVariation ",
"additionalProperties": false,
"required": [
"Name",
"Type"
],
"properties": {
"Name": {
"type": "string",
"description": "Name of a variation in the default language."
},
"Type": {
"description": "The type of variation.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.VariationType"
},
"Translations": {
"type": "array",
"description": "Different terms for a variation in the non-default languages.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateTranslation"
}
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemVariationValue": {
"type": "object",
"description": "Model Class: CreateItemVariationValue ",
"additionalProperties": false,
"required": [
"Name"
],
"properties": {
"Name": {
"type": "string",
"description": "Name of a variation value in the default language."
},
"Translations": {
"type": "array",
"description": "Different terms for a variation value in the non-default languages.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.CreateTranslation"
}
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateItemWeights": {
"type": "object",
"description": "Model Class: CreateItemWeights ",
"additionalProperties": false,
"properties": {
"ItemWeigth": {
"type": "number",
"description": "The weight of the item in kilograms.",
"format": "decimal"
},
"ShippingWeight": {
"type": "number",
"description": "The shipping weight of the item in kilograms.",
"format": "decimal"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.CreateSupplierItemScalePrice": {
"type": "object",
"description": "Model Class: CreateSupplierItemScalePrice ",
"additionalProperties": false,
"required": [
"FromQuantity"
],
"properties": {
"FromQuantity": {
"type": "integer",
"description": "The quantity where this scale price starts. This scale price ends at the next highest quantity. If there is no scale price with a higher quantity, then this price is set for all quantities from this point on.",
"format": "int32"
},
"PurchasePriceNet": {
"type": "number",
"description": "Net purchase price of the supplier for the scale price starting from this given quantity to the next scale price with a higher quantity. If you use PurchasePriceNet, you can't use ReduceStandardSpBy% as well. Only one is allowed.",
"format": "decimal"
},
"ReduceStandardPriceByPercent": {
"type": "number",
"description": "Reduces the default purchase price by a percentage. If you use PurchasePriceNet, you can't use ReduceStandardPriceByPercent as well. Only one is allowed.",
"format": "decimal"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.Item": {
"type": "object",
"description": "Model Class: Item ",
"additionalProperties": false,
"required": [
"Id",
"SKU",
"ManufacturerId",
"ResponsiblePersonId",
"IsActive",
"Categories",
"Name",
"Description",
"ShortDescription",
"Identifiers",
"Components",
"ChildItems",
"ParentItemId",
"ItemPriceData",
"ActiveSalesChannels",
"SortNumber",
"Annotation",
"Added",
"Changed",
"ReleasedOnDate",
"StorageOptions",
"CountryOfOrigin",
"ConditionId",
"ShippingClassId",
"ProductGroupId",
"TaxClassId",
"Dimensions",
"Weights",
"AllowNegativeStock",
"Quantities",
"DangerousGoods",
"Taric",
"SearchTerms",
"PriceListActive",
"IgnoreDiscounts",
"AvailabilityId"
],
"properties": {
"Id": {
"description": "Unique ID to identify an item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"SKU": {
"type": "string",
"description": "Item SKU. If no SKU is given when posting an item, the SKU will be generated automatically."
},
"ManufacturerId": {
"description": "The manufacturer ID.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.HerstellerKey"
},
"ResponsiblePersonId": {
"description": "The Responsible person ID.",
"$ref": "#/components/schemas/JTL.Wawi.ContactManagement.Core.Contracts.Domain.Keys.ProductComplianceContactKey"
},
"IsActive": {
"type": "boolean",
"description": "Indicates if the item is active."
},
"Categories": {
"type": "array",
"description": "List of all the categories for the item.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CategoryReference"
}
},
"Name": {
"type": "string",
"description": "Name of the item in the default language in JTL-Wawi."
},
"Description": {
"type": "string",
"description": "Full textdescription for the item"
},
"ShortDescription": {
"type": "string",
"description": "Short description of the item in the default language in JTL-Wawi."
},
"Identifiers": {
"description": "Identifiers for items like EAN and UPC.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemIdentifiers"
},
"Components": {
"type": "array",
"description": "Components for the item if the item is a bill of material.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemComponent"
}
},
"ChildItems": {
"type": "array",
"description": "IDs of the child items, if the item is a parent item.",
"items": {
"type": "integer",
"format": "int32"
}
},
"ParentItemId": {
"description": "ID of the parent item, if the item is a child item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"ItemPriceData": {
"description": "Price data of the item.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemPrice"
},
"ActiveSalesChannels": {
"type": "array",
"description": "The list of active sales channels of the item. Only online shops and JTL-POS are permitted. Sales channels that are removed from this list will be deactivated for this item.",
"items": {
"type": "string"
},
"x-delete-saleschannel": {
"PrimitiveType": 7,
"AnyType": 0,
"Value": true
}
},
"SortNumber": {
"type": "integer",
"description": "The sort number of the item, used in some sales channels for ordering items.",
"format": "int32"
},
"Annotation": {
"type": "string",
"description": "The item annotation."
},
"Added": {
"type": "string",
"description": "Date when the item was added to the system.",
"format": "date-time"
},
"Changed": {
"type": "string",
"description": "Date of the last change made to the item. Only item data changes are relevant for this field, not changes in stock.",
"format": "date-time"
},
"ReleasedOnDate": {
"type": "string",
"description": "The date when the item was put up for sale.",
"format": "date-time"
},
"StorageOptions": {
"description": "Storage options for the item.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemStorageOption"
},
"CountryOfOrigin": {
"type": "string",
"description": "The country of origin of the item."
},
"ConditionId": {
"description": "Condition ID of the item. Default if nothing is specified.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ZustandKey"
},
"ShippingClassId": {
"description": "The shipping class ID.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandklasseKey"
},
"ProductGroupId": {
"description": "The ID of the item group.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarengruppeKey"
},
"TaxClassId": {
"description": "The ID of the tax class.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey"
},
"Dimensions": {
"description": "The dimensions of the item.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Dimensions"
},
"Weights": {
"description": "The weight of the item.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemWeights"
},
"AllowNegativeStock": {
"type": "boolean",
"description": "This option allows you to sell a higher quantity of the item than is actually in stock."
},
"Quantities": {
"description": "Quantities of the item.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemQuantities"
},
"DangerousGoods": {
"description": "Any information about dangerous goods.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemDangerousGoods"
},
"Taric": {
"type": "string",
"description": "Taric code of the item."
},
"SearchTerms": {
"type": "string",
"description": "Search terms for the item."
},
"PriceListActive": {
"type": "boolean",
"description": "Indicates if the item is in the price list."
},
"IgnoreDiscounts": {
"type": "boolean",
"description": "Indicates if discounts are to be disregarded."
},
"AvailabilityId": {
"description": "Availability ID of the item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferstatusKey"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemComponent": {
"type": "object",
"description": "Model Class: ItemComponent ",
"additionalProperties": false,
"required": [
"ItemId",
"Quantity",
"SortNumber"
],
"properties": {
"ItemId": {
"description": "Item ID of the item's component.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"Quantity": {
"type": "number",
"description": "Quantity of the component in the bill of material.",
"format": "decimal"
},
"SortNumber": {
"type": "integer",
"description": "Defines the order of the components when shown in lists and sales channels.",
"format": "int32"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemCustomerPrice": {
"type": "object",
"description": "Model Class: ItemCustomerPrice ",
"additionalProperties": false,
"required": [
"ItemId",
"CustomerId",
"FromQuantity",
"NetPrice",
"ReduceStandardPriceByPercent"
],
"properties": {
"ItemId": {
"description": "Unique ID to identify an item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"CustomerId": {
"description": "Unique ID to identify a customer.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundeKey"
},
"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 ReduceStandardSpBy% too. Only one can be used.",
"format": "decimal"
},
"ReduceStandardPriceByPercent": {
"type": "number",
"description": "Reduces the default sales price by a percentage. If you use NetPrice, you can't use ReduceStandardSpBy% too. Only one can be used.",
"format": "decimal"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemDangerousGoods": {
"type": "object",
"description": "Model Class: ItemDangerousGoods ",
"additionalProperties": false,
"required": [
"UnNumber",
"HazardNo"
],
"properties": {
"UnNumber": {
"type": "string",
"description": "The UN number for the item."
},
"HazardNo": {
"type": "string",
"description": "The hazard number for the item."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemDescription": {
"type": "object",
"description": "Model Class: ItemDescription ",
"additionalProperties": false,
"required": [
"ItemId",
"Name",
"Description",
"ShortDescription",
"SeoPath",
"SeoMetaDescription",
"SeoTitleTag",
"SeoMetaKeywords",
"LanguageIso",
"SalesChannelId"
],
"properties": {
"ItemId": {
"description": "Unique ID to identify an item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"Name": {
"type": "string",
"description": "The item name in the given language and sales channel. The name in JTL-Wawi and the default language is the default name of the item."
},
"Description": {
"type": "string",
"description": "The item description for the given language and sales channel."
},
"ShortDescription": {
"type": "string",
"description": "An item's short description in the given language and sales channel."
},
"SeoPath": {
"type": "string",
"description": "The SEO path in the given language and sales channel."
},
"SeoMetaDescription": {
"type": "string",
"description": "The SEO meta description in the given language and sales channel."
},
"SeoTitleTag": {
"type": "string",
"description": "The title tag (SEO) in the given language and sales channel."
},
"SeoMetaKeywords": {
"type": "string",
"description": "Meta keywords in the given language and sales channel."
},
"LanguageIso": {
"type": "string",
"description": "The ISO code of the language for the description."
},
"SalesChannelId": {
"type": "string",
"description": "The ID of the sales channel for this description. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint(GET)."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemIdentifiers": {
"type": "object",
"description": "Model Class: ItemIdentifiers ",
"additionalProperties": false,
"required": [
"Gtin",
"ManufacturerNumber",
"ISBN",
"UPC",
"AmazonFnsku",
"Asins",
"OwnIdentifier"
],
"properties": {
"Gtin": {
"type": "string",
"description": "GTIN"
},
"ManufacturerNumber": {
"type": "string",
"description": "Manufacturer number."
},
"ISBN": {
"type": "string",
"description": "ISBN"
},
"UPC": {
"type": "string",
"description": "UPC"
},
"AmazonFnsku": {
"type": "string",
"description": "An item's Amazon FNSKU."
},
"Asins": {
"type": "array",
"description": "A list of the item's ASINs.",
"items": {
"type": "string"
}
},
"OwnIdentifier": {
"type": "string",
"description": "A custom identifier for the item."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemImage": {
"type": "object",
"description": "Model Class: ItemImage ",
"additionalProperties": false,
"required": [
"ItemId",
"ImageId",
"Filename",
"ImageDataType",
"SalesChannelId",
"EbayUserName",
"SortNumber",
"Size",
"Width",
"Height"
],
"properties": {
"ItemId": {
"description": "Unique ID to identify an item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"ImageId": {
"description": "Unique ID to identify an image.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.BildKey"
},
"Filename": {
"type": "string",
"description": "Name of the file."
},
"ImageDataType": {
"type": "string",
"description": "Type of image."
},
"SalesChannelId": {
"type": "string",
"description": "The sales channel ID for an image. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint(GET)."
},
"EbayUserName": {
"type": "string",
"description": "Name of the eBay user if the sales channel is eBay."
},
"SortNumber": {
"type": "integer",
"description": "The sort number for arranging images in sales channels. Every image needs to have an unique sort number per sales channel and item.",
"format": "int32"
},
"Size": {
"type": "integer",
"description": "The size of an image.",
"format": "int64"
},
"Width": {
"type": "integer",
"description": "The width of an image in pixels.",
"format": "int32"
},
"Height": {
"type": "integer",
"description": "The height of the image in pixels.",
"format": "int32"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemMinimumPurchaseQuantityForCustomerGroup": {
"type": "object",
"description": "Model Class: ItemMinimumPurchaseQuantityForCustomerGroup ",
"additionalProperties": false,
"required": [
"CustomerGroupId",
"PermissibleOrderQuantity",
"MinimumPurchaseQuantity",
"IsActive"
],
"properties": {
"CustomerGroupId": {
"description": "Unique ID to identify a customer group.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey"
},
"PermissibleOrderQuantity": {
"type": "number",
"description": "The permissible order quantity for the item. Indicates the increments in which the item is sold.",
"format": "decimal"
},
"MinimumPurchaseQuantity": {
"type": "number",
"description": "The minimum purchase quantity for a customer group.",
"format": "decimal"
},
"IsActive": {
"type": "boolean",
"description": "Indicates if this setting is active or deactivated."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemPrice": {
"type": "object",
"description": "Model Class: ItemPrice ",
"additionalProperties": false,
"required": [
"SalesPriceNet",
"SuggestedRetailPrice",
"PurchasePriceNet",
"EbayPrice",
"AmazonPrice"
],
"properties": {
"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"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemProperties": {
"type": "object",
"description": "Model Class: ItemProperties ",
"additionalProperties": false,
"required": [
"ItemId",
"Properties"
],
"properties": {
"ItemId": {
"description": "Unique ID to identify an item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"Properties": {
"type": "array",
"description": "A list of property values for an item.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemPropertyValue"
}
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemPropertyValue": {
"type": "object",
"description": "Model Class: ItemPropertyValue ",
"additionalProperties": false,
"required": [
"PropertyId",
"PropertyValueId"
],
"properties": {
"PropertyId": {
"description": "A unique property ID for an item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalKey"
},
"PropertyValueId": {
"description": "A unique property value ID for an item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.MerkmalWertKey"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemQuantities": {
"type": "object",
"description": "Model Class: ItemQuantities ",
"additionalProperties": false,
"required": [
"MinimumOrderQuantity",
"MinimumPurchaseQuantityForCustomerGroup",
"PermissibleOrderQuantity"
],
"properties": {
"MinimumOrderQuantity": {
"type": "number",
"description": "The minimum order quantity of the item.",
"format": "decimal"
},
"MinimumPurchaseQuantityForCustomerGroup": {
"type": "array",
"description": "A collection of minimum order quantities for different customer groups.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemMinimumPurchaseQuantityForCustomerGroup"
}
},
"PermissibleOrderQuantity": {
"type": "number",
"description": "The permissible order quantity for the item. Indicates the increments in which the item is sold.",
"format": "decimal"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemSalesChannelPrice": {
"type": "object",
"description": "Model Class: ItemSalesChannelPrice ",
"additionalProperties": false,
"required": [
"ItemId",
"SalesChannelId",
"CustomerGroupId",
"FromQuantity",
"NetPrice",
"ReduceStandardPriceByPercent"
],
"properties": {
"ItemId": {
"description": "Unique ID to identify an item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"SalesChannelId": {
"type": "string",
"description": "The ID of the sales channel for this description. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint (GET)."
},
"CustomerGroupId": {
"description": "Unique ID to identify a customer group. If CustomerGroupId is 0, the price will be the default value for all customer groups.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey"
},
"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": "Reduce the default sales price by a percentage. If you use NetPrice, you can't use ReduceStandardPriceByPercent too. Only one can be used.",
"format": "decimal"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemSpecialPrice": {
"type": "object",
"description": "Model Class: ItemSpecialPrice ",
"additionalProperties": false,
"required": [
"ItemId",
"SpecialPrice",
"IsActive",
"StartDate",
"EndDateActive",
"EndDate",
"TillAmountActive",
"TillAmountInStockSmallerThan"
],
"properties": {
"ItemId": {
"description": "Unique ID to identify an item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"SpecialPrice": {
"type": "array",
"description": "List of all special prices for JTL-Wawi and the sales channel with the type online shop and JTL-POS.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.SpecialPrice"
}
},
"IsActive": {
"type": "boolean",
"description": "Indicates if the special price is active."
},
"StartDate": {
"type": "string",
"description": "The date when the special price should start.",
"format": "date-time"
},
"EndDateActive": {
"type": "boolean",
"description": "If set, the special price will end on a given date. In this case, the field EndDate is required."
},
"EndDate": {
"type": "string",
"description": "This is required if EndDateActive is set. In this case, the special price ends on this date.",
"format": "date-time"
},
"TillAmountActive": {
"type": "boolean",
"description": "Indicates that the special price ends when a certain amount is reached. The field TillAmountInStockSmallerThan is required in this case."
},
"TillAmountInStockSmallerThan": {
"type": "integer",
"description": "If this amount of stock for the item is reached, the special price ends. Only applies if TillAmountActive is true.",
"format": "int32"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemStorageOption": {
"type": "object",
"description": "Model Class: ItemStorageOption ",
"additionalProperties": false,
"required": [
"InventoryManagementActive",
"SplitQuantity",
"GlobalMinimumStockLevel",
"Buffer",
"SerialNumberItem",
"SerialNumberTracking",
"SubjectToShelfLifeExpirationDate",
"SubjectToBatchItem",
"ProcurementTime",
"DetermineProcurementTimeAutomatically",
"AdditionalHandlingTime"
],
"properties": {
"InventoryManagementActive": {
"type": "boolean",
"description": "Indicates if inventory management for the item is active, meaning that the item displays stock quantities."
},
"SplitQuantity": {
"type": "boolean",
"description": "Indicates if the item can be split into quantities less than 1."
},
"GlobalMinimumStockLevel": {
"type": "number",
"description": "Defines the minimum quantity that should always be in stock. For example, when calculating purchasing orders.",
"format": "decimal"
},
"Buffer": {
"type": "integer",
"description": "The buffer of the item. Used when selling time-delayed across different sales channels, so as not to sell more than is in stock.",
"format": "int32"
},
"SerialNumberItem": {
"type": "boolean",
"description": "Indicates the item's serial number when shipping the sales orders."
},
"SerialNumberTracking": {
"type": "boolean",
"description": "Indicates if serial numbers are to be identified during a goods receipt process from a supplier."
},
"SubjectToShelfLifeExpirationDate": {
"type": "boolean",
"description": "Indicates if the item has an expiration date, also known as a best before date."
},
"SubjectToBatchItem": {
"type": "boolean",
"description": "Indicates whether the item is a batch item or not."
},
"ProcurementTime": {
"type": "integer",
"description": "The procurement time indicates how many days it will take for the goods to be ready for shipment if they are currently out of stock. Procurement time is determined automatically on the basis of the supplier’s delivery time. By default, the delivery time of the default supplier is used as the procurement time. If additional processing time (in days) has been specified, this is added to the procurement time.",
"format": "int32"
},
"DetermineProcurementTimeAutomatically": {
"type": "boolean",
"description": "If this option is set, the procurement time will be calculated from the default supplier's shipment time."
},
"AdditionalHandlingTime": {
"type": "integer",
"description": "Indicates the additional processing time in days required to process. It is always added to the delivery time.",
"format": "int32"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemSupplier": {
"type": "object",
"description": "Model Class: ItemSupplier ",
"additionalProperties": false,
"required": [
"ItemId",
"SupplierId",
"Sku",
"ItemName",
"IsStandard",
"PurchasePriceNet",
"TaxRate",
"MinimumPurchaseQuantity",
"PermissibleOrderQuantity",
"DeliveryTime",
"UseSupplierDeliveryTime",
"Stocklevel",
"IsDropshipping",
"MergeStockLevel",
"Comment",
"PackagingUnit",
"AmountPackagingUnit",
"PackagingUnitPurchasePriceNet",
"ScalePrices"
],
"properties": {
"ItemId": {
"description": "Unique ID to identify an item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"SupplierId": {
"description": "Unique ID to identify a supplier.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferantKey"
},
"Sku": {
"type": "string",
"description": "Item SKU from the supplier."
},
"ItemName": {
"type": "string",
"description": "Item name from the supplier."
},
"IsStandard": {
"type": "boolean",
"description": "Defines the main supplier for the given item."
},
"PurchasePriceNet": {
"type": "number",
"description": "Net purchase price from the supplier.",
"format": "decimal"
},
"TaxRate": {
"type": "number",
"description": "Percent of VAT tax rate.",
"format": "decimal"
},
"MinimumPurchaseQuantity": {
"type": "number",
"description": "The minimum purchase quantity from the supplier.",
"format": "decimal"
},
"PermissibleOrderQuantity": {
"type": "number",
"description": "The permissible order quantity for the item from the supplier. The increments in which the item can be sold.",
"format": "decimal"
},
"DeliveryTime": {
"type": "integer",
"description": "Delivery time in days.",
"format": "int32"
},
"UseSupplierDeliveryTime": {
"type": "boolean",
"description": "If set to true, Wawi will use the delivery time provided by the supplier and not by the item information. DeliveryTime will then be ignored."
},
"Stocklevel": {
"type": "number",
"description": "Stock level of the item at the supplier.",
"format": "decimal"
},
"IsDropshipping": {
"type": "boolean",
"description": "Activates drop shipping for a given item and supplier."
},
"MergeStockLevel": {
"type": "boolean",
"description": "Forces Wawi to add the supplier's stock to your own stock."
},
"Comment": {
"type": "string",
"description": "Comment for the supplier."
},
"PackagingUnit": {
"type": "string",
"description": "Name of the packaging unit."
},
"AmountPackagingUnit": {
"type": "number",
"description": "Quantity in a packaging unit.",
"format": "decimal"
},
"PackagingUnitPurchasePriceNet": {
"type": "number",
"description": "Net purchase price from the supplier for a packaging unit.",
"format": "decimal"
},
"ScalePrices": {
"type": "array",
"description": "Scale prices from this supplier for the item.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.SupplierItemScalePrice"
}
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemVariation": {
"type": "object",
"description": "Model Class: ItemVariation ",
"additionalProperties": false,
"required": [
"Id",
"ItemId",
"Name",
"Type",
"Translations"
],
"properties": {
"Id": {
"description": "Unique ID to identify a variation.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationKey"
},
"ItemId": {
"description": "Unique ID to identify an item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"Name": {
"type": "string",
"description": "Name of a variation in the default language."
},
"Type": {
"description": "The type of variation.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.VariationType"
},
"Translations": {
"type": "array",
"description": "Different terms for a variation in the non-default languages.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Translation"
}
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemVariationValue": {
"type": "object",
"description": "Model Class: ItemVariationValue ",
"additionalProperties": false,
"required": [
"Id",
"Name",
"Translations"
],
"properties": {
"Id": {
"description": "Unique ID to identify a variation value.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VariationWertKey"
},
"Name": {
"type": "string",
"description": "Name of a variation value in the default language."
},
"Translations": {
"type": "array",
"description": "Different terms for a variation value in the non-default languages.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Translation"
}
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemWeights": {
"type": "object",
"description": "Model Class: ItemWeights ",
"additionalProperties": false,
"required": [
"ItemWeigth",
"ShippingWeight"
],
"properties": {
"ItemWeigth": {
"type": "number",
"description": "The weight of the item in kilograms.",
"format": "decimal"
},
"ShippingWeight": {
"type": "number",
"description": "The shipping weight of the item in kilograms.",
"format": "decimal"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemWorkflowEvent": {
"type": "integer",
"description": "1 = Created, 2 = Changed, 3 = Deleted",
"format": "int32",
"x-enumNames": [
"Created",
"Changed",
"Deleted"
],
"enum": [
1,
2,
3
]
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.SpecialPrice": {
"type": "object",
"description": "Model Class: SpecialPrice ",
"additionalProperties": false,
"required": [
"IsActive",
"CustomerGroupId",
"NetPrice",
"SalesChannelId"
],
"properties": {
"IsActive": {
"type": "boolean",
"description": "Indicates whether the special price is active at the moment."
},
"CustomerGroupId": {
"description": "The ID of the customer group that uses the special price.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey"
},
"NetPrice": {
"type": "number",
"description": "Net price for the special price.",
"format": "decimal"
},
"SalesChannelId": {
"type": "string",
"description": "The sales channel ID for this special price. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint(GET)."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.SupplierItemScalePrice": {
"type": "object",
"description": "Model Class: SupplierItemScalePrice ",
"additionalProperties": false,
"required": [
"FromQuantity",
"PurchasePriceNet",
"ReduceStandardPriceByPercent"
],
"properties": {
"FromQuantity": {
"type": "integer",
"description": "The quantity where this scale price starts. This scale price ends at the next highest quantity. If there is no scale price with a higher quantity, then this price is set for all quantities from this point on.",
"format": "int32"
},
"PurchasePriceNet": {
"type": "number",
"description": "Net purchase price of the supplier for the scale price starting from this given quantity to the next scale price with a higher quantity. If you use PurchasePriceNet, you can't use ReduceStandardSpBy% as well. Only one is allowed.",
"format": "decimal"
},
"ReduceStandardPriceByPercent": {
"type": "number",
"description": "Reduces the default purchase price by a percentage. If you use PurchasePriceNet, you can't use ReduceStandardPriceByPercent as well. Only one is allowed.",
"format": "decimal"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateCategoryReference": {
"type": "object",
"description": "Model Class: UpdateCategoryReference ",
"additionalProperties": false,
"required": [
"CategoryId"
],
"properties": {
"CategoryId": {
"description": "Unique ID to identify a category.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItem": {
"type": "object",
"description": "Model Class: UpdateItem ",
"additionalProperties": false,
"properties": {
"SKU": {
"type": "string",
"description": "Item SKU. If no SKU is given when posting an item, the SKU will be generated automatically."
},
"ManufacturerId": {
"description": "The manufacturer ID.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.HerstellerKey"
},
"ResponsiblePersonId": {
"description": "The Responsible person ID.",
"$ref": "#/components/schemas/JTL.Wawi.ContactManagement.Core.Contracts.Domain.Keys.ProductComplianceContactKey"
},
"Categories": {
"type": "array",
"description": "List of all the categories for the item.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateCategoryReference"
}
},
"Name": {
"type": "string",
"description": "Name of the item in the default language in JTL-Wawi."
},
"Description": {
"type": "string",
"description": "Full textdescription for the item"
},
"ShortDescription": {
"type": "string",
"description": "Short description of the item in the default language in JTL-Wawi."
},
"Identifiers": {
"description": "Identifiers for items like EAN and UPC.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemIdentifiers"
},
"Components": {
"type": "array",
"description": "Components for the item if the item is a bill of material.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemComponent"
}
},
"ItemPriceData": {
"description": "Price data of the item.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemPrice"
},
"ActiveSalesChannels": {
"type": "array",
"description": "The list of active sales channels of the item. Only online shops and JTL-POS are permitted. Sales channels that are removed from this list will be deactivated for this item.",
"items": {
"type": "string"
},
"x-delete-saleschannel": {
"PrimitiveType": 7,
"AnyType": 0,
"Value": true
}
},
"SortNumber": {
"type": "integer",
"description": "The sort number of the item, used in some sales channels for ordering items.",
"format": "int32"
},
"Annotation": {
"type": "string",
"description": "The item annotation."
},
"ReleasedOnDate": {
"type": "string",
"description": "The date when the item was put up for sale.",
"format": "date-time"
},
"StorageOptions": {
"description": "Storage options for the item.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemStorageOption"
},
"CountryOfOrigin": {
"type": "string",
"description": "The country of origin of the item."
},
"ShippingClassId": {
"description": "The shipping class ID.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.VersandklasseKey"
},
"ProductGroupId": {
"description": "The ID of the item group.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.WarengruppeKey"
},
"TaxClassId": {
"description": "The ID of the tax class.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey"
},
"Dimensions": {
"description": "The dimensions of the item.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateDimensions"
},
"Weights": {
"description": "The weight of the item.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemWeights"
},
"AllowNegativeStock": {
"type": "boolean",
"description": "This option allows you to sell a higher quantity of the item than is actually in stock."
},
"Quantities": {
"description": "Quantities of the item.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemQuantities"
},
"DangerousGoods": {
"description": "Any information about dangerous goods.",
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemDangerousGoods"
},
"Taric": {
"type": "string",
"description": "Taric code of the item."
},
"SearchTerms": {
"type": "string",
"description": "Search terms for the item."
},
"PriceListActive": {
"type": "boolean",
"description": "Indicates if the item is in the price list."
},
"IgnoreDiscounts": {
"type": "boolean",
"description": "Indicates if discounts are to be disregarded."
},
"AvailabilityId": {
"description": "Availability ID of the item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.LieferstatusKey"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemComponent": {
"type": "object",
"description": "Model Class: UpdateItemComponent ",
"additionalProperties": false,
"required": [
"ItemId",
"Quantity"
],
"properties": {
"ItemId": {
"description": "Item ID of the item's component.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"Quantity": {
"type": "number",
"description": "Quantity of the component in the bill of material.",
"format": "decimal"
},
"SortNumber": {
"type": "integer",
"description": "Defines the order of the components when shown in lists and sales channels.",
"format": "int32"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemCustomerPrice": {
"type": "object",
"description": "Model Class: UpdateItemCustomerPrice ",
"additionalProperties": false,
"properties": {
"NetPrice": {
"type": "number",
"description": "The net sales price of the item. If you use NetPrice, you can't use ReduceStandardSpBy% too. Only one can be used.",
"format": "decimal"
},
"ReduceStandardPriceByPercent": {
"type": "number",
"description": "Reduces the default sales price by a percentage. If you use NetPrice, you can't use ReduceStandardSpBy% too. Only one can be used.",
"format": "decimal"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemDangerousGoods": {
"type": "object",
"description": "Model Class: UpdateItemDangerousGoods ",
"additionalProperties": false,
"properties": {
"UnNumber": {
"type": "string",
"description": "The UN number for the item."
},
"HazardNo": {
"type": "string",
"description": "The hazard number for the item."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemDescription": {
"type": "object",
"description": "Model Class: UpdateItemDescription ",
"additionalProperties": false,
"properties": {
"Name": {
"type": "string",
"description": "The item name in the given language and sales channel. The name in JTL-Wawi and the default language is the default name of the item."
},
"Description": {
"type": "string",
"description": "The item description for the given language and sales channel."
},
"ShortDescription": {
"type": "string",
"description": "An item's short description in the given language and sales channel."
},
"SeoPath": {
"type": "string",
"description": "The SEO path in the given language and sales channel."
},
"SeoMetaDescription": {
"type": "string",
"description": "The SEO meta description in the given language and sales channel."
},
"SeoTitleTag": {
"type": "string",
"description": "The title tag (SEO) in the given language and sales channel."
},
"SeoMetaKeywords": {
"type": "string",
"description": "Meta keywords in the given language and sales channel."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemIdentifiers": {
"type": "object",
"description": "Model Class: UpdateItemIdentifiers ",
"additionalProperties": false,
"properties": {
"Gtin": {
"type": "string",
"description": "GTIN"
},
"ManufacturerNumber": {
"type": "string",
"description": "Manufacturer number."
},
"ISBN": {
"type": "string",
"description": "ISBN"
},
"UPC": {
"type": "string",
"description": "UPC"
},
"AmazonFnsku": {
"type": "string",
"description": "An item's Amazon FNSKU."
},
"Asins": {
"type": "array",
"description": "A list of the item's ASINs.",
"items": {
"type": "string"
}
},
"OwnIdentifier": {
"type": "string",
"description": "A custom identifier for the item."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemImage": {
"type": "object",
"description": "Model Class: UpdateItemImage ",
"additionalProperties": false,
"required": [
"SalesChannelId"
],
"properties": {
"ImageData": {
"type": "string",
"description": "Base64 encoded data of an image.",
"format": "byte"
},
"Filename": {
"type": "string",
"description": "Name of the file."
},
"SalesChannelId": {
"type": "string",
"description": "The sales channel ID for an image. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint(GET)."
},
"SortNumber": {
"type": "integer",
"description": "The sort number for arranging images in sales channels. Every image needs to have an unique sort number per sales channel and item.",
"format": "int32"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemMinimumPurchaseQuantityForCustomerGroup": {
"type": "object",
"description": "Model Class: UpdateItemMinimumPurchaseQuantityForCustomerGroup ",
"additionalProperties": false,
"required": [
"CustomerGroupId"
],
"properties": {
"CustomerGroupId": {
"description": "Unique ID to identify a customer group.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey"
},
"PermissibleOrderQuantity": {
"type": "number",
"description": "The permissible order quantity for the item. Indicates the increments in which the item is sold.",
"format": "decimal"
},
"MinimumPurchaseQuantity": {
"type": "number",
"description": "The minimum purchase quantity for a customer group.",
"format": "decimal"
},
"IsActive": {
"type": "boolean",
"description": "Indicates if this setting is active or deactivated."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemPrice": {
"type": "object",
"description": "Model Class: UpdateItemPrice ",
"additionalProperties": false,
"properties": {
"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"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemQuantities": {
"type": "object",
"description": "Model Class: UpdateItemQuantities ",
"additionalProperties": false,
"properties": {
"MinimumOrderQuantity": {
"type": "number",
"description": "The minimum order quantity of the item.",
"format": "decimal"
},
"MinimumPurchaseQuantityForCustomerGroup": {
"type": "array",
"description": "A collection of minimum order quantities for different customer groups.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemMinimumPurchaseQuantityForCustomerGroup"
}
},
"PermissibleOrderQuantity": {
"type": "number",
"description": "The permissible order quantity for the item. Indicates the increments in which the item is sold.",
"format": "decimal"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemSalesChannelPrice": {
"type": "object",
"description": "Model Class: UpdateItemSalesChannelPrice ",
"additionalProperties": false,
"properties": {
"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": "Reduce the default sales price by a percentage. If you use NetPrice, you can't use ReduceStandardPriceByPercent too. Only one can be used.",
"format": "decimal"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemSalesChannels": {
"type": "object",
"description": "Model Class: UpdateItemSalesChannels ",
"additionalProperties": false,
"properties": {
"ApplyToAllChildItems": {
"type": "boolean",
"description": "Specifies if sales channel activation should be applied to all child items."
},
"Items": {
"type": "array",
"description": "The IDs of the items for which sales channels should be updated.",
"items": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
}
},
"ActivateSalesChannels": {
"type": "array",
"description": "The IDs of the sales channels that should be activated. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint (GET).",
"items": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey"
}
},
"DeactivateSalesChannels": {
"type": "array",
"description": "The ID of the sales channel for this description. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint (GET).",
"items": {
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ShopKey"
}
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemSalesChannelsResponse": {
"type": "object",
"description": "Model Class: UpdateItemSalesChannelsResponse ",
"additionalProperties": false,
"required": [
"NotActivatedForJtlPosItems",
"NotActivatedForScxDueToPartialItems",
"NotActivatedForScxForMissingChildItems",
"NotActivatedBecauseInactiveItems"
],
"properties": {
"NotActivatedForJtlPosItems": {
"type": "array",
"description": "The IDs of the items for which JTL-POS sales channels could not be activated.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemSalesChannelsResponseKeyValuePair"
}
},
"NotActivatedForScxDueToPartialItems": {
"type": "array",
"description": "The IDs of the items for which sales channels cuold not be activated because they are partial items.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemSalesChannelsResponseKeyValuePair"
}
},
"NotActivatedForScxForMissingChildItems": {
"type": "array",
"description": "The IDs of the items for which sales channels cuold not be activated because they are parent items without children.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemSalesChannelsResponseKeyValuePair"
}
},
"NotActivatedBecauseInactiveItems": {
"type": "array",
"description": "The IDs of the items for which sales channels cuold not be activated because they are inactive items.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemSalesChannelsResponseKeyValuePair"
}
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemSalesChannelsResponseKeyValuePair": {
"type": "object",
"description": "Model Class: UpdateItemSalesChannelsResponseKeyValuePair ",
"additionalProperties": false,
"required": [
"Item",
"SalesChannel"
],
"properties": {
"Item": {
"description": "The ID of the item.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey"
},
"SalesChannel": {
"type": "string",
"description": "The sales channel"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemSpecialPrice": {
"type": "object",
"description": "Model Class: UpdateItemSpecialPrice ",
"additionalProperties": false,
"required": [
"IsActive"
],
"properties": {
"SpecialPrice": {
"type": "array",
"description": "List of all special prices for JTL-Wawi and the sales channel with the type online shop and JTL-POS.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateSpecialPrice"
}
},
"IsActive": {
"type": "boolean",
"description": "Indicates if the special price is active."
},
"StartDate": {
"type": "string",
"description": "The date when the special price should start.",
"format": "date-time"
},
"EndDateActive": {
"type": "boolean",
"description": "If set, the special price will end on a given date. In this case, the field EndDate is required."
},
"EndDate": {
"type": "string",
"description": "This is required if EndDateActive is set. In this case, the special price ends on this date.",
"format": "date-time"
},
"TillAmountActive": {
"type": "boolean",
"description": "Indicates that the special price ends when a certain amount is reached. The field TillAmountInStockSmallerThan is required in this case."
},
"TillAmountInStockSmallerThan": {
"type": "integer",
"description": "If this amount of stock for the item is reached, the special price ends. Only applies if TillAmountActive is true.",
"format": "int32"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemStorageOption": {
"type": "object",
"description": "Model Class: UpdateItemStorageOption ",
"additionalProperties": false,
"properties": {
"GlobalMinimumStockLevel": {
"type": "number",
"description": "Defines the minimum quantity that should always be in stock. For example, when calculating purchasing orders.",
"format": "decimal"
},
"Buffer": {
"type": "integer",
"description": "The buffer of the item. Used when selling time-delayed across different sales channels, so as not to sell more than is in stock.",
"format": "int32"
},
"SerialNumberTracking": {
"type": "boolean",
"description": "Indicates if serial numbers are to be identified during a goods receipt process from a supplier."
},
"ProcurementTime": {
"type": "integer",
"description": "The procurement time indicates how many days it will take for the goods to be ready for shipment if they are currently out of stock. Procurement time is determined automatically on the basis of the supplier’s delivery time. By default, the delivery time of the default supplier is used as the procurement time. If additional processing time (in days) has been specified, this is added to the procurement time.",
"format": "int32"
},
"DetermineProcurementTimeAutomatically": {
"type": "boolean",
"description": "If this option is set, the procurement time will be calculated from the default supplier's shipment time."
},
"AdditionalHandlingTime": {
"type": "integer",
"description": "Indicates the additional processing time in days required to process. It is always added to the delivery time.",
"format": "int32"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemSupplier": {
"type": "object",
"description": "Model Class: UpdateItemSupplier ",
"additionalProperties": false,
"properties": {
"Sku": {
"type": "string",
"description": "Item SKU from the supplier."
},
"ItemName": {
"type": "string",
"description": "Item name from the supplier."
},
"IsStandard": {
"type": "boolean",
"description": "Defines the main supplier for the given item."
},
"PurchasePriceNet": {
"type": "number",
"description": "Net purchase price from the supplier.",
"format": "decimal"
},
"TaxRate": {
"type": "number",
"description": "Percent of VAT tax rate.",
"format": "decimal"
},
"MinimumPurchaseQuantity": {
"type": "number",
"description": "The minimum purchase quantity from the supplier.",
"format": "decimal"
},
"PermissibleOrderQuantity": {
"type": "number",
"description": "The permissible order quantity for the item from the supplier. The increments in which the item can be sold.",
"format": "decimal"
},
"DeliveryTime": {
"type": "integer",
"description": "Delivery time in days.",
"format": "int32"
},
"UseSupplierDeliveryTime": {
"type": "boolean",
"description": "If set to true, Wawi will use the delivery time provided by the supplier and not by the item information. DeliveryTime will then be ignored."
},
"Stocklevel": {
"type": "number",
"description": "Stock level of the item at the supplier.",
"format": "decimal"
},
"IsDropshipping": {
"type": "boolean",
"description": "Activates drop shipping for a given item and supplier."
},
"MergeStockLevel": {
"type": "boolean",
"description": "Forces Wawi to add the supplier's stock to your own stock."
},
"Comment": {
"type": "string",
"description": "Comment for the supplier."
},
"PackagingUnit": {
"type": "string",
"description": "Name of the packaging unit."
},
"AmountPackagingUnit": {
"type": "number",
"description": "Quantity in a packaging unit.",
"format": "decimal"
},
"ScalePrices": {
"type": "array",
"description": "Scale prices from this supplier for the item.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateSupplierItemScalePrice"
}
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemVariation": {
"type": "object",
"description": "Model Class: UpdateItemVariation ",
"additionalProperties": false,
"properties": {
"Name": {
"type": "string",
"description": "Name of a variation in the default language."
},
"Translations": {
"type": "array",
"description": "Different terms for a variation in the non-default languages.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateTranslation"
}
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemVariationValue": {
"type": "object",
"description": "Model Class: UpdateItemVariationValue ",
"additionalProperties": false,
"properties": {
"Name": {
"type": "string",
"description": "Name of a variation value in the default language."
},
"Translations": {
"type": "array",
"description": "Different terms for a variation value in the non-default languages.",
"items": {
"$ref": "#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.UpdateTranslation"
}
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateItemWeights": {
"type": "object",
"description": "Model Class: UpdateItemWeights ",
"additionalProperties": false,
"properties": {
"ItemWeigth": {
"type": "number",
"description": "The weight of the item in kilograms.",
"format": "decimal"
},
"ShippingWeight": {
"type": "number",
"description": "The shipping weight of the item in kilograms.",
"format": "decimal"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateSpecialPrice": {
"type": "object",
"description": "Model Class: UpdateSpecialPrice ",
"additionalProperties": false,
"required": [
"IsActive",
"CustomerGroupId",
"NetPrice",
"SalesChannelId"
],
"properties": {
"IsActive": {
"type": "boolean",
"description": "Indicates whether the special price is active at the moment."
},
"CustomerGroupId": {
"description": "The ID of the customer group that uses the special price.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey"
},
"NetPrice": {
"type": "number",
"description": "Net price for the special price.",
"format": "decimal"
},
"SalesChannelId": {
"type": "string",
"description": "The sales channel ID for this special price. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint(GET)."
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.UpdateSupplierItemScalePrice": {
"type": "object",
"description": "Model Class: UpdateSupplierItemScalePrice ",
"additionalProperties": false,
"required": [
"FromQuantity"
],
"properties": {
"FromQuantity": {
"type": "integer",
"description": "The quantity where this scale price starts. This scale price ends at the next highest quantity. If there is no scale price with a higher quantity, then this price is set for all quantities from this point on.",
"format": "int32"
},
"PurchasePriceNet": {
"type": "number",
"description": "Net purchase price of the supplier for the scale price starting from this given quantity to the next scale price with a higher quantity. If you use PurchasePriceNet, you can't use ReduceStandardSpBy% as well. Only one is allowed.",
"format": "decimal"
},
"ReduceStandardPriceByPercent": {
"type": "number",
"description": "Reduces the default purchase price by a percentage. If you use PurchasePriceNet, you can't use ReduceStandardPriceByPercent as well. Only one is allowed.",
"format": "decimal"
}
}
},
"JTL.Wawi.Rest.Contracts.Models.V1.Item.VariationType": {
"type": "integer",
"description": "0 = Dropdown, 1 = Radiobutton, 2 = Swatches, 3 = Textbox, 4 = FreeText, 5 = MandatoryFreeText",
"format": "int32",
"x-enumNames": [
"Dropdown",
"Radiobutton",
"Swatches",
"Textbox",
"FreeText",
"MandatoryFreeText"
],
"enum": [
0,
1,
2,
3,
4,
5
]
},
"JTL.Wawi.Rest.Contracts.Models.V1.Manufacturer.Manufacturer": {
"type": "object",
"description": "Model Class: Manufacturer ",
"additionalProperties": false,
"required": [
"Id",
"Name",
"Description",
"Homepage",
"SortNumber",
"MetaTitle",
"MetaKeywords",
"MetaDescription"
],
"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."
},
"Description": {
"type": "string",
"description": "Manufacturer description."
},
"Homepage": {
"type": "string",
"description": "Homepage of the manufacturer."
},
"SortNumber": {
"type": "integer",
"description": "Sorting number of the manufacturer.",
"format": "int32"
},
"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."
}
}
},
"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",
"$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.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.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.",
"$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.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.",
"$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.",
"$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.",
"$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",
"maximum": 2147483647,
"minimum": 0
},
"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.",
"$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.",
"$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.",
"$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.Data.Contracts.Keys.BenutzerKey"
},
"UserId": {
"description": "The user who is responsible for the sales order.",
"$ref": "#/components/schemas/JTL.Data.Contracts.Keys.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.",
"$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.",
"$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.",
"$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.",
"$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.",
"$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.",
"$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.",
"$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.",
"$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.Stammdaten.Core.Contracts.NumberRanges.Domain.Keys.NumberRangeKey": {
"type": "string",
"description": "Schlüssel für einen Nummernkreis Datensatz",
"format": "uuid",
"additionalProperties": false
}
},
"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": {}
}
}
},
"oauth2-client-credentials": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://auth.jtl-cloud.com/oauth2/token",
"scopes": {}
}
}
}
}
},
"tags": [
{
"name": "worker",
"description": "Returns the Available Syncs of the Worker"
},
{
"name": "wms",
"description": "Query all pick lists for a specific wms warehouse that are not completed."
},
{
"name": "warehouse",
"description": "Query all warehouses"
},
{
"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": "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": "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": "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": "Query all categories"
},
{
"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": "accountingData",
"description": "Planned"
}
]
}