NextGen APIs
NextGen APIs
Breadcrumbs

DELETE /integration/inventory/r1/materials/{code}

Http Verb

DELETE

Url

/integration/inventory/r1/materials/{code}

Permissions required

Material: Edit (fsm.core.material.edit)

Last Modified Version

r1

Tech Tags


Available Async

No

BPMN Diagram

diagram (30).svg

Business Logic

This Integration API deletes the required 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.

API Verb: GET

Resource: External Systems

Input: externalSystemCode, active=true

Output: externalSystemId

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.

Error Type:

STEP 2 - Material Existence

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

API Verb: GET

Resource: Materials

Input: code, active=true

Output: materialId

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

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

Error Type:

STEP 3 - Material Update

System takes materialId as Input field and updates the entity passing externalSystemCode and active = false.

This step is skipped if Input fields are absent.

API Verb: PATCH

Resource: Material

Input QueryParam: materialId

Input Body: externalSystemCode, active = false

Output: Response State

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

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

Error Type:

  • Others - see link in Resource

Path Parameters

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

Field

Description

Mandatory

Constraint

1

code

Material Code

Y

Not Blank

Query String Parameters

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

Filters

Field

Description

Mandatory

Constraint

1

externalSystemCode

External System Code

Y

Not Blank

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.

Not Applicable

Request example

JSON
{baseUrl}/integration/inventory/r1/materials/{code}?externalSystemCode=SAP

 

Response documentation

Response payload fields

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

Extension fields:

Field

Description

Note

code

Extension member of a Problem Details Object that contains the error code

Only for ERROR

Response example

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

 Response error codes