Skip to content

Get one storage stay

GET
/storage-stays/{storage_stay_id}
curl --request GET \
--url https://api.fleet.co/platform/v1/storage-stays/42 \
--header 'Authorization: Bearer <token>'
storage_stay_id
required

Storage stay id

string
/^[1-9]\d*$/

Example

42

Storage stay

Media typeapplication/json
object
data
required

Current storage stay (ACTIVE or ENDING); past stays are listed by GET /storage-stays?device_id=

object
id
required
integer
device_id
required
integer
status
required

ACTIVE: stored at Fleet. ENDING: on its way back. ENDED: delivered back. CANCELLED: never stored.

string
Allowed values: ACTIVE ENDING ENDED CANCELLED
country_code
required

Country of the Fleet storage (ISO alpha-2)

string
nullable
factory_reset
required

Whether the device was factory reset on intake

boolean
nullable
quality
required

Condition graded on intake

string
nullable
inbound_parcel_id
required

Shipment to the storage; listed in the device parcels

integer
nullable
outbound_parcel_id
required

Shipment out of the storage; listed in the device parcels

integer
nullable
started_at
required
string
nullable
ended_at
required
string
nullable
created_at
required
string
nullable
updated_at
required
string
nullable

Example

{
"data": {
"status": "ACTIVE"
}
}

Validation error

Media typeapplication/json
object
message
required

Every validation failure, comma-separated

string
type
required
string
Allowed values: validation_error
error
required
string
Allowed values: validation_error

Example

{
"message": "Required, must be an ISO 3166-1 alpha-2 country code",
"type": "validation_error",
"error": "validation_error"
}

Missing, invalid, or revoked API key

Media typetext/plain
string

Example

Unauthorized

Storage stay not found

Media typeapplication/json
object
error
required
string
Allowed values: STORAGE_STAY_NOT_FOUND

Example

{
"error": "STORAGE_STAY_NOT_FOUND"
}

Rate limit exceeded. The RateLimit-* headers give the limit and the reset time.

Media typetext/plain
string

Example

Too many requests, please try again later.

Unexpected server error

Media typeapplication/json
object
error
required
string
Allowed values: INTERNAL_ERROR

Example

{
"error": "INTERNAL_ERROR"
}

Rate limiting is temporarily unavailable; retry with backoff

Media typeapplication/json
object
message
required
string

Example generated

{
"message": "example"
}