Retrieve Inventory Sets
This endpoint provides Part price breakdown for the requested quantity at the requested location based on the Advanced Inventory Valuation method. This endpoint should not be used if the account is using standard Static Pricing.
The adjustment_quantity
query param represents the quantity you would like
to use from a location. The returned array represents the various price
breakdown (Inventory Sets). The result is sorted based on the Advanced
Inventory Valuation method set for your account. For FIFO accounts,
the oldest Inventory Set will be the first item in the array. For LIFO
accounts, the newest Inventory Set will be the first item in the array.
Each item in the array will have the following properties:
unit_cost
leftover_quantity
added_at
The added_at
value represents the date at which the inventory was added to
the location.
If the very last element in the returned array has a leftover_quantity
value that is negative, then that means the requested quantity is not
available at the given location.
Path Parameters
- id string required
Possible values: Value must match regular expression
^[0-9]+$
The id of the relevant record
Query Parameters
- adjustment_quantity integer
Requested quantity from location
- 200
- 401
- 403
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
array
- id integer
Possible values:
>= 1
- part object
- part_id integer
The Fleetio ID for the
Part
associated with this Inventory Set. - part_location_detail_id integer
Possible values:
>= 1
- part_location_detail object
- added_at date-time
The date and time at which this Inventory Set was added.
- available_quantity float
The number of
Parts
available for use in this Inventory Set. - leftover_quantity float
The number of
Parts
which have not been used in this Inventory Set. - original_quantity float
The number of
Parts
which were originally added to this Inventory Set. - purchase_order_number integer
The number of the
Purchase Order
which was used to purchase this Inventory Set. - unit_cost_cents float
The cost of each
Part
in this Inventory Set in cents. - used_quantity float
The number of
Parts
which have been used in this Inventory Set. - 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.
[
{
"id": 0,
"part": {},
"part_id": 0,
"part_location_detail_id": 0,
"part_location_detail": {},
"added_at": "2023-03-14T13:46:27-06:00",
"available_quantity": 0,
"leftover_quantity": 0,
"original_quantity": 0,
"purchase_order_number": 0,
"unit_cost_cents": 0,
"used_quantity": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00"
}
]
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"
}
Insufficient permission to perform this operation
- 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"
}
The requested resource could not be located
- 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"
}