Retrieve Part

GET 
https://secure.fleetio.com/api/v1/parts/:id

Retrieve the details of an existing Part.

Request

Path Parameters

id stringrequired

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

The id of the relevant record

Responses

200

OK

application/json

Schema

Schema

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

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

Example: 2023-03-14T13:46:27-06:00

descriptionstringnullablerequired

A description of this Part.

manufacturer_part_numberstringnullablerequired

The part number from this Part's manufacturer.

measurement_unit_idNullableId (integer)nullablerequired

Possible values: >= 1

numberstringrequired

The part number being used for this Part within Fleetio.

part_category_idNullableId (integer)nullablerequired

Possible values: >= 1

part_manufacturer_idNullableId (integer)nullablerequired

Possible values: >= 1

upcstringnullablerequired

The Universal Product Code for this Part.

total_quantityfloatrequired

The total quantity on hand for this Part.

Possible values: >= 0

custom_fieldsobjectnullablerequired

*Full details on working with Custom Fields here.

inventory_itembooleanrequired

Indicates whether or not this Part is an inventory item.

part_category objectnullable

idId (integer)

Possible values: >= 1

tire_categoryboolean

Indicates whether part is a tire or not

part_category_namestringnullablerequired

The name of the part category associated with this Part.

part_manufacturer_namestringnullablerequired

The name of the Part's manufacturer.

measurement_unit_namestringnullablerequired

The measurement unit used by this Part.

unit_costfloatnullablerequired

The unit cost for this Part.

average_unit_costfloatnullable

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

part_locations object[]required

Array [

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

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

Example: 2023-03-14T13:46:27-06:00

activeboolean

Whether this Part Location is active.

aislestringnullable

The aisle in which the Part is located.

available_quantityfloat

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

binstringnullable

The bin in which the Part is located.

inventory_sets_countinteger

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

has_been_used_in_work_ordersbooleannullable

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

namestring

Alias of part_location_name.

part_location_namestring

The name of the Part Location for this Part.

part_location_idinteger

The ID of the Part Location for this Part.

quantity_allocated_to_work_ordersfloatnullable

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

quantity_on_orderfloatnullable

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

reorder_pointfloat

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

reorder_point_enabledboolean

Whether this Part will be reordered at the reorder point.

rowstringnullable

The row in which the Part is located.

track_inventoryboolean

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

available_quantity_updated_atdate-timenullable

Example: 2023-03-14T13:46:27-06:00

part_location_archived_atdate-timenullable

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

]

default_image_urlstringnullablerequired

default_image_url_mediumstringnullablerequired

default_image_url_smallstringnullablerequired

default_image_url_largestringnullablerequired

archived_atdate-timenullablerequired

The date and time at which this Part was archived.

Example: 2023-03-14T13:46:27-06:00

attachment_permissions objectnullablerequired

read_photosboolean

Indicates whether the user has read permission for photos.

manage_photosboolean

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

read_documentsboolean

Indicates whether the user has read permission for documents.

manage_documentsboolean

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

has_active_inventory_setsboolean

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

tire_config object

aspect_ratiofloat

Aspect ratio of tire.

rim_diameterfloat

Rim diameter of tire.

load_indexfloat

Load index of tire.

metric_typestring

Metric type of tire.

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

widthfloat

Width of tire.

constructionstring

Construction type of tire.

Possible values: [B, R, D]

speed_ratingstring

Speed rating of tire.

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]

factory_tread_depthfloat

factory_tread_depth support is currently in private beta.

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

minimum_tread_depthfloat

minimum_tread_depth support is currently in private beta.

The legal minimum tread depth, in /32".

life_expectancyinteger

life_expectancy support is currently in private beta.

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.

comments object[]required

A list of the comments made on this record.

Array [

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

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

Example: 2023-03-14T13:46:27-06:00

commentable_typeCommentableType (string)required

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

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

commentable_idId (integer)required

Possible values: >= 1

user_idId (integer)required

Possible values: >= 1

titlestringdeprecated

The title of the Comment.

commentstringrequired

The content of the Comment message body.

user_full_namestringrequired

The full name of the User who created the Comment.

user_image_urlstringnullablerequired

The image url for the User who created the Comment.

rich_contentobjectnullablerequired

html_contentstringnullablerequired

The comment message body rendered as HTML.

with_mentionsbooleanrequired

Indicates if the message body contains @mentions.

]

