NextGen APIs

GET /inventory/materials/r1/materials

Http Verb

GET

Url

/inventory/materials/r1/materials

Permissions required

Material: View (fsm.core.material.view)

or

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

Personally Identifiable Information (PII)

No

Sensitive Information

No

Last Modified Version

r1

Released since

TBD

Deprecated since


Removed since


Tech Tags

PAGINATION ORDERING-SERVER-SIDE MULTILANGUAGE-FIELDS

Business Logic

This API returns a list of Materials filtered by input criteria.

Query String Parameters

Filter ℹ️

Field

Validations

Note

id


Collection of ids

code


Collection of codes

description


Wildcard search enabled

measurementUnitId


 Collection of ids

validityBegin

Format: ISO-8601


validityEnd

Format: ISO-8601


typeId


Collection of ids

managementTypeId


Collection of ids

classId


Collection of ids

itemTypeId


Collection of ids

goodsGroupId


Collection of ids

brandId


Collection of ids

alternativeCode


Wildcard search enabled

extendedDescription


Wildcard search enabled

externalStatus


Wildcard search enabled

note


Wildcard search enabled

externalSystemId


Collection of ids

generic



active



managedInStock



Order ℹ️

Default Order

order (ASC)

Page ℹ️

Default.

Fields ℹ️

Default.

Language ℹ️

Default.

Header Parameters

Default.

Response documentation

Response payload fields

Field

Note

id


code


description

multilanguage field

measureUnitId


validityBegin


validityEnd


typeId


managementTypeId


materialClassId


itemTypeId


goodsGroupId


meterBrandId


alternativeCode


extendedDescription

multilanguage field

externalStatus


note

multilanguage field

externalSystemId


generic


active


managedInStock


Response error codes

BASE_0001