JTjtl-software
property

Create Property

Create a new property

post/v2/properties

Request

  • Base URL
    https://scx-sbx.api.jtl-software.com
  • Auth
    • OAuth 2
      Authorization codehttps://auth.jtl-cloud.com/oauth2/auth
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopesitems.write
    • or OAuth 2
      Client credentials
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopesitems.write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Request body

namestring

Name of the property in the standard language.

propertyGroupsJTLDataContractsKeysMerkmalGruppeKey[]

IDs of property groups.

Example request

{
  "propertyGroups": [
    "b45f6432-2462-4c6f-b00f-1d9d01000000"
  ]
}

Response

The created property.

idstring uuid
namestring

Name of the property in the standard language.

propertyGroupsJTLDataContractsKeysMerkmalGruppeKey[]

IDs of property groups.

Example response

{
  "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "propertyGroups": [
    "b45f6432-2462-4c6f-b00f-1d9d01000000"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.