JTL-WAWI API (Cloud) (1.1)

Introduction

Welcome 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.

Authentication

You 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:

AppId
DisplayName
Description
Version
ProviderName
ProviderWebsite
MandatoryApiScopes

This 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.

Before 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.

The 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.

After 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!

This 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.

Download OpenAPI description

openapi.json

openapi.yaml

Overview

URL

https://developer.jtl-software.com/

JTL-Software-GmbH

partner@jtl-software.com

Servers

Mock server

https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/

https://api.jtl-cloud.com/erp/

info

Operations

worker

Planned

Operations

features

Operations

printer

Operations

company

Operations

supplier

Operations

colorcodes

Operations

item

Operations

property

Operations

Query Properties

Request

Query all properties for items

Security

(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)

Headers

api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

The User-Id as int or uuid to run the Request, a JTL-Wawi user can be specified to perform an API call on their behalf (more details in the documentation, Optional). To use the Header, you must have the needed Scope 'Application.RunAs'

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

curl -i -X GET \
  https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/properties \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

Returns all properties.

Bodyapplication/json

TotalItemsinteger(int32)required

Gets or sets the total number of items available in the data source.

PageNumberinteger(int32)required

Gets or sets the current page number in the paginated list.

PageSizeinteger(int32)required

Gets or sets the number of items per page in the paginated list.

ItemsArray of objects(JTL.Wawi.Rest.Contracts.Models.Property.Property)required

Gets or sets the collection of items contained in the paged list.

Items[].Idinteger(int32)required

Unique ID to identify a property.

Example: 51

Items[].Namestringrequired

Name of the property in the standard language.

Example: "Nightvision"

Items[].TranslationsArray of objects(JTL.Wawi.Rest.Contracts.Models.Common.Translation)required

Different terms for the property in the non-default languages.

Items[].Translations[].LanguageIsostringrequired

The language ISO code

Example: "DE"

Items[].Translations[].Namestringrequired

The word in the corresponding language

Example: "German"

Items[].PropertyGroupsArray of integers(int32)required

IDs of property groups.

Example: ""

TotalPagesinteger(int32)read-only

Gets the total number of pages based on the total number of items and the page size.

HasPreviousPagebooleanread-only

Gets a value indicating whether there is a previous page available in the paginated list.

HasNextPagebooleanread-only

Gets a value indicating whether there is a next page available.

NextPageNumberinteger(int32)read-only

Gets the number of the next page if there is one; otherwise, returns the total number of pages.

PreviousPageNumberinteger(int32)read-only

Gets the number of the previous page. If there is no previous page, it returns 1.

Response

application/json

{
  "TotalItems": 0,
  "PageNumber": 0,
  "PageSize": 0,
  "Items": [
    { … }
  ],
  "TotalPages": 0,
  "HasPreviousPage": true,
  "HasNextPage": true,
  "NextPageNumber": 0,
  "PreviousPageNumber": 0
}

Create Property

Request

Create a new property

Security

(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)

Headers

api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

Bodyapplication/jsonrequired

The property to create.

Namestringrequired

Name of the property in the standard language.

Example: "Nightvision"

TranslationsArray of objects(JTL.Wawi.Rest.Contracts.Models.Common.CreateTranslation)

Different terms for the property in the non-default languages.

PropertyGroupsArray of integers(int32)

IDs of property groups.

Example: ""

curl -i -X POST \
  https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/properties \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string' \
  -d '{
    "Name": "Nightvision",
    "Translations": [
      {
        "LanguageIso": "DE",
        "Name": "German"
      }
    ],
    "PropertyGroups": ""
  }'

Responses

The created property.

Bodyapplication/json

Idinteger(int32)required

Unique ID to identify a property.

Example: 51

Namestringrequired

Name of the property in the standard language.

Example: "Nightvision"

TranslationsArray of objects(JTL.Wawi.Rest.Contracts.Models.Common.Translation)required

Different terms for the property in the non-default languages.

Translations[].LanguageIsostringrequired

The language ISO code

Example: "DE"

Translations[].Namestringrequired

The word in the corresponding language

Example: "German"

PropertyGroupsArray of integers(int32)required

IDs of property groups.

Example: ""

Response

application/json

{
  "Id": 51,
  "Name": "Nightvision",
  "Translations": [
    { … }
  ],
  "PropertyGroups": ""
}

