Skip to main content

Retrieve Part

Retrieve the details of an existing Part.

Path Parameters

  • id string required

    Possible values: Value must match regular expression ^[0-9]+$

    The id of the relevant record

Responses

OK

Schema

  • id integer

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

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

  • description string

    A description of this Part.

  • manufacturer_part_number string

    The part number from this Part's manufacturer.

  • measurement_unit_id NullableId

    Possible values: >= 1

  • number string

    The part number being used for this Part within Fleetio.

  • part_category_id NullableId

    Possible values: >= 1

  • part_manufacturer_id NullableId

    Possible values: >= 1

  • upc string

    The Universal Product Code for this Part.

  • total_quantity float

    The total quantity on hand for this Part.

  • custom_fields object

    *Full details on working with Custom Fields here.

  • inventory_item boolean

    Indicates whether or not this Part is an inventory item.

  • part_category object
  • id integer

    Possible values: >= 1

  • tire_category boolean

    Indicates whether part is a tire or not

  • part_category_name string

    The name of the part category associated with this Part.

  • part_manufacturer_name string

    The name of the Part's manufacturer.

  • measurement_unit_name string

    The measurement unit used by this Part.

  • unit_cost float

    The unit cost for this Part.

  • average_unit_cost float

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

  • part_locations object[]
  • id integer

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

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

  • active boolean

    Whether this Part Location is active.

  • aisle string

    The aisle in which the Part is located.

  • available_quantity float

    How many of this Part are available at this Part Location.

  • bin string

    The bin in which the Part is located.

  • inventory_sets_count integer

    The number of Inventory Sets that this Part is included in. FIFO/LIFO accounts only.

  • has_been_used_in_work_orders boolean

    Whether this Part has been used in any Work Orders. FIFO/LIFO accounts only.

  • name string

    Alias of part_location_name.

  • part_location_name string

    The name of the Part Location for this Part.

  • part_location_id integer

    The ID of the Part Location for this Part.

  • quantity_allocated_to_work_orders float

    How many of these Parts are currently allocated to Work Orders.

  • quantity_on_order float

    How many of this Part are currently on order, if any.

  • reorder_point float

    The lower-threshold quantity at which this Part should be reordered.

  • reorder_point_enabled boolean

    Whether this Part will be reordered at the reorder point.

  • row string

    The row in which the Part is located.

  • track_inventory boolean

    Indicates whether inventory is tracked for this Part at this location.

  • available_quantity_updated_at date-time
  • part_location_archived_at date-time

    The date and time at which the Part Location was archived, if applicable.

  • default_image_url string
  • default_image_url_medium string
  • default_image_url_small string
  • default_image_url_large string
  • archived_at date-time

    The date and time at which this Part was archived.

  • attachment_permissions object
  • read_photos boolean

    Indicates whether the user has read permission for photos.

  • manage_photos boolean

    Indicates whether the user has permission to manage (eg. upload, delete) photos.

  • read_documents boolean

    Indicates whether the user has read permission for documents.

  • manage_documents boolean

    Indicates whether the user has permission to manage (eg. upload, delete) documents.

  • has_active_inventory_sets boolean

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

  • tire_config object
  • aspect_ratio float

    Aspect ratio of tire.

  • rim_diameter float

    Rim diameter of tire.

  • load_index float

    Load index of tire.

  • metric_type string

    Possible values: [EU, P, HL, T, LT, C, ST]

    Metric type of tire.

  • width float

    Width of tire.

  • construction string

    Possible values: [B, R, D]

    Construction type of tire.

  • speed_rating string

    Possible values: [A1, A2, A3, A4, A5, A6, A7, A8, B, C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V, W, Y]

    Speed rating of tire.

  • factory_tread_depth float

    Tread depth of tire in /32" when new, as specified by the manufacturer.

    :::info factory_tread_depth support is currently in private beta. :::

  • minimum_tread_depth float

    The legal minimum tread depth, in /32".

    :::info minimum_tread_depth support is currently in private beta. :::

  • life_expectancy int32

    The Life Expectancy or “Warranty” of a tire is the expected meter range, usually measured in miles, of a given tire as specified by the manufacturer.

    :::info life_expectancy support is currently in private beta. :::

  • comments object[]

    A list of the comments made on this record.

  • id integer

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

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

  • commentable_type CommentableType

    Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]

    The type of record that the Comment will be left on. Must be associated with a matching commentable_id.

  • commentable_id integer

    Possible values: >= 1

  • user_id integer

    Possible values: >= 1

  • title string deprecated

    The title of the Comment.

  • comment string

    The content of the Comment message body.

  • user_full_name string

    The full name of the User who created the Comment.

  • user_image_url string

    The image url for the User who created the Comment.

  • rich_content object
  • html_content string

    The comment message body rendered as HTML.

  • with_mentions boolean

    Indicates if the message body contains @mentions.

  • comments_count integer

    The number of comments made on this record.

  • documents object[]

    A list of the documents attached to this record.

  • id integer

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

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

  • documentable_id integer

    Possible values: >= 1

  • documentable_type DocumentableType

    Possible values: [ServiceEntry, FuelEntry, Issue, WorkOrder, ExpenseEntry]

  • file_name string

    The name of the file.

  • file_mime_type string

    The MIME type of the file.

  • file_size number

    The size of the file in bytes.

  • file_url string

    The URL to access the file.

  • full_file_url string

    The full URL to access the file, including any necessary authentication or parameters.

  • documents_count integer

    The number of documents attached to this record.

  • images object[]

    A list of the images attached to this record.

  • id integer

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

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

  • imageable_id integer

    Possible values: >= 1

  • imageable_type ImageableType

    Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]

  • file_name string

    The name of the image file.

  • file_mime_type Image MIME Type

    Possible values: [image/jpeg, image/gif, image/jif, image/jfif, image/jfi, image/tiff, image/png, image/jpg, image/jpe, image/pdf, image/webp, image/tif, image/psd, image/raw, image/arw, image/cr2, image/nrw, image/k25, image/bmp, image/dip, image/ai, image/eps, image/heif, image/heic, image/ind, image/indd, image/indt, image/jp2, image/j2k, image/jpf, image/jpx, image/jpm, image/mj2, image/x-png]

  • file_size number

    The size of the image file in bytes.

  • file_url string

    The URL to access the image file.

  • full_url string

    The full URL to access the image file, including any necessary authentication or parameters.

  • images_count integer

    The number of images attached to this record.

Loading...