Materials

List all the materials

This endpoint allows you to list all the materials.

get/stocks/materials

Request

  • Base URL: https://api.infraspeak.com/v3
  • URL: https://api.infraspeak.com/v3/stocks/materials
  • Auth: HTTP bearer

Query parameters

expanded'material_type' | 'warehouse' | 'supplier_custom_price'

Comma-separated list of relations to include in the response

searchTextstring

Text string to search for

sort'material_id' | 'code' | 'name' | 'description' | 'sku' | 'ean_upc' | 'updated_at'

Name of the attribute to use for sort order

order'asc' | 'desc'

Direction of the ordering

pageinteger

The page number (1-based) to retrieve the results, according to the limit defined

limitinteger

Limit to restrict the number of entries per page

materialTypeIdinteger

Filter by material type id.

s_material_type_idinteger

Filter by material type id.

materialTypeFolderIdinteger

Filter by material type folder id.

s_material_type_folder_idinteger

Filter by material type folder id.

include_pending_delivery_quantitytrue

Include pending_delivery_quantity field.

include_stock_on_handtrue

Include stock_on_hand field.

include_warehouse_minimum_stocktrue

Include warehouse_minimum_stocks array.

date_max_updated_atstring

Filter by maximum updated_at.

s_updated_at_beforestring

Filter by maximum updated_at.

date_min_updated_atstring

Filter by minimum updated_at.

s_updated_at_afterstring

Filter by minimum updated_at.

s_codestring

Filter by material code.

s_material_id_notinstring

Exclude materials by id. It should be separated by comma in case of multiple ids

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.