Query Property Values

Request

Query all velues for a specific property

Security

(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)

Path

propertyIdinteger(int32)required

The id of the property that the property values belong to.

Headers

api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

curl -i -X GET \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/properties/{propertyId}/values' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

The requested property values of the property.

Bodyapplication/jsonArray [

Idinteger(int32)required

Unique ID to identify the property value.

Example: 20

Namestringrequired

Name of the property value in the default language.

Example: "yes"

Descriptionstringrequired

Description of the property value in the default language.

Example: "A description for the property value"

]

Response

application/json

[
  {
    "Id": 20,
    "Name": "yes",
    "Description": "A description for the property value"
  }
]

Create Property Value

Request

Create a new value for a specific property

Security

(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)

Path

propertyIdinteger(int32)required

The id of the property that the property values belong to.

Headers

api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

Bodyapplication/jsonrequired

The value of the property.

Namestringrequired

Name of the property value in the default language.

Example: "yes"

Descriptionstring

Description of the property value in the default language.

Example: "A description for the property value"

curl -i -X POST \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/properties/{propertyId}/values' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string' \
  -d '{
    "Name": "yes",
    "Description": "A description for the property value"
  }'

Responses

The created property value.

Bodyapplication/json

Idinteger(int32)required

Unique ID to identify the property value.

Example: 20

Namestringrequired

Name of the property value in the default language.

Example: "yes"

Descriptionstringrequired

Description of the property value in the default language.

Example: "A description for the property value"

Response

application/json

{
  "Id": 20,
  "Name": "yes",
  "Description": "A description for the property value"
}

Delete Property Value

Request

Delete a specific value for a given property

Security

(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)

Path

propertyIdinteger(int32)required

The id of the property that the property values belong to.

propertyValueIdinteger(int32)required

The id of the property value.

Headers

api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

