FLfleetio
Parts

Retrieve Part

Retrieve the details of an existing Part.

get/parts/{id}

Request

Path parameters

idstring required

The id of the relevant record

Query parameters

with_cross_reference_member_locationsboolean

Whether each entry in cross_reference_members carries its per-Part-Location stock in part_location_details, and whether the list is narrowed to the members holding stock. Omitting this parameter returns the same body as passing false.

part_location_id[]integer[]

Which Part Locations to read, when with_cross_reference_member_locations is true. A member is returned only if it holds stock at one of these Part Locations, and it carries those Part Locations alone in part_location_details. Omit to read every Part Location the current API credentials can see. Repeat the parameter for more than one - part_location_id[]=1&part_location_id[]=2 - or pass a single id without the brackets. Values that are not positive integers are ignored, so a comma-separated list reads as no filter at all rather than as several Part Locations.

Response

OK

idinteger required
created_atstring date-time

The date and time at which this record was created.

updated_atstring date-time

The date and time at which this record was most recently updated.

descriptionstring nullable required

A description of this Part.

manufacturer_part_numberstring nullable required

The part number from this Part's manufacturer.

measurement_unit_idinteger nullable required
numberstring required

The part number being used for this Part within Fleetio.

part_category_idinteger nullable required
part_manufacturer_idinteger nullable required
upcstring nullable required

The Universal Product Code for this Part.

total_quantitynumber float required

The total quantity on hand for this Part.

custom_fieldsCustomFields nullable required

*Full details on working with Custom Fields here.

inventory_itemboolean required

Indicates whether or not this Part is an inventory item.

part_category_namestring nullable required

The name of the part category associated with this Part.

part_manufacturer_namestring nullable required

The name of the Part's manufacturer.

measurement_unit_namestring nullable required

The measurement unit used by this Part.

unit_costnumber float nullable required

The unit cost for this Part.

average_unit_costnumber float nullable

The average unit cost for this Part. FIFO/LIFO accounts only.

default_image_urlstring nullable required
default_image_url_mediumstring nullable required
default_image_url_smallstring nullable required
default_image_url_largestring nullable required
archived_atstring date-time nullable required

The date and time at which this Part was archived.

has_active_inventory_setsboolean

Indicates whether this Part has any active Inventory Sets. FIFO/LIFO accounts only.

cross_reference_group_idinteger nullable

The cross-reference group this Part belongs to, or null when it belongs to none. Unlike cross_reference_members this is present on index and archived responses as well, so a list can be read for which Parts have compatible Parts without a request per Part -- and two Parts sharing a value are compatible with each other. Only present when the cross-references feature is enabled for the account.

comments_countinteger required

The number of comments made on this record.

documents_countinteger required

The number of documents attached to this record.

images_countinteger required

The number of images attached to this record.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "part_locations": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "available_quantity_updated_at": "2023-03-14T13:46:27-06:00"
    }
  ],
  "archived_at": "2023-03-14T13:46:27-06:00",
  "comments": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00"
    }
  ],
  "documents": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00"
    }
  ],
  "images": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00"
    }
  ]
}

Changes

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