| Name | Description |
|---|
_id
Type: string
Read Only
Required | The unique identifier for the orders. This one is used for API purposes.
|
additional_charges
Type: array
Read Only
Required | It is an array of object containing details of additional charges. Example: "additional_charges":[{
"name":" Offline payment Changes",
"type":"payment_charges",
"price" :"50"
}]
|
billing_address
Type: object
| The billing address associated with the payment method. This address is an optional field that will not be available on orders that do not require one. Example: "billing_address": {
"address": "B4-309 Spaze iTech Park, Sector-49, Sohna Road",
"city": "Gurgoan",
"country": "IN",
"full_name": "Testing",
"phone": "1234567890",
"state": "Harayana",
"zip": "122001"
}
billing_address.full_name
Type: string
| The full name of the person associated with the payment method. | billing_address.address
Type: string
Required | The street address of the billing address. | billing_address.city
Type: string
Required | The city of the billing address. | billing_address.state
Type: string
Required | The state of the billing address. | billing_address.country
Type: string
Required | The name of the country of the billing address. | billing_address.zip
Type: string
Required | The zip or postal code of the billing address. | billing_address.phone
Type: number
Required | The phone number at the billing address. |
|
client_details
Type: object
Read Only
| This object contain the detail of client system . These details is gathered for navigator object of javascript . Example: "client_details": {
"platform":"Win",
"browser":"Chrome"
}
|
coupon_code
Type: string
| This contain the code applied by user in order to avial some sort of discount. Example: Get 100
|
currency
Type: object
Read Only
| It is object containing name and conversion_rate of currency Example: "currency":{ "name":"USD", "conversion_rate":"0.14"}
|
currency_code
Type: string
Read Only
| This contain the ISO-3 Currency code of cart. Example: USD
|
currency_rate
Type: string
Read Only
| This contain the conversion rate of the currency of the currency code. Example: 0.14
|
discounts
Type: array
Read Only
| It is an array of object containing details of cart level discounts. Example: "discounts":[{
"_id":"53b256e9b3af14aa15e451a5",
"saving_amount":100,
"coupon_code":"Get 100"
}]
discounts._id
Type: string
| Unique handler for discount applied. | discounts.saving_amount
Type: number
| Amount saved on application of discount on product. | discounts.coupon_code
Type: string
| Name of coupon code applied |
|
ecoupon
Type: object
Read Only
| This is a deprecated object contain the coupon code and discount associated with it. Example: {
"code":"Get 100",
"discount":{
"_id": "5ac383106eecb937c95196f3",
"apply_with": "directly",
"enabled":true,
"name": "Get 100",
"rule_type": "product",
"group": "product",
"type": "percentage", "amount":10,
"conditions":[{
"field": "product.name",
"operator": "equal",
"value":["string"],
"_id": "5ac383106eecb937c95196f4"
}],
"validity": "infinite",
"number_of_uses": 10,
"uses_per_use": 2,
"apply_on": "apply_on_all_products",
"use_count": "2",
"created_on": "2018-04-03T13:35:12.929Z"
}
}
ecoupon.code
Type: string
| Name of coupon code applied. | ecoupon.discount
Type: object
| A discount object which contains all details of discount applied on product. |
|
email
Type: string
| This field contain email id of customer. Example: [email protected]
|
financial_status
Type: string
| This field show the status of payment at various stages. Possible values are :
Pending = This indicate that payment for order is still not pending.
Paid = This indicate that payment for order is made. Example: pending
|
gift_cards
Type: string
| This field is array of object ,will be used for gift cards.
Will be used in future.
|
gift_card_total
Type: string
| This field will contain the total value of applied gift cards.
Will be used in future.
|
items
Type: array
| It is an array of object which stores details of product in cart. Example: "items": [
{
"_id": "5ae8664560f1a2eef3a1ba2d",
"name": "tt",
"product_id": "5ad830764ce249ab654e53d8",
"product_url": "/product/tt",
"metafields": {
"field1": "Test 1",
"Value 3": "3",
"Value 1": "1",
"Value 2": "2"
},
"selected_options": {
"color": "red",
"size": "l"
},
"variant_id": "red|l",
"seller": "5ad0a0779a4cbc2439988840",
"linked_product_id": null,
"price": "7.00",
"list_price": 7,
"discounts_percentage": "0.000",
"discounts_total": "0",
"discounts": [],
"taxes": [],
"taxes_total": 0,
"shipping_cost": 0,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_l",
"thumbnail_url": "ms.products/5ad830764ce249ab654e53d8/images/5ae07bfb2dc51abf07f539fc/5ae07bf52dc51abf07f539f7/5ae07bf52dc51abf07f539f7-100x100.jpg",
"image_url": "ms.products/5ad830764ce249ab654e53d8/images/5ae07bfb2dc51abf07f539fc/5ae07bf52dc51abf07f539f7/5ae07bf52dc51abf07f539f7-1024x1024.jpg",
"product": {
"_id": "5ad830764ce249ab654e53d8",
"_metadata": {
"i18n": {
"EN": {},
"FR": {},
"HI": {},
"MS": {},
"SQ": {}
}
},
"inventory_management": "automatic",
"publish": "1",
"images": [
{
"image": "ms.products/5ad830764ce249ab654e53d8/images/5ae07bfb2dc51abf07f539fc/5ae07bf52dc51abf07f539f7/5ae07bf52dc51abf07f539f7.jpg",
"tempSrc": "https://cdn.storehippo.com/s/58934ba3bc87057a5b6ee2bc/ms.products/5ad830764ce249ab654e53d8/images/5ae07bfb2dc51abf07f539fc/5ae07bf52dc51abf07f539f7/5ae07bf52dc51abf07f539f7-240x240.jpg",
"preview": true,
"_metadata": {
"image": {
"name": "101010.1(1).jpg",
"type": "image/jpeg",
"size": 8394,
"versioning": true,
"_id": "5ae07bf52dc51abf07f539f7"
}
},
"_id": "5ae07bfb2dc51abf07f539fc"
}
],
"collections": [],
"categories": [
"sss"
],
"tax": "default",
"substore": [],
"options": [
{
"name": "Color",
"value": "red"
},
{
"name": "Size",
"value": "l"
}
],
"option_set": "",
"SEO": {},
"media": [],
"attributes": [],
"features": [],
"files": [],
"seller": "5ad0a0779a4cbc2439988840",
"approve": "approved",
"name": "tt",
"alias": "tt",
"price": "7.00",
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_l",
"variants": [
{
"options": [
{
"name": "Color",
"value": "red"
},
{
"name": "Size",
"value": "l"
}
],
"id": 88158,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_l",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 9,
"variant_id": "red|l"
},
{
"options": [
{
"name": "Color",
"value": "red"
},
{
"name": "Size",
"value": "xxl"
}
],
"id": 60097,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_xxl",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 3,
"variant_id": "red|xxl"
},
{
"options": [
{
"name": "Color",
"value": "red"
},
{
"name": "Size",
"value": "m"
}
],
"id": 6494,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_m",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 9,
"variant_id": "red|m"
},
{
"options": [
{
"name": "Color",
"value": "blue"
},
{
"name": "Size",
"value": "xl"
}
],
"id": 41643,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_xl",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 10,
"variant_id": "blue|xl"
},
{
"options": [
{
"name": "Color",
"value": "blue"
},
{
"name": "Size",
"value": "l"
}
],
"id": 54716,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_l",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 10,
"variant_id": "blue|l"
},
{
"options": [
{
"name": "Color",
"value": "blue"
},
{
"name": "Size",
"value": "xxl"
}
],
"id": 42419,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_xxl",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 9,
"variant_id": "blue|xxl"
},
{
"options": [
{
"name": "Color",
"value": "blue"
},
{
"name": "Size",
"value": "m"
}
],
"id": 63317,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_m",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 10,
"variant_id": "blue|m"
},
],
"default_variant": {
"options": [
{
"name": "Color",
"value": "red"
},
{
"name": "Size",
"value": "xl"
}
],
"id": 78916,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 10,
"variant_id": "red|xl"
},
"available": 1,
"weight_updated": true,
"uniquesku": [
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_l",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_xxl",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_m",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_xl",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_l",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_xxl",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_m"
],
"dimension": {},
"sort_order": 0,
"created_on": "2018-04-19T06:00:22.249Z",
"_created_by": "58a588610d25ca094c2fca09",
"updated_on": "2018-05-01T13:01:21.407Z",
"_updated_by": "58a3fba935a5cdff1784e5e2",
"description": "",
"inventory_quantity": 9,
"inventory_management_level": "variant",
"metafields": {
"field1": "Test 1",
"Value 3": "3",
"Value 1": "1",
"Value 2": "2"
},
"id": 88158,
"variant_id": "red|l",
"selected_options": {
"color": "red",
"size": "l",
"Color": "red",
"Size": "l"
},
"list_price": 7,
"our_price": 7,
"original_price": 7,
"compare_price": "7.00",
"discounts_total": 0,
"discounts_percentage": "0.000",
"discount_total": 0
},
"discount_total": "0",
"quantity": 1,
"total": 7,
"fulfilled_quantity": 1,
"less_updated_on": 1525182159124,
"updated_on": "2018-05-01T13:42:39.162Z"
}
]
items._id
Type: string
| The unique numeric identifier for the cart item. | items.name
Type: string
| Name of the product. Example: shirt | items.product
Type: object
| Unaltered Product object Example: "product": {
"_id": "5ad830764ce249ab654e53d8",
"_metadata": {
"i18n": {
"EN": {},
"FR": {},
"HI": {},
"MS": {},
"SQ": {}
}
},
"inventory_management": "automatic",
"publish": "1",
"images": [
{
"image": "ms.products/5ad830764ce249ab654e53d8/images/5ae07bfb2dc51abf07f539fc/5ae07bf52dc51abf07f539f7/5ae07bf52dc51abf07f539f7.jpg",
"tempSrc": "https://cdn.storehippo.com/s/58934ba3bc87057a5b6ee2bc/ms.products/5ad830764ce249ab654e53d8/images/5ae07bfb2dc51abf07f539fc/5ae07bf52dc51abf07f539f7/5ae07bf52dc51abf07f539f7-240x240.jpg",
"preview": true,
"_metadata": {
"image": {
"name": "101010.1(1).jpg",
"type": "image/jpeg",
"size": 8394,
"versioning": true,
"_id": "5ae07bf52dc51abf07f539f7"
}
},
"_id": "5ae07bfb2dc51abf07f539fc"
}
],
"collections": [],
"categories": [
"sss"
],
"tax": "default",
"substore": [],
"options": [
{
"name": "Color",
"value": "red"
},
{
"name": "Size",
"value": "l"
}
],
"option_set": "",
"SEO": {},
"media": [],
"attributes": [],
"features": [],
"files": [],
"seller": "5ad0a0779a4cbc2439988840",
"approve": "approved",
"name": "shirt",
"alias": "shirt",
"price": "7.00",
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_l",
"variants": [
{
"options": [
{
"name": "Color",
"value": "red"
},
{
"name": "Size",
"value": "l"
}
],
"id": 88158,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_l",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 9,
"variant_id": "red|l"
},
{
"options": [
{
"name": "Color",
"value": "red"
},
{
"name": "Size",
"value": "xxl"
}
],
"id": 60097,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_xxl",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 3,
"variant_id": "red|xxl"
},
{
"options": [
{
"name": "Color",
"value": "red"
},
{
"name": "Size",
"value": "m"
}
],
"id": 6494,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_m",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 9,
"variant_id": "red|m"
},
{
"options": [
{
"name": "Color",
"value": "blue"
},
{
"name": "Size",
"value": "xl"
}
],
"id": 41643,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_xl",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 10,
"variant_id": "blue|xl"
},
{
"options": [
{
"name": "Color",
"value": "blue"
},
{
"name": "Size",
"value": "l"
}
],
"id": 54716,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_l",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 10,
"variant_id": "blue|l"
},
{
"options": [
{
"name": "Color",
"value": "blue"
},
{
"name": "Size",
"value": "xxl"
}
],
"id": 42419,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_xxl",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 9,
"variant_id": "blue|xxl"
},
{
"options": [
{
"name": "Color",
"value": "blue"
},
{
"name": "Size",
"value": "m"
}
],
"id": 63317,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_m",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 10,
"variant_id": "blue|m"
}
],
"default_variant": {
"options": [
{
"name": "Color",
"value": "red"
},
{
"name": "Size",
"value": "xl"
}
],
"id": 78916,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 10,
"variant_id": "red|xl"
},
"available": 1,
"weight_updated": true,
"uniquesku": [
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_l",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_xxl",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_m",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_xl",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_l",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_xxl",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_m"
],
"dimension": {},
"sort_order": 0,
"created_on": "2018-04-19T06:00:22.249Z",
"_created_by": "58a588610d25ca094c2fca09",
"updated_on": "2018-05-01T13:01:21.407Z",
"_updated_by": "58a3fba935a5cdff1784e5e2",
"description": "",
"inventory_quantity": 9,
"inventory_management_level": "variant",
"metafields": {
"field1": "Test 1",
"Value 3": "3",
"Value 1": "1",
"Value 2": "2"
},
"id": 88158,
"variant_id": "red|l",
"selected_options": {
"color": "red",
"size": "l",
"Color": "red",
"Size": "l"
},
"list_price": 7,
"our_price": 7,
"original_price": 7,
"compare_price": "7.00",
"discounts_total": 0,
"discounts_percentage": "0.000",
"discount_total": 0
}
| items.product_id
Type: string
| Unique handler of product | items.price
Type: number
| Price of product | items.variant_id
Type: string
| Variant Id of the selected product. Example: red|l | items.selected_options
Type: object
| Options selected by the user Example: "selected_options": {
"color": "red",
"size": "l"
}
| items.seller
Type: string
| Seller Id of the product. Example: 5ad0a0779a4cbc2439988840 | items.linked_product_id
Type: string
| Id of linked product (if any). Example: null | items.discounts_total
Type: number
| Total discount amount applied. | items.discounts
Type: array
| An array of object that contains details of discount applied on product. | items.taxes
Type: array
| An array of object that contains details of taxes applied on product. | items.fulfilled_quantity
Type: number
| This field holds the count of product items that are fulfilled. | items.taxes_total
Type: number
| Total tax amount applied | items.image_url
Type: string
| Url of product image. |
|
item_count
Type: string
Required | This field contain the total number of items in order.
|
invoice_number
Type: string
| This field has the invoice number associated with order.
This field can be populated by admin incase admin has selected manual invoice number generation in settings.
|
language
Type: string
Required | This field has the current language of website if store support multiple languages.
|
metafields
Type: string
Required | This field is an object and contain the additional information inserted programatticaly .
|
options
Type: string
| This field is an object and contain addtional information inserted by user , limited by store owner.
Ex. delivery slot , delivery date etc.
|
order_id
Type: string
| This is unique id of order, which made up of two parts:
prefix : will be retrived from settings order id prefix
sequence number : It is auto generated numeric sequence
OID100
OID : prefix
100 : sequence number
|
payment_method
Type: object
| This field is an object contain the inforamtion of payment method used for placing order on the cart. Example: "payment_method":
{"_id":"541fd019360299ca6d08581f",
"type":"cash_on_delivery",
"enabled":"1",
"settings":{
"message":"COD",
"check_availablity":true,
"userinput":false,
"form_name":"",
"validate":false,
"validation_source":"sms"
},
"name":"Cash on Delivery",
"check_availablity":"0",
"alias":"cash-on-delivery",
"updated_on":"2018-03-26T09:37:18.639Z",
"_updated_by":"58a3fba935a5cdff1784e5e2",
"additional_charges":99,
"sort_order":0,
"conditions":[]
}
payment_method._id
Type: string
Read Only
| Unique handler of payment metod | payment_method.type
Type: string
| This field contain the mode of payment method Example: Cash On Delivery | payment_method.name
Type: string
| Name of the payment method. Example: Cash On Delivery | payment_method.enabled
Type: number
| This is a flag variable which determines whether payment method is applied or not. |
|
shipping_address
Type: object
Required | This field holds address at which order is to be shipped. Example: "shipping_address":{
"full_name": "sample address"
"address": "Moti Nagar "
"city": "Delhi"
"state": "Delhi"
"country": "IN"
"zip": "110001"
"phone": "555-625-1199"
}
shipping_address.full_name
Type: string
| The full name of the person associated with the payment method. | shipping_address.address
Type: string
Required | The street address of the shipping address | shipping_address.city
Type: string
Required | The city of the shipping address. | shipping_address.state
Type: string
Required | The state of the shipping address. | shipping_address.country
Type: string
Required | The name of the country of the shipping address. | shipping_address.zip
Type: string
| The zip or postal code of the shipping address. | shipping_address.phone
Type: number
Required | The phone number at the billing address. |
|
sub_total
Type: number
Read Only
| This field contain total summation of all item's total present in order.
|
shipping_total
Type: number
Read Only
| This field contain the total shipping charges applied on order.
|
shipping_method
Type: object
| This field is an object contain the inforamtion of shipping method used for placing order on the cart. Example: "shipping_method": {
"name": "Shipping charges",
"price": 0,
"seller": "all_sellers",
"prices_are": "exclusive",
"taxes": [
{
"name": "CGST",
"taxable_amount": 0,
"tax_amount": 0,
"tax_type": "exclusive",
"rate": 2.5,
"_id": "5a9e9a65bdac12b450321d63"
},
{
"name": "SGST",
"taxable_amount": 0,
"tax_amount": 0,
"tax_type": "exclusive",
"rate": 2.5,
"_id": "5a9e9a65bdac12b450321d64"
}
],
"taxes_total": "0.000",
"tax_applied_on": "0.00",
"tax_plus_taxable_amount": "0.00"
}
shipping_method.name
Type: string
| Name of the shipping method applied Example: Shiping Charges | shipping_method.price
Type: number
| Amount of shipping method applied. | shipping_method.sellers
Type: string
| This field tells whether the shipping method is applied to all sellers or specific sellers. Example: all_sellers | shipping_method.prices_are
Type: string
| Prices are either exclusive or inclusive. Example: inclusive | shipping_method.taxes
Type: array
| It is an array of object which stores details of taxes applied on product. Example: "taxes": [
{
"name": "CGST",
"taxable_amount": 0,
"tax_amount": 0,
"tax_type": "exclusive",
"rate": 2.5,
"_id": "5a9e9a65bdac12b450321d63"
},
{
"name": "SGST",
"taxable_amount": 0,
"tax_amount": 0,
"tax_type": "exclusive",
"rate": 2.5,
"_id": "5a9e9a65bdac12b450321d64"
}
]
| shipping_method.taxes_total
Type: number
| Total amount of tax applied |
|
status
Type: string
| This field show the status of order at various stages.
possible values :
Open = this indicate that order is placed with any of the payment mode .
Closed = This inicate that order is completed in all respect.
Cancled = This indicate that order is cancelled be user or admin.
|
total
Type: number
Read Only
| This field contain total amount payable/paid for order.
|
taxes_total
Type: number
Read Only
| This field contain the total tax amount charged on cart.
|
total_weight
Type: string
Read Only
| This field carry summation of weight of all items in cart.
|
txn_id
Type: string
Read Only
| This field has unique identifier which is used for making payment.
|
user_id
Type: string
Read Only
| This field has the unique id of user placed the order.
|
delivery_status
Type: string
| Delivery status of a shipped order.
|
taxes
Type: array
| Array of taxes applicable on the order. Example: "taxes": [
{
"name": "CGST",
"taxable_amount": 380,
"tax_amount": "9.50",
"tax_type": "exclusive",
"index": 1,
"rate": 2.5,
"_id": "5a9e9a65bdac12b450321d63"
},
{
"name": "SGST",
"taxable_amount": 380,
"tax_amount": "9.50",
"tax_type": "exclusive",
"index": 2,
"rate": 2.5,
"_id": "5a9e9a65bdac12b450321d64"
}
]
taxes.name
Type: string
| This field tells the name of tax. | taxes.tax_type
Type: string
| It is alias of record of entity ms.tax_types. | taxes.tax_amount
Type: number
| Amount of tax applied on product. | taxes.taxable_amount
Type: number
| Amount obtained after adding tax. | taxes.rate
Type: number
| Percentage of tax. | taxes.index
Type: number
| Index of tax in taxes object. | taxes._id
Type: string
| Unique handler for tax applied on product. |
|
cart_id
Type: string
| ID of the cart for which the order was generated.
|
discounts_total
Type: number
| Total discount value applied on the order.
|
fulfillments
Type: array
| Details of shipment like tracking_number, logistics company, etc of a shipped order.
|
balance_amount
Type: number
| Amount to be received from the customer for the order.
|
seller
Type: string
| ID of the order's seller.
|
comments
Type: string
|
|
notify_customer
Type: string
|
|
timestamp
Type: string
|
|
fulfillment_status
Type: string
|
|
price_type
Type: string
|
|
history
Type: string
|
|
browser_ip
Type: string
|
|
payment_status
Type: string
|
|
shipping_status
Type: string
|
|
shipping_details
Type: string
|
|
notes
Type: array
|
|
payment_details
Type: object
|
|
version
Type: string
|
|
seller_name
Type: string
|
|
seller_email
Type: string
|
|
info
Type: string
|
|
created_on
Type: datetime
|
|
items._id
Type: string
| The unique numeric identifier for the cart item.
|
items.name
Type: string
| Name of the product. Example: shirt
|
items.product
Type: object
| Unaltered Product object Example: "product": {
"_id": "5ad830764ce249ab654e53d8",
"_metadata": {
"i18n": {
"EN": {},
"FR": {},
"HI": {},
"MS": {},
"SQ": {}
}
},
"inventory_management": "automatic",
"publish": "1",
"images": [
{
"image": "ms.products/5ad830764ce249ab654e53d8/images/5ae07bfb2dc51abf07f539fc/5ae07bf52dc51abf07f539f7/5ae07bf52dc51abf07f539f7.jpg",
"tempSrc": "https://cdn.storehippo.com/s/58934ba3bc87057a5b6ee2bc/ms.products/5ad830764ce249ab654e53d8/images/5ae07bfb2dc51abf07f539fc/5ae07bf52dc51abf07f539f7/5ae07bf52dc51abf07f539f7-240x240.jpg",
"preview": true,
"_metadata": {
"image": {
"name": "101010.1(1).jpg",
"type": "image/jpeg",
"size": 8394,
"versioning": true,
"_id": "5ae07bf52dc51abf07f539f7"
}
},
"_id": "5ae07bfb2dc51abf07f539fc"
}
],
"collections": [],
"categories": [
"sss"
],
"tax": "default",
"substore": [],
"options": [
{
"name": "Color",
"value": "red"
},
{
"name": "Size",
"value": "l"
}
],
"option_set": "",
"SEO": {},
"media": [],
"attributes": [],
"features": [],
"files": [],
"seller": "5ad0a0779a4cbc2439988840",
"approve": "approved",
"name": "shirt",
"alias": "shirt",
"price": "7.00",
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_l",
"variants": [
{
"options": [
{
"name": "Color",
"value": "red"
},
{
"name": "Size",
"value": "l"
}
],
"id": 88158,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_l",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 9,
"variant_id": "red|l"
},
{
"options": [
{
"name": "Color",
"value": "red"
},
{
"name": "Size",
"value": "xxl"
}
],
"id": 60097,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_xxl",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 3,
"variant_id": "red|xxl"
},
{
"options": [
{
"name": "Color",
"value": "red"
},
{
"name": "Size",
"value": "m"
}
],
"id": 6494,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_m",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 9,
"variant_id": "red|m"
},
{
"options": [
{
"name": "Color",
"value": "blue"
},
{
"name": "Size",
"value": "xl"
}
],
"id": 41643,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_xl",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 10,
"variant_id": "blue|xl"
},
{
"options": [
{
"name": "Color",
"value": "blue"
},
{
"name": "Size",
"value": "l"
}
],
"id": 54716,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_l",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 10,
"variant_id": "blue|l"
},
{
"options": [
{
"name": "Color",
"value": "blue"
},
{
"name": "Size",
"value": "xxl"
}
],
"id": 42419,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_xxl",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 9,
"variant_id": "blue|xxl"
},
{
"options": [
{
"name": "Color",
"value": "blue"
},
{
"name": "Size",
"value": "m"
}
],
"id": 63317,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_m",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 10,
"variant_id": "blue|m"
}
],
"default_variant": {
"options": [
{
"name": "Color",
"value": "red"
},
{
"name": "Size",
"value": "xl"
}
],
"id": 78916,
"price": 7,
"sku": "77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl",
"dimension": {},
"inventory_management": "automatic",
"inventory_quantity": 10,
"variant_id": "red|xl"
},
"available": 1,
"weight_updated": true,
"uniquesku": [
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_l",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_xxl",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_red_m",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_xl",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_l",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_xxl",
"77_fg_ty_red_xl_red_xl_red_xl_red_l_red_xl_blue_xxl_red_xl_blue_m"
],
"dimension": {},
"sort_order": 0,
"created_on": "2018-04-19T06:00:22.249Z",
"_created_by": "58a588610d25ca094c2fca09",
"updated_on": "2018-05-01T13:01:21.407Z",
"_updated_by": "58a3fba935a5cdff1784e5e2",
"description": "",
"inventory_quantity": 9,
"inventory_management_level": "variant",
"metafields": {
"field1": "Test 1",
"Value 3": "3",
"Value 1": "1",
"Value 2": "2"
},
"id": 88158,
"variant_id": "red|l",
"selected_options": {
"color": "red",
"size": "l",
"Color": "red",
"Size": "l"
},
"list_price": 7,
"our_price": 7,
"original_price": 7,
"compare_price": "7.00",
"discounts_total": 0,
"discounts_percentage": "0.000",
"discount_total": 0
}
|
items.product_id
Type: string
| Unique handler of product
|
items.price
Type: number
| Price of product
|
items.variant_id
Type: string
| Variant Id of the selected product. Example: red|l
|
items.selected_options
Type: object
| Options selected by the user Example: "selected_options": {
"color": "red",
"size": "l"
}
|
items.seller
Type: string
| Seller Id of the product. Example: 5ad0a0779a4cbc2439988840
|
items.linked_product_id
Type: string
| Id of linked product (if any). Example: null
|
items.discounts_total
Type: number
| Total discount amount applied.
|
items.discounts
Type: array
| An array of object that contains details of discount applied on product.
|
billing_address.full_name
Type: string
| The full name of the person associated with the payment method.
|
shipping_address.full_name
Type: string
| The full name of the person associated with the payment method.
|
billing_address.address
Type: string
Required | The street address of the billing address.
|
shipping_address.address
Type: string
Required | The street address of the shipping address
|
billing_address.city
Type: string
Required | The city of the billing address.
|
shipping_address.city
Type: string
Required | The city of the shipping address.
|
billing_address.state
Type: string
Required | The state of the billing address.
|
shipping_address.state
Type: string
Required | The state of the shipping address.
|
billing_address.country
Type: string
Required | The name of the country of the billing address.
|
shipping_address.country
Type: string
Required | The name of the country of the shipping address.
|
billing_address.zip
Type: string
Required | The zip or postal code of the billing address.
|
shipping_address.zip
Type: string
| The zip or postal code of the shipping address.
|
billing_address.phone
Type: number
Required | The phone number at the billing address.
|
shipping_address.phone
Type: number
Required | The phone number at the billing address.
|
items.taxes
Type: array
| An array of object that contains details of taxes applied on product.
|
items.fulfilled_quantity
Type: number
| This field holds the count of product items that are fulfilled.
|
items.thumbnail_url
Type: string
| Url of product image
|
items.taxes_total
Type: number
| Total tax amount applied
|
items.image_url
Type: string
| Url of product image.
|
taxes.name
Type: string
| This field tells the name of tax.
|
taxes.tax_type
Type: string
| It is alias of record of entity ms.tax_types.
|
taxes.tax_amount
Type: number
| Amount of tax applied on product.
|
taxes.taxable_amount
Type: number
| Amount obtained after adding tax.
|
taxes.rate
Type: number
| Percentage of tax.
|
taxes.index
Type: number
| Index of tax in taxes object.
|
taxes._id
Type: string
| Unique handler for tax applied on product.
|
ecoupon.code
Type: string
| Name of coupon code applied.
|
ecoupon.discount
Type: object
| A discount object which contains all details of discount applied on product.
|
discounts._id
Type: string
| Unique handler for discount applied.
|
discounts.saving_amount
Type: number
| Amount saved on application of discount on product.
|
discounts.coupon_code
Type: string
| Name of coupon code applied
|
payment_method._id
Type: string
Read Only
| Unique handler of payment metod
|
payment_method.type
Type: string
| This field contain the mode of payment method Example: Cash On Delivery
|
payment_method.name
Type: string
| Name of the payment method. Example: Cash On Delivery
|
payment_method.enabled
Type: number
| This is a flag variable which determines whether payment method is applied or not.
|
shipping_method.name
Type: string
| Name of the shipping method applied Example: Shiping Charges
|
shipping_method.price
Type: number
| Amount of shipping method applied.
|
shipping_method.sellers
Type: string
| This field tells whether the shipping method is applied to all sellers or specific sellers. Example: all_sellers
|
shipping_method.prices_are
Type: string
| Prices are either exclusive or inclusive. Example: inclusive
|
shipping_method.taxes
Type: array
| It is an array of object which stores details of taxes applied on product. Example: "taxes": [
{
"name": "CGST",
"taxable_amount": 0,
"tax_amount": 0,
"tax_type": "exclusive",
"rate": 2.5,
"_id": "5a9e9a65bdac12b450321d63"
},
{
"name": "SGST",
"taxable_amount": 0,
"tax_amount": 0,
"tax_type": "exclusive",
"rate": 2.5,
"_id": "5a9e9a65bdac12b450321d64"
}
]
|
shipping_method.taxes_total
Type: number
| Total amount of tax applied
|