curl -i -X DELETE \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/properties/{propertyId}/values/{propertyValueId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

Bodyapplication/json

Response

application/json

null

Update Property Value

Request

Update the value of a specific property

Security

(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)

Path

propertyIdinteger(int32)required

The id of the property that the property values belong to.

propertyValueIdinteger(int32)required

The id of the property value.

Headers

api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

Bodyapplication/jsonrequired

The value of the property.

Namestring

Name of the property value in the default language.

Example: "yes"

Descriptionstring

Description of the property value in the default language.

Example: "A description for the property value"

curl -i -X PATCH \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/properties/{propertyId}/values/{propertyValueId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string' \
  -d '{
    "Name": "yes",
    "Description": "A description for the property value"
  }'

Responses

Bodyapplication/json

Response

application/json

null

Query Property Value Descriptions

Request

Query all descriptions for a specific property value

Security

(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)

Path

propertyIdinteger(int32)required

The id of the property.

propertyValueIdinteger(int32)required

The id of the property value.

Headers

api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

curl -i -X GET \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/properties/{propertyId}/values/{propertyValueId}/descriptions' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

The requested property value descriptions.

Bodyapplication/jsonArray [

PropertyValueIdinteger(int32)required

Unique ID to identify a property value.

Example: 20

Namestringrequired

The property value name in the given language.

Example: "yes"

Descriptionstringrequired

The property value description in the given language.

Example: "A description for the property value"

SeoPathstringrequired

The SEO path in the given language.

Example: "SEO path"

SeoMetaDescriptionstringrequired

The SEO metadescription in the given language.

Example: "A description for the property value"

SeoTitleTagstringrequired

The title tag (SEO) in the given language.

Example: "yes"

SeoMetaKeywordsstringrequired

The meta keywords in the given language.

Example: "Your metakeywords"

LanguageIsostringrequired

The ISO code of the language of the description.

Example: "DE"

]

Response

application/json

[
  {
    "PropertyValueId": 20,
    "Name": "yes",
    "Description": "A description for the property value",
    "SeoPath": "SEO path",
    "SeoMetaDescription": "A description for the property value",
    "SeoTitleTag": "yes",
    "SeoMetaKeywords": "Your metakeywords",
    "LanguageIso": "DE"
  }
]

Create Property Value Description

Request

Create a new description for a specific property value

Security

(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)

Path

propertyIdinteger(int32)required

The id of the property.

propertyValueIdinteger(int32)required

The id of the property value.

Headers

api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

Bodyapplication/jsonrequired

The PropertyValueDescription to create.

PropertyValueIdinteger(int32)required

Unique ID to identify a property value.

Example: 20

Namestringrequired

The property value name in the given language.

Example: "yes"

Descriptionstring

The property value description in the given language.

Example: "A description for the property value"

SeoPathstring

The SEO path in the given language.

Example: "SEO path"

SeoMetaDescriptionstring

The SEO metadescription in the given language.

Example: "A description for the property value"

SeoTitleTagstring

The title tag (SEO) in the given language.

Example: "yes"

SeoMetaKeywordsstring

The meta keywords in the given language.

Example: "Your metakeywords"

LanguageIsostringrequired

The ISO code of the language of the description.

Example: "DE"

curl -i -X POST \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/properties/{propertyId}/values/{propertyValueId}/descriptions' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string' \
  -d '{
    "PropertyValueId": 20,
    "Name": "yes",
    "Description": "A description for the property value",
    "SeoPath": "SEO path",
    "SeoMetaDescription": "A description for the property value",
    "SeoTitleTag": "yes",
    "SeoMetaKeywords": "Your metakeywords",
    "LanguageIso": "DE"
  }'

Responses

The created property value description.

Bodyapplication/json

PropertyValueIdinteger(int32)required

Unique ID to identify a property value.

Example: 20

Namestringrequired

The property value name in the given language.

Example: "yes"

Descriptionstringrequired

The property value description in the given language.

Example: "A description for the property value"

SeoPathstringrequired

The SEO path in the given language.

Example: "SEO path"

SeoMetaDescriptionstringrequired

The SEO metadescription in the given language.

Example: "A description for the property value"

SeoTitleTagstringrequired

The title tag (SEO) in the given language.

Example: "yes"

SeoMetaKeywordsstringrequired

The meta keywords in the given language.

Example: "Your metakeywords"

LanguageIsostringrequired

The ISO code of the language of the description.

Example: "DE"

Response

application/json

{
  "PropertyValueId": 20,
  "Name": "yes",
  "Description": "A description for the property value",
  "SeoPath": "SEO path",
  "SeoMetaDescription": "A description for the property value",
  "SeoTitleTag": "yes",
  "SeoMetaKeywords": "Your metakeywords",
  "LanguageIso": "DE"
}

Delete Property Value Description

Request

Delete the description for a specific property value and language

Security

(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)

Path

propertyIdinteger(int32)required

The id of the property.

propertyValueIdinteger(int32)required

The id of the property value.

languageIsostringrequired

The iso code of the language that the descriptions belong to.

Headers

api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

curl -i -X DELETE \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/properties/{propertyId}/values/{propertyValueId}/descriptions/{languageIso}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

Bodyapplication/json

Response

application/json

null

Update Property Value Description

Request

Update the description for a specific property value and language

Security

(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)

Path

propertyIdinteger(int32)required

The id of the property.

propertyValueIdinteger(int32)required

The id of the property value.

languageIsostringrequired

The iso code of the language that the descriptions belong to.

Headers

api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

Bodyapplication/jsonrequired

The property value description to update.

Namestring

The property value name in the given language.

Example: "yes"

Descriptionstring

The property value description in the given language.

Example: "A description for the property value"

SeoPathstring

The SEO path in the given language.

Example: "SEO path"

SeoMetaDescriptionstring

The SEO metadescription in the given language.

Example: "A description for the property value"

SeoTitleTagstring

The title tag (SEO) in the given language.

Example: "yes"

SeoMetaKeywordsstring

The meta keywords in the given language.

Example: "Your metakeywords"

curl -i -X PATCH \
  'https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/properties/{propertyId}/values/{propertyValueId}/descriptions/{languageIso}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string' \
  -d '{
    "Name": "yes",
    "Description": "A description for the property value",
    "SeoPath": "SEO path",
    "SeoMetaDescription": "A description for the property value",
    "SeoTitleTag": "yes",
    "SeoMetaKeywords": "Your metakeywords"
  }'

Responses

Bodyapplication/json

Response

application/json

null

Query Property Groups

Request

Query all groups for properties

Security

(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)

Headers

api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

curl -i -X GET \
  https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/properties/groups \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

Returns all property groups.

