CommodityCode

Commodity Code (SOVA)

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

Warennummer

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

activebooleanRead-onlyOptional

active

Default: true

commodityCodestringRequired

Warennummer

Pattern: \d{8}

descriptionstring · max: 255Optional

Beschreibung

specialUnitTypestring · max: 16Optional

besondere Maßeinheit

specialUnitTypeCodestringOptional

besondere Maßeinheit (numerischer Code)

Pattern: \d{2}

404

Resource with given ID was not found

*/*

get

/cmn/commodity-codes/{id}

HTTPcURLJavaScriptPython

GET /api/cmn/commodity-codes/{id} HTTP/1.1
Host: 10.102.25.208:32788
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-05-15T04:12:57.971Z",
    "createdFrom": "text",
    "updatedAt": "2026-05-15T04:12:57.971Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "commodityCode": "text",
  "description": "text",
  "specialUnitType": "text",
  "specialUnitTypeCode": "text"
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

application/json

Warennummer

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

activebooleanRead-onlyOptional

active

Default: true

commodityCodestringRequired

Warennummer

Pattern: \d{8}

descriptionstring · max: 255Optional

Beschreibung

specialUnitTypestring · max: 16Optional

besondere Maßeinheit

specialUnitTypeCodestringOptional

besondere Maßeinheit (numerischer Code)

Pattern: \d{2}

Responses

200

successful operation

*/*

Warennummer

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

activebooleanRead-onlyOptional

active

Default: true

commodityCodestringRequired

Warennummer

Pattern: \d{8}

descriptionstring · max: 255Optional

Beschreibung

specialUnitTypestring · max: 16Optional

besondere Maßeinheit

specialUnitTypeCodestringOptional

besondere Maßeinheit (numerischer Code)

Pattern: \d{2}

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

put

/cmn/commodity-codes/{id}

HTTPcURLJavaScriptPython

PUT /api/cmn/commodity-codes/{id} HTTP/1.1
Host: 10.102.25.208:32788
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "version": "text",
  "info": {},
  "id": "text",
  "commodityCode": "text",
  "description": "text",
  "specialUnitType": "text",
  "specialUnitTypeCode": "text"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-05-15T04:12:57.971Z",
    "createdFrom": "text",
    "updatedAt": "2026-05-15T04:12:57.971Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "commodityCode": "text",
  "description": "text",
  "specialUnitType": "text",
  "specialUnitTypeCode": "text"
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

contextstringOptional

message context

messageValuestringOptional

message

404

Resource was not found

*/*

409

unable to delete Resource, due to constraints, existing references or internal state

*/*

delete

/cmn/commodity-codes/{id}

HTTPcURLJavaScriptPython

DELETE /api/cmn/commodity-codes/{id} HTTP/1.1
Host: 10.102.25.208:32788
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

deaktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

*/*

Warennummer

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

activebooleanRead-onlyOptional

active

Default: true

commodityCodestringRequired

Warennummer

Pattern: \d{8}

descriptionstring · max: 255Optional

Beschreibung

specialUnitTypestring · max: 16Optional

besondere Maßeinheit

specialUnitTypeCodestringOptional

besondere Maßeinheit (numerischer Code)

Pattern: \d{2}

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

put

/cmn/commodity-codes/{id}/deactivate

HTTPcURLJavaScriptPython

PUT /api/cmn/commodity-codes/{id}/deactivate HTTP/1.1
Host: 10.102.25.208:32788
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-05-15T04:12:57.971Z",
    "createdFrom": "text",
    "updatedAt": "2026-05-15T04:12:57.971Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "commodityCode": "text",
  "description": "text",
  "specialUnitType": "text",
  "specialUnitTypeCode": "text"
}

aktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

*/*

Warennummer

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

activebooleanRead-onlyOptional

active

Default: true

commodityCodestringRequired

Warennummer

Pattern: \d{8}

descriptionstring · max: 255Optional

Beschreibung

specialUnitTypestring · max: 16Optional

besondere Maßeinheit

specialUnitTypeCodestringOptional

besondere Maßeinheit (numerischer Code)

Pattern: \d{2}

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

put

/cmn/commodity-codes/{id}/activate

HTTPcURLJavaScriptPython

PUT /api/cmn/commodity-codes/{id}/activate HTTP/1.1
Host: 10.102.25.208:32788
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-05-15T04:12:57.971Z",
    "createdFrom": "text",
    "updatedAt": "2026-05-15T04:12:57.971Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "commodityCode": "text",
  "description": "text",
  "specialUnitType": "text",
  "specialUnitTypeCode": "text"
}

Create new Resource

post

Body

application/json

Warennummer

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

activebooleanRead-onlyOptional

active

Default: true

commodityCodestringRequired

Warennummer

Pattern: \d{8}

descriptionstring · max: 255Optional

Beschreibung

specialUnitTypestring · max: 16Optional

besondere Maßeinheit

specialUnitTypeCodestringOptional

besondere Maßeinheit (numerischer Code)

Pattern: \d{2}

Responses

200

successful operation

*/*

Warennummer

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

activebooleanRead-onlyOptional

active

Default: true

commodityCodestringRequired

Warennummer

Pattern: \d{8}

descriptionstring · max: 255Optional

Beschreibung

specialUnitTypestring · max: 16Optional

besondere Maßeinheit

specialUnitTypeCodestringOptional

besondere Maßeinheit (numerischer Code)

Pattern: \d{2}

422

Resource was not valid to process

*/*

post

/cmn/commodity-codes

HTTPcURLJavaScriptPython

POST /api/cmn/commodity-codes HTTP/1.1
Host: 10.102.25.208:32788
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "version": "text",
  "info": {},
  "id": "text",
  "commodityCode": "text",
  "description": "text",
  "specialUnitType": "text",
  "specialUnitTypeCode": "text"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-05-15T04:12:57.971Z",
    "createdFrom": "text",
    "updatedAt": "2026-05-15T04:12:57.971Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "commodityCode": "text",
  "description": "text",
  "specialUnitType": "text",
  "specialUnitTypeCode": "text"
}