List all materials

get

https://api.katanamrp.com/v1/materials

Returns a list of materials you’ve previously created. The materials are returned in sorted order, with the most recent materials appearing first.

Query Params

ids

array of integers

Filters materials by an array of IDs

ids

name

string

Filters materials by a name

uom

string

Filters materials by a uom

default_supplier_id

integer

Filters materials by a default_supplier_id

is_sellable

boolean

Filters materials by a is_sellable

batch_tracked

boolean

Filters materials by a batch_tracked

purchase_uom

string

Filters materials by a purchase_uom

purchase_uom_conversion_rate

number

Filters materials by a purchase_uom_conversion_rate

extend

array of strings

Array of objects that need to be added to the response

extend

include_deleted

boolean

Soft-deleted data is excluded from result set by default. Set to true to include it.

include_archived

boolean

Archived data is excluded from result set by default. Set to true to include it.

limit

string

Used for pagination (default is 50)

page

string

Used for pagination (default is 1)

created_at_min

string

Minimum value for created_at range. Must be compatible with ISO 8601 format

created_at_max

string

Maximum value for created_at range. Must be compatible with ISO 8601 format

updated_at_min

string

Minimum value for updated_at range. Must be compatible with ISO 8601 format

updated_at_max

string

Maximum value for updated_at range. Must be compatible with ISO 8601 format

Responses

Language

Credentials

Bearer

Response

Choose an example:

application/json

200List all materials

401Make sure you've entered your API token correctly.

429The rate limit has been reached. Please try again later.

500The server encountered an error. If this persists, please contact support