Bodyapplication/json

TotalItemsinteger(int32)required

Gets or sets the total number of items available in the data source.

PageNumberinteger(int32)required

Gets or sets the current page number in the paginated list.

PageSizeinteger(int32)required

Gets or sets the number of items per page in the paginated list.

ItemsArray of objects(JTL.Wawi.Rest.Contracts.Models.Property.PropertyGroup)required

Gets or sets the collection of items contained in the paged list.

Items[].Idinteger(int32)required

Unique ID to identify a property group.

Example: 33

Items[].Namestringrequired

Name of the property group.

Example: "features"

TotalPagesinteger(int32)read-only

Gets the total number of pages based on the total number of items and the page size.

HasPreviousPagebooleanread-only

Gets a value indicating whether there is a previous page available in the paginated list.

HasNextPagebooleanread-only

Gets a value indicating whether there is a next page available.

NextPageNumberinteger(int32)read-only

Gets the number of the next page if there is one; otherwise, returns the total number of pages.

PreviousPageNumberinteger(int32)read-only

Gets the number of the previous page. If there is no previous page, it returns 1.

Response

application/json

{
  "TotalItems": 0,
  "PageNumber": 0,
  "PageSize": 0,
  "Items": [
    { … }
  ],
  "TotalPages": 0,
  "HasPreviousPage": true,
  "HasNextPage": true,
  "NextPageNumber": 0,
  "PreviousPageNumber": 0
}

Create Property Group

Request

Create a new property group

Security

(oauth2-cloud-id-accessCode and Wawi) or (oauth2-application and Wawi)

Headers

api-versionstring

The requested API version

x-appidstringrequired

This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, in this case "1.0.0".

x-runasstring

X-SessionIdstring(uuid)

The id of a Session, in wich we call would be executed

tenant-idstring(uuid)required

Specify the TenantId in GUID Format

x-api-keystring(uuid)required

Specify the ApiKey from RegistrationProcess in Uuid Format

Bodyapplication/jsonrequired

The property group to create.

Namestringrequired

Name of the property group.

Example: "features"

curl -i -X POST \
  https://developer.jtl-software.com/_mock/products/erpapi/1.1-cloud/openapi/properties/groups \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'tenant-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string' \
  -d '{
    "Name": "features"
  }'

Responses

The created property group.

Bodyapplication/json

Idinteger(int32)required

Unique ID to identify a property group.

Example: 33

Namestringrequired

Name of the property group.

Example: "features"

Response

application/json

{
  "Id": 33,
  "Name": "features"
}

returnstate

Planned

Operations

onholdreason

Operations

returnreason

Planned

Operations

saleschannel

Operations

customerGroup

Operations

paymentmethod

Operations

odata

Operations

shippingmethod

Operations

warehouse

Operations

customerCategory

Operations

return

Operations

cancellationreason

Operations

transactionStatus

Operations

invoice

Planned

Operations

customer

Operations

salesorder

Operations

Configuration

Planned

Operations

deliverynote

Planned

Operations

appRegistration

Operations

logout

Operations

wms

Operations

stock

Operations

accountingData

Planned

Operations

tax

Operations

shipping

Development

offer

Operations

creditnote

Operations

JTL-WAWI API (Cloud) (1.1)

Introduction

Authentication

info

worker

features

printer

company

supplier

colorcodes

item

property

Query Properties

Request

Responses

Was this helpful?

Create Property

RequestExpand all

Responses

Was this helpful?

Query Property Values

Request

Responses

Was this helpful?

Create Property Value

Request

Responses

Was this helpful?

Delete Property Value

Request

Responses

Was this helpful?

Update Property Value

Request

Responses

Was this helpful?

Query Property Value Descriptions

Request

Responses

Was this helpful?

Create Property Value Description

Request

Responses

Was this helpful?

Delete Property Value Description

Request

Responses

Was this helpful?

Update Property Value Description

Request

Responses

Was this helpful?

Query Property Groups

Request

Responses

Was this helpful?

Create Property Group

Request

Responses

Was this helpful?

returnstate

onholdreason

returnreason

saleschannel

customerGroup

paymentmethod

odata

shippingmethod

warehouse

customerCategory

return

cancellationreason

transactionStatus

invoice

customer

category

salesorder

Configuration

deliverynote

appRegistration

Request