Skip to content

List carts

GET
/carts
curl --request GET \
--url 'https://api.fleet.co/platform/v1/carts?limit=50&offset=0&purchaser_id=12' \
--header 'Authorization: Bearer <token>'
limit

Page size (max 100)

integer
default: 50 >= 1 <= 100

Example

50
offset

Number of items to skip

integer
0

Example

0
purchaser_id

Filter carts by purchaser user id

integer

Example

12

Paginated carts

Media typeapplication/json
object
data
required
Array<object>
object
id
required
integer
purchaser_id
required
integer
nullable
num_devices
required
integer
nullable
rent
required
string
nullable
currency
required
string
nullable
devices
required
Array<object>
object
id
required
integer
name
required
string
nullable
rent
required
string
nullable
product_id
required

Catalog product id when the line is tied to a catalog product

integer
nullable
meta
required
object
total
required

Total items matching filters (before paging)

integer
limit
required

Page size used for this response

integer
offset
required

Offset used for this response

integer

Example

{
"data": [
{
"devices": [
{
"product_id": 101
}
]
}
],
"meta": {
"total": 42,
"limit": 50,
"offset": 0
}
}

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

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"
}