comments_countintegerrequired

The number of comments made on this record.

Possible values: >= 0

documents object[]required

A list of the documents attached to this record.

Array [

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

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

Example: 2023-03-14T13:46:27-06:00

namestringrequired

The name of the document.

descriptionstringrequired

The description of the document.

documentable_idId (integer)required

Possible values: >= 1

documentable_typeDocumentableType (string)required

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

file_namestringrequired

The name of the file.

file_mime_typestringrequired

The MIME type of the file.

file_sizenumberrequired

The size of the file in bytes.

file_urlstringrequired

The URL to access the file.

full_file_urlstringrequired

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

]

documents_countintegerrequired

The number of documents attached to this record.

Possible values: >= 0

images object[]required

A list of the images attached to this record.

Array [

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

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

Example: 2023-03-14T13:46:27-06:00

imageable_idId (integer)

Possible values: >= 1

imageable_typeImageableType (string)

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

file_namestring

The name of the image file.

file_mime_typeImage MIME Type (string)

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_sizenumber

The size of the image file in bytes.

file_urlstring

The URL to access the image file.

full_urlstring

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

]

images_countintegerrequired

The number of images attached to this record.

Possible values: >= 0

Example (auto)

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "description": "string",
  "manufacturer_part_number": "string",
  "measurement_unit_id": 0,
  "number": "string",
  "part_category_id": 0,
  "part_manufacturer_id": 0,
  "upc": "string",
  "total_quantity": 0,
  "custom_fields": {},
  "inventory_item": true,
  "part_category": {
    "id": 0,
    "tire_category": true
  },
  "part_category_name": "string",
  "part_manufacturer_name": "string",
  "measurement_unit_name": "string",
  "unit_cost": 0,
  "average_unit_cost": 0,
  "part_locations": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "active": true,
      "aisle": "string",
      "available_quantity": 0,
      "bin": "string",
      "inventory_sets_count": 0,
      "has_been_used_in_work_orders": true,
      "name": "string",
      "part_location_name": "string",
      "part_location_id": 0,
      "quantity_allocated_to_work_orders": 0,
      "quantity_on_order": 0,
      "reorder_point": 0,
      "reorder_point_enabled": true,
      "row": "string",
      "track_inventory": true,
      "available_quantity_updated_at": "2023-03-14T13:46:27-06:00",
      "part_location_archived_at": "2024-07-29T15:51:28.071Z"
    }
  ],
  "default_image_url": "string",
  "default_image_url_medium": "string",
  "default_image_url_small": "string",
  "default_image_url_large": "string",
  "archived_at": "2023-03-14T13:46:27-06:00",
  "attachment_permissions": {
    "read_photos": true,
    "manage_photos": true,
    "read_documents": true,
    "manage_documents": true
  },
  "has_active_inventory_sets": true,
  "tire_config": {
    "aspect_ratio": 0,
    "rim_diameter": 0,
    "load_index": 0,
    "metric_type": "EU",
    "width": 0,
    "construction": "B",
    "speed_rating": "A1",
    "factory_tread_depth": 0,
    "minimum_tread_depth": 0,
    "life_expectancy": 0
  },
  "comments": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "commentable_type": "Contact",
      "commentable_id": 0,
      "user_id": 0,
      "comment": "string",
      "user_full_name": "string",
      "user_image_url": "string",
      "rich_content": {},
      "html_content": "string",
      "with_mentions": true
    }
  ],
  "comments_count": 0,
  "documents": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "name": "string",
      "description": "string",
      "documentable_id": 0,
      "documentable_type": "ServiceEntry",
      "file_name": "string",
      "file_mime_type": "string",
      "file_size": 0,
      "file_url": "string",
      "full_file_url": "string"
    }
  ],
  "documents_count": 0,
  "images": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "imageable_id": 0,
      "imageable_type": "ExpenseEntry",
      "file_name": "string",
      "file_mime_type": "image/jpeg",
      "file_size": 0,
      "file_url": "string",
      "full_url": "string"
    }
  ],
  "images_count": 0
}

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

403

Insufficient permission to perform this operation

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

404

The requested resource could not be located

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

curl -L 'https://secure.fleetio.com/api/v1/parts/:id' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
-H 'Account-Token: <Authorization>'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!