Carts API
v1.0 • REST • JSON
Full CRUD management for cart accounts. Create, retrieve, update, and delete cart records with built-in pagination and role-based access control support.
Quick Reference
/api/carts
200 OK
Get All Carts
Retrieves a paginated list of all carts in the system. Use the page
and limit query parameters to navigate large result sets.
The response envelope includes total count and page metadata.
| Parameter | Type | Default | Description |
|---|---|---|---|
page |
integer | 1 |
Page number, 1-based index |
limit |
integer | 10 |
Number of records per page |
/api/carts/{id}
200 OK
Get Single Cart
Fetch the full profile for a specific cart using their numeric ID. Returns all cart fields including assigned role names and account metadata.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | Unique cart identifier |
/api/carts/{id}
404 Not Found
Cart Not Found
Returned when the requested cart ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing cart resources.
{}
/api/carts
201 Created
Create Cart
Registers a new cart with the provided details. On success, returns the newly created cart object  including the auto-generated ID, timestamp, and resolved role names.
| Field | Type | Required | Description |
|---|---|---|---|
firstName |
string | Required | Cart's given name |
lastName |
string | Required | Cart's family name |
email |
string | Required | Unique email address |
password |
string | Required | Plaintext password for the account |
roleIds |
integer[] | Optional | IDs of roles to assign on creation |
/api/carts/{id}
200 OK
Update Cart
Fully replaces an existing cart's data with the values in the request body. A successful update returns 200 OK with response body.
| Field | Type | Required | Description |
|---|---|---|---|
firstName |
string | Required | Updated first name |
lastName |
string | Required | Updated last name |
email |
string | Required | Updated email address |
roleIds |
integer[] | Optional | New role assignment (replaces existing) |
/api/carts/{id}
204 No Content
Delete Cart
Permanently removes a cart from the system by their ID. This action is irreversible  once deleted, the cart record and all associated data cannot be recovered through the API.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | ID of the cart to delete |
{}