List all Material groups

Owned by Pat Gauvin
Last updated: Sept 17, 2024
1 min read

GET /api/v2/pricing/material_groups

This endpoint is used to retrieve information on all material groups registered in Rx-Universe.

image-20240917-150429.png

 

Accepts

 

  • A limit. If provided only this many records will be returned. Please note that the default value of 10 listed in swagger is the default value set for the Swagger UI only - calling the endpoint without a limit from your system will return all records, not 10.

  • An offset. This is intended for use with the limit to retrieve records in batches. "limit": 10, "offset": 0 returns the first 10 records; "limit": 10, "offset": 10 retrieves records 11-20; etc.

Success

  • A JSON object representing the requested material groups

    • The total count of material groups that match the query, ignoring provided limit and offset

    • An array of objects representing the requested material groups

Property

Description

code

string

The unique code identifying the material group

desc

string

The text description for the material group

materials

array

Returns the materials that are part of the group

materials/code

string

The unique code identifying the material

materials/desc

string

The text description for the material