JTjtl-software
colorcodes

Query Color Codes

Query all color codes for sales orders

get/v2/colorCodes

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
      Scopesorders.read
    • or OAuth 2
      Client credentials
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopesorders.read
  • 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.

Response

Returns all color codes.

idstring uuid

Represents a key for identifying a color entity in the system.

namestring

Name of the colour code.

codestring

Hexadecimal color code (e.g., "#00FF00" for green).

Example response

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

Changes

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