Parts
Changed onThis request returns a list of Parts with top level information such as name, last edited, etc.
Note: this endpoint supports pagination. Please refer to the Pagination section for more information.
Return data description
| Property | Description |
|---|---|
| number | The Part's Number. e.g. 25x25x1 |
| name | The Part's Name. e.g. Filter |
| generalStock | How many of this Part you have in stock. Not including purchase orders. |
| unitCode | The unit code displayed for the part. This represents the unit of measure assigned to the part (e.g., "kg", "lb", "each", etc.). If no unit is assigned, this field will be null. |
| generalPrice | The default price of this part. Not considering purchase oder prices. |
| category | The category this Part belongs to |
| location | The Location of this Part. e.g. Shelf A |
| minQtyStatus | Is the Part currently under the min quantity threshold. 0 = false, 1 = true. |
| minQtyThreshold | The number at which reordering of this part is triggered. -1 means this feature is turned off. |
| maxQtyThreshold | The number to bring the parts quantity back to. For example, if my inventory is at 4 and my maxQtyThreshold is 20 I will be reordering 16 parts to bring my inventory back up to the max quantity. |
| staleThreshold | This value is how many days will need to go without a User using this Part by before this Part is considering stale. |
| staleStatus | Is the Part stale or not. 0 = false, 1 = true. |
| userID | The user that will receive threshold notifications and Tasks if thresholds are hit. |
| team | The team that will receive threshold notifications and Tasks if thresholds are hit. |
| stockOnHand | General Stock plus any unused, received PO Quantities for this part. This matches the 'Qty' value seen in the CMMS Part Management page. |
| pos | Array of purchase order objects. price and quantity do not effect generalStock and generalPrice listed above. |
| image | Array of objects that have a file name and a link you can use to download that image. All links are only valid for 15 minutes, a new call will generate a new link. |
Request
- Base URL{{server}}:{{port}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
This parameter is used to only get specific Parts. This parameter accepts a comma delimited list of part IDs.
This parameter is used to only get Parts at a specific group of Locations. This parameter accepts a comma delimited list of Location IDs.
This parameter is used to only get specific parts. This parameter expects a string either a full name of a part or a partial name with the wildcard %.
This parameter is used to only get Parts that were last edited after the unix timestamp passed into the start parameter. For example, all Parts that were last edited after April 18th, 2018.
This parameter is used to only get Parts that were last edited before the unix timestamp passed into the end parameter.
This parameter is a cursor that selects what partID you want to start receiving results at. e.g. passing 137 here will only get you parts with an id greater than 137.
This parameter is a result limiter. The default is set to return no more than 100 results at one time. Maximum allowed value is 1000.
This parameter is used to only get parts with part numbers that match the list provided. This parameter accepts a comma delimited list of Part Numbers.
This parameter is used to paginate results based on the limit. Refer to Pagination section for more information.
Response
Parts
Changes
- warning
for the
queryrequest parameterlimit, the max was set to1000.00 - warning
for the
queryrequest parameterlimit, the min was set to1.00 - info
added the non-success response with the status
- warning