This endpoint allows you to retrieve all customer shopping carts from your Venddor store.
https://your-store-url.com/api
This request returns details of up to 10 customer shopping carts. You can use pagination parameters to retrieve more results if needed.
{
"carts": [
{
"cart_id": "123456",
"user_id": "42",
"ip_address": "192.168.1.100",
"company_id": "1",
"items_count": 3,
"total": "149.97",
"subtotal": "139.97",
"shipping_cost": "10.00",
"timestamp": "1712345678",
"firstname": "John",
"lastname": "Doe",
"email": "john.doe@example.com",
"status": "O"
},
{
"cart_id": "123457",
"user_id": "0",
"ip_address": "192.168.1.101",
"company_id": "1",
"items_count": 1,
"total": "29.99",
"subtotal": "29.99",
"shipping_cost": "0.00",
"timestamp": "1712345879",
"firstname": "",
"lastname": "",
"email": "",
"status": "O"
}
],
"params": {
"page": 1,
"items_per_page": 10,
"total_items": 2
}
}
| Field | Type | Description |
|---|---|---|
carts |
array | Array of cart objects |
cart_id |
string | Unique identifier of the cart |
user_id |
string | ID of the user who owns the cart. 0 for guest carts |
ip_address |
string | IP address of the customer |
company_id |
string | ID of the company (vendor) associated with the cart |
items_count |
integer | Number of items in the cart |
total |
string | Total cart amount including shipping |
subtotal |
string | Cart amount before shipping and taxes |
shipping_cost |
string | Cost of shipping |
timestamp |
string | Unix timestamp when the cart was created/updated |
firstname |
string | Customer's first name (if provided) |
lastname |
string | Customer's last name (if provided) |
email |
string | Customer's email address (if provided) |
status |
string |
Cart status:O — open (active)C — completed (converted to order)A — abandoned
|
The API returns basic pagination information in the params object:
| Field | Type | Description |
|---|---|---|
page |
integer | Current page number |
items_per_page |
integer | Number of items displayed per page |
total_items |
integer | Total number of carts matching the filter criteria |
GET /api/carts/{cart_id} endpoint.