Retrieve Inventory Sets

GET 
https://secure.fleetio.com/api/v3/part_location_details/:id/inventory_sets

info

Read more about 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.

caution

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.

Request

Path Parameters

id stringrequired

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

The id of the relevant record

Query Parameters

adjustment_quantity integer

Requested quantity from location

Responses

200

OK

application/json

Schema

Schema

Array [
idId (integer)
Possible values: >= 1
partobject
part_idintegerrequired
The Fleetio ID for the Part associated with this Inventory Set.
part_location_detail_idId (integer)
Possible values: >= 1
part_location_detailobject
added_atdate-timerequired
The date and time at which this Inventory Set was added.
Example: 2023-03-14T13:46:27-06:00
available_quantityfloatrequired
The number of Parts available for use in this Inventory Set.
leftover_quantityfloatnullablerequired
The number of Parts which have not been used in this Inventory Set.
original_quantityfloatrequired
The number of Parts which were originally added to this Inventory Set.
purchase_order_numberintegernullablerequired
The number of the Purchase Order which was used to purchase this Inventory Set.
unit_cost_centsfloatrequired
The cost of each Part in this Inventory Set in cents.
used_quantityfloatnullablerequired
The number of Parts which have been used in this Inventory Set.
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
]

Example (auto)

[
  {
    "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"
  }
]

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/v3/part_location_details/:id/inventory_sets' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

id — pathrequired

adjustment_quantity — query

ResponseClear

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