List Archived Parts
List archived Parts
Query Parameters
- start_cursor string
The start cursor for Keyset pagination.
- per_page integer
Possible values:
>= 2
and<= 100
Default value:
50
The number of records per page to return.
- filter object
The fields, operations, and values to filter the records by.
manufacturer_part_number object
oneOf- MOD1
- MOD2
like string requiredeq string requirednumber object
oneOf- MOD1
- MOD2
like string requiredeq string requiredupc object
eq string requiredpart_category_id object
eq string requiredpart_manufacturer_id object
eq string required
- 200
- 400
- 401
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- start_cursor string
The current start cursor of the records returned.
- next_cursor string
The next cursor to retrieve the next page of records.
- per_page integer
The maxumum number of records returned.
- estimated_remaining_count integer
The number of remaining records including the returned records, up to a maximum of 500.
filtered_by object[]
The filters applied to the returned record set.
anyOf- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
manufacturer_part_number object
oneOf- MOD1
- MOD2
like stringeq stringnumber object
oneOf- MOD1
- MOD2
like stringeq stringupc object
eq stringpart_category_id object
eq stringpart_manufacturer_id object
eq stringsorted_by object[]
The sorts applied to the returned record set.
anyOf- MOD1
- MOD2
archived_at stringPossible values: [
asc
,desc
]id stringPossible values: [
asc
,desc
]records object[]
id integerdescription stringA description of this Part.
manufacturer_part_number stringThe part number from this Part's manufacturer.
measurement_unit_id integerThe id of the Measurement Unit associated with this Part.
number stringThe part number being used for this Part within Fleetio.
part_category_id integerThe id of the Part Category associated with this Part.
part_manufacturer_id integerThe id of the Part Manufacturer associated with this Part.
upc stringThe Universal Product Code for this Part.
unit_cost_cents integerThe unit cost in cents for this Part.
average_unit_cost_cents stringThe average unit cost in cents for this Part. FIFO/LIFO accounts only.
default_image_url stringarchived_at date-timeThe date and time at which this Part was archived.
attachment_permissions object
read_photos booleanIndicates whether the user has read permission for photos.
manage_photos booleanIndicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents booleanIndicates whether the user has read permission for documents.
manage_documents booleanIndicates whether the user has permission to manage (eg. upload, delete) documents.
custom_fields object*Full details on working with Custom Fields here.
part_manufacturer object
id integername stringThe name of the Part Manufacturer.
description stringcreated_at date-timeThe date and time at which this Part Manufacturer was created.
updated_at date-timeThe date and time at which this Part Manufacturer was last updated.
part_category object
id integerPossible values:
>= 1
tire_category booleanIndicates whether part is a tire or not
{
"start_cursor": "string",
"next_cursor": "string",
"per_page": 0,
"estimated_remaining_count": 0,
"filtered_by": [
{
"manufacturer_part_number": {
"like": "string"
}
},
{
"number": {
"like": "string"
}
},
{
"upc": {
"eq": "string"
}
},
{
"part_category_id": {
"eq": "string"
}
},
{
"part_manufacturer_id": {
"eq": "string"
}
}
],
"sorted_by": [
{
"archived_at": "asc"
},
{
"id": "asc"
}
],
"records": [
{
"id": 0,
"description": "string",
"manufacturer_part_number": "string",
"measurement_unit_id": 0,
"number": "string",
"part_category_id": 0,
"part_manufacturer_id": 0,
"upc": "string",
"unit_cost_cents": 0,
"average_unit_cost_cents": "string",
"default_image_url": "string",
"archived_at": "2023-03-14T13:46:27-06:00",
"attachment_permissions": {
"read_photos": true,
"manage_photos": true,
"read_documents": true,
"manage_documents": true
},
"custom_fields": {},
"part_manufacturer": {
"id": 0,
"name": "string",
"description": "string",
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00"
},
"part_category": {
"id": 0,
"tire_category": true
}
}
]
}
The format or parameters of the request was invalid
- application/json
- Schema
- Example (from schema)
Schema
errors object
typeitems string
{
"errors": {}
}
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}