POST /integration/inventory/r1/materials

BPMN Diagram

Business Logic

This Integration API creates or updates material’s registry.

System verifies Permission Required and starts the elaboration that is organized in steps.

STEP 1 - External System Validation

System takes Input fields and checks their existence in internal configuration.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 2 - Measurement Unit Validation

System takes Input fields and checks their existence in internal configuration.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 3 - Material Type Validation

System takes Input fields and checks their existence in internal configuration.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 4 - Material Management Type Validation

System takes Input fields and checks their existence in internal configuration.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 5 - Material Class Validation

System takes Input fields and checks their existence in internal configuration.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 6 - Material Item Validation

System takes Input fields and checks their existence in internal configuration.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 7 - Goods Group Validation

System takes Input fields and checks their existence in internal configuration.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 8 - Meter Brand Validation

System takes Input fields and checks their existence in internal configuration.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 9 - Material Existence

System takes Input fields and checks their existence.

If System can obtain the Output fields → Update → continue to step Material Update.

If System can’t obtain the Output fields → Creation → continue to next step.

STEP 10 - Material Creation

System takes Input fields and creates the entity.

If Response State is SUCCESS → elaboration is stopped. See Response payload fields.

If Response State is ERROR → elaboration is stopped. See Response payload fields.

STEP 11 - Material Update

System takes Input fields and updates the entity.

This step is skipped if Input fields are absent.

If Response State is SUCCESS → elaboration is stopped. See Response payload fields.

If Response State is ERROR → elaboration is stopped. See Response payload fields.

Path Parameters

As their name suggests, they are included in the URL path of the endpoint.

Not applicable.

Query String Parameters

Start with a ? and includes parameters listed one after the another separated by &.

Not applicable.

Header Parameters

Parameters included in the request headers. Generally, request headers are used to keep authorization parameters.

Default.

Request Body Parameters

Request body parameters are used when clients send data to the API. They are shipped in a JSON Object only in POST, PUT, or PATCH requests.

The objects in input could have also the extension object that allows to add additional, customized data to this API. More info here How to use APIs: Custom data via Extension.

Request example

Creation example

{
    "extension": {},
    "code": "materialIdentifier",
    "externalSystemCode": "SAP",
    "description": [
        {
            "lang": "en",
            "value": "DESCRIPTION"
        }
    ],
    "measurementUnitCode": "KG",
    "validityBegin": "2024-08-22T09:51:10.477Z",
    "validityEnd": "2024-08-22T09:51:10.477Z",
    "typeCode": "INTERNAL",
    "managementTypeCode": "CON",
    "classCode": "GEN",
    "itemCode": "BS",
    "goodsGroupCode": "TEST",
    "meterBrandCode": "WB",
    "alternativeCode": "string",
    "extendedDescription": [
        {
            "lang": "en",
            "value": "EXTENDED DESCRIPTION"
        }
    ],
    "generic": false,
    "managedInStock": true
}

Update example

{
    "extension": {},
    "code": "materialIdentifier",
    "externalSystemCode": "SAP",
    "alternativeCode": "CODE_alternative",
    "description": [
        {
            "lang": "en",
            "value": "DESCRIPTION"
        }
    ],
    "extendedDescription": [
        {
            "lang": "en",
            "value": "EXTENDED_DESCRIPTION"
        }
    ],
    "note": [
        {
            "lang": "en",
            "value": "NOTE"
        }
    ]
}

Response documentation

Response payload fields

Compliant with RFC Standard https://www.rfc-editor.org/rfc/rfc9457.html

Extension fields:

Response example

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "External system string does not exist",
  "instance": "/integration/inventory/r1/materials",
  "code": "IA001_001"
}

 Response error codes