Carts
(ms.carts)
Cart commands.
Fields
| Name | Description |
|---|---|
| items Type: array | Array of items in the cart. |
| billing_address Type: object | Billing address of the user. |
| shipping_address Type: object | Shipping address of the user. |
| user_id Type: string | ID of the user to which cart belongs. |
| email_id Type: string | Email address of the user to which cart belongs. |
| item_count Type: number | Represents number of items in the cart. |
| sub_total Type: number | Sub total is the sum of each item's total. |
| total Type: number | Total amount of the cart. |
| discounts Type: array | List of discounts applied on the cart. |
| discount_total Type: number | Total amount of discounts applied on the cart. |
| taxes_total Type: number | Total amount of taxes applied on the cart. |
| shipping_total Type: number | Total amount of shipping charges applied on the cart. |
| ecoupon Type: object | Represent information of coupon code applied on the cart. |
| total_weight Type: number | Total weight of the items in the cart. |
| options Type: object | Cart options are fetched through order_options form. This field comprises of key-value pair of those options. |
| payment_method Type: object | Selected payment method of the cart. |
| shipping_method Type: object | Shipping method applied to the cart. |
| currency Type: object | Represents information like name, conversion rate and symbol of currency used in the cart. |
| additional_charges Type: array | List of additional charges applied to the cart. |
| shipping_by_vendor Type: object | Represents shipping total of each seller. |
| taxes Type: array | List of taxes applied to the cart. |
| available_payment_methods Type: array | List of available payment methods. |
| available_options Type: array | List of available options in the store. Fetched through order_options form. |
| available_wallets Type: array | List of available wallets for the user to which cart belongs. |
| currency_code Type: string | Code of the selected currency in the cart. |
| valid_email_id Type: string | The flag represents whether the email_id in the cart is valid. |
| valid_shipping_address Type: string | Represents whether the shipping address of the cart is valid. |
| valid_billing_address Type: string | Represents whether the billing address of the cart is valid. |
| valid_shipping_method Type: string | Represents whether the shipping method of the cart is valid. |
| valid_payment_method Type: string | Represents whether the selected payment method of the cart is valid. |
Commands
| Name | Routes |
|---|---|
| add | post /api/1/entity/ms.carts TRY IT ! |
| edit | put /api/1/entity/ms.carts/{_id} TRY IT ! |
| list | get /api/1/entity/ms.carts TRY IT ! |
| get | get /api/1/entity/ms.carts/{_id} TRY IT ! |
| delete | delete /api/1/entity/ms.carts/{_id} TRY IT ! |
Carts
(ms.carts)
Cart commands.
Fields
| Name | Description |
|---|---|
| items Type: array | Array of items in the cart. |
| billing_address Type: object | Billing address of the user. |
| shipping_address Type: object | Shipping address of the user. |
| user_id Type: string | ID of the user to which cart belongs. |
| email_id Type: string | Email address of the user to which cart belongs. |
| item_count Type: number | Represents number of items in the cart. |
| sub_total Type: number | Sub total is the sum of each item's total. |
| total Type: number | Total amount of the cart. |
| discounts Type: array | List of discounts applied on the cart. |
| discount_total Type: number | Total amount of discounts applied on the cart. |
| taxes_total Type: number | Total amount of taxes applied on the cart. |
| shipping_total Type: number | Total amount of shipping charges applied on the cart. |
| ecoupon Type: object | Represent information of coupon code applied on the cart. |
| total_weight Type: number | Total weight of the items in the cart. |
| options Type: object | Cart options are fetched through order_options form. This field comprises of key-value pair of those options. |
| payment_method Type: object | Selected payment method of the cart. |
| shipping_method Type: object | Shipping method applied to the cart. |
| currency Type: object | Represents information like name, conversion rate and symbol of currency used in the cart. |
| additional_charges Type: array | List of additional charges applied to the cart. |
| shipping_by_vendor Type: object | Represents shipping total of each seller. |
| taxes Type: array | List of taxes applied to the cart. |
| available_payment_methods Type: array | List of available payment methods. |
| available_options Type: array | List of available options in the store. Fetched through order_options form. |
| available_wallets Type: array | List of available wallets for the user to which cart belongs. |
| currency_code Type: string | Code of the selected currency in the cart. |
| valid_email_id Type: string | The flag represents whether the email_id in the cart is valid. |
| valid_shipping_address Type: string | Represents whether the shipping address of the cart is valid. |
| valid_billing_address Type: string | Represents whether the billing address of the cart is valid. |
| valid_shipping_method Type: string | Represents whether the shipping method of the cart is valid. |
| valid_payment_method Type: string | Represents whether the selected payment method of the cart is valid. |
Commands
| Name | Routes |
|---|---|
| add | post /api/1/entity/ms.carts TRY IT ! |
| edit | put /api/1/entity/ms.carts/{_id} TRY IT ! |
| list | get /api/1/entity/ms.carts TRY IT ! |
| get | get /api/1/entity/ms.carts/{_id} TRY IT ! |
| delete | delete /api/1/entity/ms.carts/{_id} TRY IT ! |