Cart Service
Ecommerce Cart service, part of the microbase ecosystem.
Features
- Single or bulk add to Cart
- Stock checking available per product
- Define max number of items items in Cart
- Define max number of items per Product in Cart
- Aggregate same products or add them as a single line each
- Abandonment handling
Entities
Cart
| Field |
Description |
Type |
Required |
Default |
| id |
Internal unique Cart identifier |
String |
yes |
System generated |
| userId |
Owner User identifier |
String |
yes |
- |
| expirationTime |
Cart expiration time |
Date |
yes |
Configurable |
| items |
List of Products added to the Cart |
Object list |
yes |
- |
| taxes |
The calculated Taxes for the Cart |
Object |
yes |
- |
Taxes
| Field |
Description |
Type |
Required |
Default |
| ok |
Flag describing the tax calculus result |
Boolean |
yes |
- |
| tax |
Cart taxes ammount |
Object |
yes |
- |
| beforeTax |
Cart total before taxes |
Object |
yes |
- |
Items
| Field |
Description |
Type |
Required |
Default |
| id |
Internal unique item identifier |
String |
yes |
System generated |
| productId |
The Product identifier |
String |
yes |
- |
| title |
A Product description |
String |
yes |
Product title + Variant details |
| quantity |
The Product quantity |
Number |
yes |
- |
| price |
The single item sale price |
Money |
yes |
- |
| taxes |
The calculated Taxes for the item |
Object |
yes |
- |
| discounts |
Promotions results data |
Object list |
yes |
- |
| reserves |
Reservation data |
Object list |
yes |
- |
Price
| Argument |
Required |
Type |
Example |
Description |
| amount |
yes |
Numeric |
10999 |
The Product base price |
| currency |
yes |
String |
USD |
The currency code (ISO 4217) |
| precision |
yes |
Numeric |
2 |
Currency dependant precision (USD=2, JPY=0, JOD=3) |
Taxes
| Field |
Description |
Type |
Required |
Default |
| tax |
Item taxes amount |
Money |
yes |
- |
| beforeTax |
Item total before taxes |
Money |
yes |
- |
| taxDetail |
Item taxes detail |
String |
yes |
- |
Reserves
| Field |
Description |
Type |
Required |
Default |
| id |
Internal unique Reserve identifier |
String |
yes |
System generated |
| warehouseId |
The Warehouse identifier |
String |
yes |
- |
| quantity |
The quantity reserved |
Number |
yes |
- |
| expirationTime |
Reserve expiration time |
Date |
yes |
System generated |
API
The full API documentation can be accessed in the microbase web http://docs.microbase.io
See also
cartChains
