Orders

(ms.orders)

Orders section lets you manage and perform operations on your orders.



Fields

Value Description
order_id   
Type: string
The unique id of order.

It is made up of two parts: 
Prefix: Order id prefix is retrieved from settings.
Sequence number: It is an auto generated numeric sequence.
OID100
OID: prefix
100: sequence number
items   
Type: array
It is an array of object which stores details of products in the cart.
_id
Type: string
The unique numeric identifier for the product in the cart.
59d605da64abe444540ee6e0
name
Type: string
Name of the product.
Mustard sweater
product_id
Type: string
Unique id of the product.
product_url
Type: string
The URL of the product page.
weight
Type: string
The weight of the product.
variant_id
Type: string
Variant id of the selected product.
red|l
seller
Type: string
Seller id of the product.
5ad0a0779a4cbc2439988840
linked_product_id
Type: string
Id of linked product (if any).
null
price
Type: string
Price of the product.
list_price
Type: number
Listing price of the product.
discounts_percentage
Type: string
The percentage of the discount applied.
discounts_total
Type: string
Total discounted amount applied.
discounts
Type: array
An array of object that contains details of discount applied on product.
taxes_total
Type: number
Total tax amount applied.
shipping_cost
Type: number
The shipping cost applied on the order.
discount_total
Type: string
quantity
Type: number
The quantity of the items in the cart.
total
Type: number
payment_method   
Type: object
The object contains the information of payment method used for placing the order.
{
  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": []
    }
}
name
Type: string
Name of the payment method.
Cash On Delivery
enabled
Type: string
A flag variable that determines whether payment method is applied or not.
settings
Type: object
type
Type: string
It contains the mode of the payment method.
Cash On Delivery
_id
Type: string
Unique id of the payment method.
status   
Type: string
It shows the status of order at various stages.

The possible values of status are:
 
Open: This status indicates that the order is placed with any of the payment mode.
Closed: This status indicates that the order is completed.
Cancelled: This status indicates that the order has been cancelled by the user or admin.
shipping_method   
Type: object
The object contains the information of the shipping method used for placing the order.
{
  "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"
  }
}
_id
Type: string
This field contains the id of the shipping method.
name
Type: string
Name of the shipping method applied.
Shipping Charges
price
Type: number
The amount of shipping charges applied.
discounts_total
Type: number
discounts_percentage
Type: number
taxes   
Type: string
Array of taxes applicable on the order.
<pre class="language-json"><code>"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"
        }
      ]</code></pre>
discounts   
Type: string
It is an array of object containing details of cart level discounts.
<pre class="language-json"><code>"discounts":[{
        "_id":"53b256e9b3af14aa15e451a5",
        "saving_amount":100,
        "coupon_code":"Get 100"
}]</code></pre>
total   
Type: number
This field contain total amount payable/paid for order.
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.
<p>pending</p>
fulfillment_status   
Type: string
cart_id   
Type: string
ID of the cart for which the order was generated.
sub_total   
Type: number
This field contain total summation of all item's total present in order.
discounts_total   
Type: number
Total discount value applied on the order.
currency   
Type: object
It is object containing name and conversion_rate of currency
<pre class="language-json"><code>"currency":{ "name":"USD", "conversion_rate":"0.14"}</code></pre>
name
Type: string
conversion_rate
Type: string
taxes_total   
Type: number
This field contain the total tax amount charged on cart.
shipping_total   
Type: number
This field contain the total shipping charges applied on order.
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.
{
  "address": "B4-309 Spaze iTech Park, Sector-49, Sohna Road",
  "city": "Gurgoan",
  "country": "IN",
  "full_name": "Testing",
  "phone": "1234567890",
  "state": "Harayana",
  "zip": "122001"
}
country
Type: string
The name of the country of the billing address.
full_name
Type: string
The full name of the person associated with the payment method.
address
Type: string
The street address of the billing address.
city
Type: string
The city of the billing address.
state
Type: string
The state of the billing address.
zip
Type: string
The zip or postal code of the billing address.
phone
Type: string
The phone number at the billing address.
shipping_address   
Type: object
This field holds address at which order is to be shipped.
<pre class="language-json"><code>"shipping_address":{
    "full_name": "sample address"
    "address": "Moti Nagar "
    "city": "Delhi"
    "state": "Delhi"
    "country": "IN"
    "zip": "110001"
    "phone": "555-625-1199"
}</code></pre>
country
Type: string
The name of the country of the shipping address.
full_name
Type: string
The full name of the person associated with the payment method.
city
Type: string
The city of the shipping address.
address
Type: string
The street address of the shipping address
state
Type: string
The state of the shipping address.
zip
Type: string
The zip or postal code of the shipping address.
phone
Type: string
The phone number at the billing address.
additional_charges   
Type: array
It is an array of object containing details of additional charges.
<pre class="language-json"><code>"additional_charges":[{
     "name":" Offline payment Changes",
     "type":"payment_charges",
     "price" :"50"
}]</code></pre>
name
Type: string
type
Type: string
amount
Type: number
_id
Type: string
item_count   
Type: string
This field contain the total  number of items in order.
email   
Type: string
This field contain email id of customer.
<p>trial@storehippo.com</p>
fulfillments   
Type: array
Details of shipment like tracking_number, logistics company, etc of a shipped order.
method
Type: string
price
Type: string
service
Type: string
status
Type: string
tracking_company
Type: string
tracking_number
Type: string
fulfillments_new   
Type: relation
shipments   
Type: relation
user_id   
Type: string
This field has the unique id of user placed the order.
transactions   
Type: relation
returns   
Type: relation
refunds   
Type: relation
client_details   
Type: object
This object contains the detail of system of the user. These details is gathered for navigator object of javascript.
{
  "client_details": {
         "platform": "Win", 
         "browser": "Chrome"
   }
}
device
Type: string
ip
Type: string
substore
Type: string
balance_amount   
Type: number
Amount to be received from the customer for the order.
txn_id   
Type: string
This field has unique identifier which is used for making payment.
seller   
Type: string
ID of the order's seller.
cancellation_reason   
Type: string
purchase_order_id   
Type: string
user_input   
Type: custom
substore   
Type: string
payment_link_generated_on   
Type: string

Commands (Endpoints)

GET /api/1.1/entity/ms.orders/_/addOrder   
This command is used to add the new Order

Examples

addOrder

Request
 {
                        "items": [
                            {
                                "product_id": "5eb53cb119e5a564d4527d8a",
                                "quantity": 1
                            }
                        ],
                        "sub_total": 2499,
                        "total": 2499,
                        "item_count": 1,
                        "email_id": "jamesjohn@gmail.com",
                        "user_id": "5e1ec5203735093314764ce4",
                        "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"
                        },
                        "shipping_address": {
                            "address": "B4-309 Spaze iTech Park, Sector-49, Sohna Road",
                            "city": "Gurgoan",
                            "country": "IN",
                            "full_name": "Testing",
                            "phone": "1234567890",
                            "state": "Harayana",
                            "zip": "122001"
                        },
                        "payment_method": {}
                    }
Response
{
    "fileBaseUrl": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/",
    "data": {
        "items": [
            {
                "_id": "5eba498e2150fba9a26b5b00",
                "name": "Peach Mandarin Neck Embroidered Kurta",
                "product_id": "5eb53cb119e5a564d4527d8a",
                "product_url": "/product/peach-mandarin-neck-embroidered-kurta",
                "metafields": {
                    "style_code": "20FES10543-213048"
                },
                "seller": "5bfbd39c0790f66e158b0be7",
                "price": 2499,
                "list_price": 2499,
                "discounts_percentage": "0.000",
                "discounts_total": 0,
                "discounts": [],
                "override_total": 0,
                "overrides": {},
                "taxes": [
                    {
                        "name": "IGST",
                        "taxable_amount": 2499,
                        "tax_amount": "449.8",
                        "tax_type": "exclusive",
                        "index": 1,
                        "rate": 18,
                        "channels": {},
                        "enable_taxjar": "0",
                        "_id": "5d5e9becfad4702e72cc6aaa"
                    }
                ],
                "taxes_total": "449.8",
                "shipping_cost": 0,
                "sku": "8907819282530",
                "thumbnail_url": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8b/5eb53cb319e5a564d4527de0/5eb53cb319e5a564d4527de0-240x240.jpg",
                "image_url": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8b/5eb53cb319e5a564d4527de0/5eb53cb319e5a564d4527de0-1024x1024.jpg",
                "product": {
                    "_id": "5eb53cb119e5a564d4527d8a",
                    "name": "Peach Mandarin Neck Embroidered Kurta",
                    "alias": "peach-mandarin-neck-embroidered-kurta",
                    "description": "<p>Peach mandarin neck kurta with gold and sequins embroidery detail and placket on the front.</p>",
                    "price": 2499,
                    "compare_price": 2499,
                    "collections": [],
                    "brand": "Wishful",
                    "sku": "8907819282530",
                    "categories": [
                        "kurtas",
                        "topwear"
                    ],
                    "publish": "1",
                    "sort_order": 0,
                    "inventory_management": "none",
                    "inventory_management_level": "variant",
                    "inventory_quantity": 5,
                    "available": 1,
                    "created_on": "2020-05-08T11:04:21.355Z",
                    "metafields": {
                        "style_code": "20FES10543-213048"
                    },
                    "attributes": [
                        {
                            "name": "Color",
                            "value": "Pink",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb183"
                        },
                        {
                            "name": "Neck",
                            "value": "Mandarin",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb184"
                        },
                        {
                            "name": "Sleeve",
                            "value": "3/4 Sleeve",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb185"
                        },
                        {
                            "name": "Occasion",
                            "value": "Festive",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb186"
                        },
                        {
                            "name": "Pattern",
                            "value": "Striped",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb187"
                        },
                        {
                            "name": "Material",
                            "value": "Viscose",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb188"
                        },
                        {
                            "name": "Size",
                            "value": "10",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb189"
                        },
                        {
                            "name": "For Complaints",
                            "value": "Customer Care No 8800698168, customercare@tcnsclothing.com",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb18a"
                        },
                        {
                            "name": "Manufactured & Packed for",
                            "value": "TCNS Clothing Co. Limited",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb18b"
                        },
                        {
                            "name": "Marketed By",
                            "value": "TCNS Clothing Co. Limited",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb18c"
                        },
                        {
                            "name": "Name of Manufacturer",
                            "value": "TCNS LIMITED B-16",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb18d"
                        },
                        {
                            "name": "Place of Manufacturer",
                            "value": "B-16 Sector-58 NOIDA UP-201301",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb18e"
                        },
                        {
                            "name": "Quantity",
                            "value": "1N",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb18f"
                        },
                        {
                            "name": "Registered Office Address",
                            "value": "Unit No 112 F/F Rectangle-1 D-4 Saket, New Delhi DL-110407",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb190"
                        },
                        {
                            "name": "Closure",
                            "value": "No",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb191"
                        },
                        {
                            "name": "FabricContent",
                            "value": "100% Viscose",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb192"
                        },
                        {
                            "name": "Fit",
                            "value": "Regular",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb193"
                        },
                        {
                            "name": "SlitDetail",
                            "value": "Straight",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb194"
                        }
                    ],
                    "images": [
                        {
                            "image": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8b/5eb53cb319e5a564d4527de0/5eb53cb319e5a564d4527de0.jpg",
                            "caption": "",
                            "tags": "",
                            "_id": "5eb53cb119e5a564d4527d8b",
                            "_metadata": {
                                "image": {
                                    "type": "image/jpeg",
                                    "name": "5e846625e63ebcc8621cd69e.jpg",
                                    "_id": "5eb53cb319e5a564d4527de0"
                                }
                            },
                            "tempSrc": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8b/5eb53cb319e5a564d4527de0/5eb53cb319e5a564d4527de0-240x240.jpg",
                            "preview": true
                        },
                        {
                            "image": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8c/5eb53cb419e5a564d4527dfa/5eb53cb419e5a564d4527dfa.jpg",
                            "caption": "",
                            "tags": "",
                            "_id": "5eb53cb119e5a564d4527d8c",
                            "_metadata": {
                                "image": {
                                    "type": "image/jpeg",
                                    "name": "5e846625e63ebcc8621cd69f.jpg",
                                    "_id": "5eb53cb419e5a564d4527dfa"
                                }
                            },
                            "tempSrc": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8c/5eb53cb419e5a564d4527dfa/5eb53cb419e5a564d4527dfa-240x240.jpg",
                            "preview": true
                        },
                        {
                            "image": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8d/5eb53cb419e5a564d4527de6/5eb53cb419e5a564d4527de6.jpg",
                            "caption": "",
                            "tags": "",
                            "_id": "5eb53cb119e5a564d4527d8d",
                            "_metadata": {
                                "image": {
                                    "type": "image/jpeg",
                                    "name": "5e846625e63ebcc8621cd69d.jpg",
                                    "_id": "5eb53cb419e5a564d4527de6"
                                }
                            },
                            "tempSrc": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8d/5eb53cb419e5a564d4527de6/5eb53cb419e5a564d4527de6-240x240.jpg",
                            "preview": true
                        },
                        {
                            "image": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8e/5eb53cb319e5a564d4527de1/5eb53cb319e5a564d4527de1.jpg",
                            "caption": "",
                            "tags": "",
                            "_id": "5eb53cb119e5a564d4527d8e",
                            "_metadata": {
                                "image": {
                                    "type": "image/jpeg",
                                    "name": "5e846625e63ebcc8621cd69c.jpg",
                                    "_id": "5eb53cb319e5a564d4527de1"
                                }
                            },
                            "tempSrc": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8e/5eb53cb319e5a564d4527de1/5eb53cb319e5a564d4527de1-240x240.jpg",
                            "preview": true
                        },
                        {
                            "image": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8f/5eb53cb419e5a564d4527df0/5eb53cb419e5a564d4527df0.jpg",
                            "caption": "",
                            "tags": "",
                            "_id": "5eb53cb119e5a564d4527d8f",
                            "_metadata": {
                                "image": {
                                    "type": "image/jpeg",
                                    "name": "5e846625e63ebcc8621cd6af.jpg",
                                    "_id": "5eb53cb419e5a564d4527df0"
                                }
                            },
                            "tempSrc": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8f/5eb53cb419e5a564d4527df0/5eb53cb419e5a564d4527df0-240x240.jpg",
                            "preview": true
                        }
                    ],
                    "variants": [],
                    "options": [
                        {
                            "name": "size",
                            "values": [
                                "10",
                                "12",
                                "14",
                                "16",
                                "18",
                                "6",
                                "8"
                            ],
                            "_id": "5eb55abadc3ba00abb0cb182"
                        }
                    ],
                    "default_variant": null,
                    "approve": "approved",
                    "seller": "5bfbd39c0790f66e158b0be7",
                    "uniquesku": [
                        "8907819282530"
                    ],
                    "weight_updated": true,
                    "media": [],
                    "dimension": {},
                    "SEO": {},
                    "files": [],
                    "_created_by": "530d7f8bc6b8283a11000003",
                    "updated_on": "2020-05-12T06:59:05.272Z",
                    "_updated_by": "530d7f8bc6b8283a11000003",
                    "_metadata": {
                        "i18n": {
                            "EN": {},
                            "AR": {}
                        }
                    },
                    "tax": "default",
                    "substore": [],
                    "features": [],
                    "is_catalog": "1",
                    "catalog_only": "1",
                    "option_set": "",
                    "configurable_fields": [
                        "price",
                        "compare_price",
                        "mrp_discount",
                        "sku",
                        "barcode",
                        "weight",
                        "inventory_management",
                        "inventory_allow_out_of_stock",
                        "inventory_quantity",
                        "min_limit_to_buy_this_product",
                        "max_limit_to_buy_this_product",
                        "tag"
                    ],
                    "list_price": 2499,
                    "our_price": 2499,
                    "original_price": 2499
                },
                "discount_total": 0,
                "quantity": 1,
                "total": 2499,
                "prices_are": "exclusive",
                "tax_applied_on": "2499.00",
                "tax_plus_taxable_amount": "2948.80"
            }
        ],
        "sub_total": 2499,
        "total": "2948.8000",
        "item_count": 1,
        "status": "open",
        "financial_status": "Pending",
        "balance_amount": "0",
        "delivery_status": null,
        "shipping_status": null,
        "fulfillment_status": null,
        "cart_id": "5eba498e2150fba9a26b5b03",
        "email": "jamesjohn@gmail.com",
        "user_id": "5e1ec5203735093314764ce4",
        "discounts": [],
        "discount_total": 0,
        "discounts_total": 0,
        "shipping_method": {
            "_id": "aersda@#$32sfas2342",
            "name": "Shipping charges",
            "price": 0,
            "seller": "all_sellers",
            "prices_are": "exclusive",
            "taxes": [
                {
                    "name": "IGST",
                    "taxable_amount": 0,
                    "tax_amount": 0,
                    "tax_type": "exclusive",
                    "rate": 18,
                    "_id": "5d5e9becfad4702e72cc6aaa"
                }
            ],
            "taxes_total": "0.000",
            "tax_applied_on": "0.00",
            "tax_plus_taxable_amount": "0.00"
        },
        "shipping_method_name": null,
        "shipping_total": 0,
        "shipping_by_vendor": {
            "5bfbd39c0790f66e158b0be7": 0
        },
        "currency": {
            "name": "SGD",
            "conversion_rate": 1,
            "decimal_points": 2,
            "symbol": "$"
        },
        "invoice_number": "",
        "invoice_numbers": [],
        "invoice_pdf_path": "",
        "taxes": [
            {
                "name": "IGST",
                "taxable_amount": 2499,
                "tax_amount": 449.8,
                "tax_type": "exclusive",
                "index": 1,
                "rate": 18,
                "channels": {},
                "enable_taxjar": "0",
                "_id": "5d5e9becfad4702e72cc6aaa",
                "prices_are": "exclusive"
            }
        ],
        "taxes_total": 449.8,
        "gift_cards": [],
        "gift_card_total": 0,
        "ecoupon": {},
        "options": {},
        "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"
        },
        "shipping_address": {
            "address": "B4-309 Spaze iTech Park, Sector-49, Sohna Road",
            "city": "Gurgoan",
            "country": "IN",
            "full_name": "Testing",
            "phone": "1234567890",
            "state": "Harayana",
            "zip": "122001"
        },
        "additional_charges": [],
        "metafields": {},
        "price_type": "inclusive",
        "channel": "admin",
        "payment_method": {},
        "wallets": [],
        "client_details": {
            "selected_language": "EN"
        },
        "marketplace_channel": {},
        "_id": "5eba498e2150fba9a26b5b2c",
        "txn_id": null,
        "created_on": "2020-05-12T07:00:30.570Z",
        "version": "ms.0.3.0",
        "orders": [
            {
                "items": [
                    {
                        "_id": "5eba498e2150fba9a26b5b00",
                        "name": "Peach Mandarin Neck Embroidered Kurta",
                        "product_id": "5eb53cb119e5a564d4527d8a",
                        "product_url": "/product/peach-mandarin-neck-embroidered-kurta",
                        "metafields": {
                            "style_code": "20FES10543-213048"
                        },
                        "seller": "5bfbd39c0790f66e158b0be7",
                        "price": 2499,
                        "list_price": 2499,
                        "discounts_percentage": "0.000",
                        "discounts_total": 0,
                        "discounts": [],
                        "override_total": 0,
                        "overrides": {},
                        "taxes": [
                            {
                                "name": "IGST",
                                "taxable_amount": 2499,
                                "tax_amount": "449.8",
                                "tax_type": "exclusive",
                                "index": 1,
                                "rate": 18,
                                "channels": {},
                                "enable_taxjar": "0",
                                "_id": "5d5e9becfad4702e72cc6aaa"
                            }
                        ],
                        "taxes_total": "449.8",
                        "shipping_cost": 0,
                        "sku": "8907819282530",
                        "thumbnail_url": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8b/5eb53cb319e5a564d4527de0/5eb53cb319e5a564d4527de0-240x240.jpg",
                        "image_url": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8b/5eb53cb319e5a564d4527de0/5eb53cb319e5a564d4527de0-1024x1024.jpg",
                        "product": {
                            "_id": "5eb53cb119e5a564d4527d8a",
                            "name": "Peach Mandarin Neck Embroidered Kurta",
                            "alias": "peach-mandarin-neck-embroidered-kurta",
                            "description": "<p>Peach mandarin neck kurta with gold and sequins embroidery detail and placket on the front.</p>",
                            "price": 2499,
                            "compare_price": 2499,
                            "collections": [],
                            "brand": "Wishful",
                            "sku": "8907819282530",
                            "categories": [
                                "kurtas",
                                "topwear"
                            ],
                            "publish": "1",
                            "sort_order": 0,
                            "inventory_management": "none",
                            "inventory_management_level": "variant",
                            "inventory_quantity": 5,
                            "available": 1,
                            "created_on": "2020-05-08T11:04:21.355Z",
                            "metafields": {
                                "style_code": "20FES10543-213048"
                            },
                            "attributes": [
                                {
                                    "name": "Color",
                                    "value": "Pink",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb183"
                                },
                                {
                                    "name": "Neck",
                                    "value": "Mandarin",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb184"
                                },
                                {
                                    "name": "Sleeve",
                                    "value": "3/4 Sleeve",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb185"
                                },
                                {
                                    "name": "Occasion",
                                    "value": "Festive",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb186"
                                },
                                {
                                    "name": "Pattern",
                                    "value": "Striped",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb187"
                                },
                                {
                                    "name": "Material",
                                    "value": "Viscose",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb188"
                                },
                                {
                                    "name": "Size",
                                    "value": "10",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb189"
                                },
                                {
                                    "name": "For Complaints",
                                    "value": "Customer Care No 8800698168, customercare@tcnsclothing.com",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb18a"
                                },
                                {
                                    "name": "Manufactured & Packed for",
                                    "value": "TCNS Clothing Co. Limited",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb18b"
                                },
                                {
                                    "name": "Marketed By",
                                    "value": "TCNS Clothing Co. Limited",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb18c"
                                },
                                {
                                    "name": "Name of Manufacturer",
                                    "value": "TCNS LIMITED B-16",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb18d"
                                },
                                {
                                    "name": "Place of Manufacturer",
                                    "value": "B-16 Sector-58 NOIDA UP-201301",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb18e"
                                },
                                {
                                    "name": "Quantity",
                                    "value": "1N",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb18f"
                                },
                                {
                                    "name": "Registered Office Address",
                                    "value": "Unit No 112 F/F Rectangle-1 D-4 Saket, New Delhi DL-110407",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb190"
                                },
                                {
                                    "name": "Closure",
                                    "value": "No",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb191"
                                },
                                {
                                    "name": "FabricContent",
                                    "value": "100% Viscose",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb192"
                                },
                                {
                                    "name": "Fit",
                                    "value": "Regular",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb193"
                                },
                                {
                                    "name": "SlitDetail",
                                    "value": "Straight",
                                    "group": "default",
                                    "_id": "5eb55abadc3ba00abb0cb194"
                                }
                            ],
                            "images": [
                                {
                                    "image": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8b/5eb53cb319e5a564d4527de0/5eb53cb319e5a564d4527de0.jpg",
                                    "caption": "",
                                    "tags": "",
                                    "_id": "5eb53cb119e5a564d4527d8b",
                                    "_metadata": {
                                        "image": {
                                            "type": "image/jpeg",
                                            "name": "5e846625e63ebcc8621cd69e.jpg",
                                            "_id": "5eb53cb319e5a564d4527de0"
                                        }
                                    },
                                    "tempSrc": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8b/5eb53cb319e5a564d4527de0/5eb53cb319e5a564d4527de0-240x240.jpg",
                                    "preview": true
                                },
                                {
                                    "image": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8c/5eb53cb419e5a564d4527dfa/5eb53cb419e5a564d4527dfa.jpg",
                                    "caption": "",
                                    "tags": "",
                                    "_id": "5eb53cb119e5a564d4527d8c",
                                    "_metadata": {
                                        "image": {
                                            "type": "image/jpeg",
                                            "name": "5e846625e63ebcc8621cd69f.jpg",
                                            "_id": "5eb53cb419e5a564d4527dfa"
                                        }
                                    },
                                    "tempSrc": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8c/5eb53cb419e5a564d4527dfa/5eb53cb419e5a564d4527dfa-240x240.jpg",
                                    "preview": true
                                },
                                {
                                    "image": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8d/5eb53cb419e5a564d4527de6/5eb53cb419e5a564d4527de6.jpg",
                                    "caption": "",
                                    "tags": "",
                                    "_id": "5eb53cb119e5a564d4527d8d",
                                    "_metadata": {
                                        "image": {
                                            "type": "image/jpeg",
                                            "name": "5e846625e63ebcc8621cd69d.jpg",
                                            "_id": "5eb53cb419e5a564d4527de6"
                                        }
                                    },
                                    "tempSrc": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8d/5eb53cb419e5a564d4527de6/5eb53cb419e5a564d4527de6-240x240.jpg",
                                    "preview": true
                                },
                                {
                                    "image": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8e/5eb53cb319e5a564d4527de1/5eb53cb319e5a564d4527de1.jpg",
                                    "caption": "",
                                    "tags": "",
                                    "_id": "5eb53cb119e5a564d4527d8e",
                                    "_metadata": {
                                        "image": {
                                            "type": "image/jpeg",
                                            "name": "5e846625e63ebcc8621cd69c.jpg",
                                            "_id": "5eb53cb319e5a564d4527de1"
                                        }
                                    },
                                    "tempSrc": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8e/5eb53cb319e5a564d4527de1/5eb53cb319e5a564d4527de1-240x240.jpg",
                                    "preview": true
                                },
                                {
                                    "image": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8f/5eb53cb419e5a564d4527df0/5eb53cb419e5a564d4527df0.jpg",
                                    "caption": "",
                                    "tags": "",
                                    "_id": "5eb53cb119e5a564d4527d8f",
                                    "_metadata": {
                                        "image": {
                                            "type": "image/jpeg",
                                            "name": "5e846625e63ebcc8621cd6af.jpg",
                                            "_id": "5eb53cb419e5a564d4527df0"
                                        }
                                    },
                                    "tempSrc": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8f/5eb53cb419e5a564d4527df0/5eb53cb419e5a564d4527df0-240x240.jpg",
                                    "preview": true
                                }
                            ],
                            "variants": [],
                            "options": [
                                {
                                    "name": "size",
                                    "values": [
                                        "10",
                                        "12",
                                        "14",
                                        "16",
                                        "18",
                                        "6",
                                        "8"
                                    ],
                                    "_id": "5eb55abadc3ba00abb0cb182"
                                }
                            ],
                            "default_variant": null,
                            "approve": "approved",
                            "seller": "5bfbd39c0790f66e158b0be7",
                            "uniquesku": [
                                "8907819282530"
                            ],
                            "weight_updated": true,
                            "media": [],
                            "dimension": {},
                            "SEO": {},
                            "files": [],
                            "_created_by": "530d7f8bc6b8283a11000003",
                            "updated_on": "2020-05-12T06:59:05.272Z",
                            "_updated_by": "530d7f8bc6b8283a11000003",
                            "_metadata": {
                                "i18n": {
                                    "EN": {},
                                    "AR": {}
                                }
                            },
                            "tax": "default",
                            "substore": [],
                            "features": [],
                            "is_catalog": "1",
                            "catalog_only": "1",
                            "option_set": "",
                            "configurable_fields": [
                                "price",
                                "compare_price",
                                "mrp_discount",
                                "sku",
                                "barcode",
                                "weight",
                                "inventory_management",
                                "inventory_allow_out_of_stock",
                                "inventory_quantity",
                                "min_limit_to_buy_this_product",
                                "max_limit_to_buy_this_product",
                                "tag"
                            ],
                            "list_price": 2499,
                            "our_price": 2499,
                            "original_price": 2499
                        },
                        "discount_total": 0,
                        "quantity": 1,
                        "total": 2499,
                        "prices_are": "exclusive",
                        "tax_applied_on": "2499.00",
                        "tax_plus_taxable_amount": "2948.80",
                        "total_tax": 449.8,
                        "total_with_tax": 2948.8
                    }
                ],
                "sub_total": 2499,
                "total": "2948.8000",
                "item_count": 1,
                "status": "open",
                "financial_status": "Pending",
                "balance_amount": "0",
                "delivery_status": null,
                "shipping_status": null,
                "fulfillment_status": null,
                "cart_id": "5eba498e2150fba9a26b5b03",
                "email": "jamesjohn@gmail.com",
                "user_id": "5e1ec5203735093314764ce4",
                "discounts": [],
                "discount_total": 0,
                "discounts_total": 0,
                "shipping_method": {
                    "_id": "aersda@#$32sfas2342",
                    "name": "Shipping charges",
                    "price": 0,
                    "seller": "all_sellers",
                    "prices_are": "exclusive",
                    "taxes": [
                        {
                            "name": "IGST",
                            "taxable_amount": 0,
                            "tax_amount": 0,
                            "tax_type": "exclusive",
                            "rate": 18,
                            "_id": "5d5e9becfad4702e72cc6aaa"
                        }
                    ],
                    "taxes_total": "0.000",
                    "tax_applied_on": "0.00",
                    "tax_plus_taxable_amount": "0.00"
                },
                "shipping_method_name": null,
                "shipping_total": 0,
                "shipping_by_vendor": {
                    "5bfbd39c0790f66e158b0be7": 0
                },
                "currency": {
                    "name": "SGD",
                    "conversion_rate": 1,
                    "decimal_points": 2,
                    "symbol": "$"
                },
                "invoice_number": "",
                "invoice_numbers": [],
                "taxes": [
                    {
                        "name": "IGST",
                        "taxable_amount": 2499,
                        "tax_amount": 449.8,
                        "tax_type": "exclusive",
                        "index": 1,
                        "rate": 18,
                        "channels": {},
                        "enable_taxjar": "0",
                        "_id": "5d5e9becfad4702e72cc6aaa",
                        "prices_are": "exclusive"
                    }
                ],
                "taxes_total": 449.8,
                "gift_cards": [],
                "gift_card_total": 0,
                "ecoupon": {},
                "options": {},
                "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"
                },
                "shipping_address": {
                    "address": "B4-309 Spaze iTech Park, Sector-49, Sohna Road",
                    "city": "Gurgoan",
                    "country": "IN",
                    "full_name": "Testing",
                    "phone": "1234567890",
                    "state": "Harayana",
                    "zip": "122001"
                },
                "additional_charges": [],
                "metafields": {},
                "price_type": "inclusive",
                "channel": "admin",
                "payment_method": {
                    "settings": {}
                },
                "wallets": [],
                "client_details": {
                    "selected_language": "EN"
                },
                "marketplace_channel": {},
                "_id": "5eba498e2150fba9a26b5b33",
                "txn_id": null,
                "created_on": "2020-05-12T07:00:30.570Z",
                "seller": "5bfbd39c0790f66e158b0be7",
                "seller_name": "demo-rohan",
                "seller_email": "rohan.gupta@test.com",
                "seller_details": {
                    "title": "demo-rohan",
                    "status": "approved",
                    "default_seller": "1",
                    "balance": 170223.7378,
                    "role": "seller",
                    "_id": "5bfbd39c0790f66e158b0be7",
                    "images": [],
                    "country": "IN",
                    "bank_details": {},
                    "info": "",
                    "alias": "demo-rohan",
                    "substore": [],
                    "metafields": {},
                    "address": "1080p, 2nd Floor, 12",
                    "city": "Gurgaon",
                    "zip_code": "122011",
                    "state": "Haryana",
                    "user": {
                        "_id": "5bfbd39c0790f66e158b0be7",
                        "first_name": "rohan",
                        "email": "rohan.gupta@test.com",
                        "phone": "+917458778458",
                        "password": "$2b$10$5HcawWJhiL5hLJMRD7jOPeaDYE6UeQ.lKv4lJhvERZ7kh3bkxPGE2",
                        "active": "1",
                        "role": "superadmin",
                        "verified": "0",
                        "child_entity_roles": [
                            "seller"
                        ],
                        "approve_seller": "1",
                        "verified_text": "5bfbd39c0790f66e158b0be6",
                        "mobile_otp": "338693",
                        "verified_time": "1543230364746",
                        "phone_verified": "0",
                        "use_temporary_password": "0",
                        "account": [],
                        "created_on": "2018-11-26T11:06:04.752Z",
                        "_created_by": "530d7f8bc6b8283a11000003",
                        "updated_on": "2020-05-12T06:55:27.569Z",
                        "reset_verified_text": "",
                        "reset_verified_time": 1543230571683,
                        "gender": "",
                        "customer_groups": [],
                        "_updated_by": "5d3848415b82914d861ceb94",
                        "roles": [
                            "seller",
                            "superadmin"
                        ],
                        "balance": -1697879.8845,
                        "client_details": {},
                        "wallets": {}
                    }
                },
                "version": "ms.0.3.0",
                "order_id": "OID1763",
                "notify_customer": "no",
                "notes": [],
                "fulfillments": [],
                "payment_details": {}
            }
        ],
        "notify_customer": "no",
        "payment_status": "paid",
        "notes": [],
        "fulfillments": []
    }
}
GET /api/1.1/entity/ms.orders/_/cancelOrder   
Cancel the order

Examples

Cancel Order

Request
{
orderId:"5eabfcd8ab0c3a3a926c88b0",
reason:"Found Better Product"
}
Response
{
    "fileBaseUrl": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/"
}
GET /api/1.1/entity/ms.orders/_/changeAddress   
This command is use to change the address for an order

Examples

changeAddress

Request
{
                _id: "5d4139af7049f90e335ad9b2",
                shipping_address: {
                    address: 'B-1341, Unitech Park ,Sector -39',
                    city: 'Gurgaon',
                    country: 'IN',
                    full_name: 'Mukesh kumar',
                    phone: '9876545676',
                    state: 'Haryana',
                    zip: '122001'
                }
}
Response
{
    "fileBaseUrl": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/",
    "data": "Order has been updated successfully!!!"
}
GET /api/1.1/entity/ms.orders/{resource_id}   
Fetch a single Order

Examples

Retrieve a Single Order

Request
Response
{
    "fileBaseUrl": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/",
    "data": {
        "_id": "5eba49392150fba9a26b57c1",
        "items": [
            {
                "_id": "5eba49392150fba9a26b57bb",
                "name": "Peach Mandarin Neck Embroidered Kurta",
                "product_id": "5eb53cb119e5a564d4527d8a",
                "product_url": "/product/peach-mandarin-neck-embroidered-kurta",
                "metafields": {
                    "style_code": "20FES10543-213048"
                },
                "seller": "5bfbd39c0790f66e158b0be7",
                "price": "2499",
                "list_price": 2499,
                "quantity": 1,
                "discounts_percentage": "0",
                "discounts_total": "0",
                "discounts": [],
                "taxes": [],
                "taxes_total": 0,
                "shipping_cost": 0,
                "total": 2499,
                "thumbnail_url": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8b/5eb53cb319e5a564d4527de0/5eb53cb319e5a564d4527de0-120x120.jpg",
                "image_url": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8b/5eb53cb319e5a564d4527de0/5eb53cb319e5a564d4527de0-1024x1024.jpg",
                "product": {
                    "_id": "5eb53cb119e5a564d4527d8a",
                    "name": "Peach Mandarin Neck Embroidered Kurta",
                    "alias": "peach-mandarin-neck-embroidered-kurta",
                    "description": "<p>Peach mandarin neck kurta with gold and sequins embroidery detail and placket on the front.</p>",
                    "price": 2499,
                    "compare_price": 2499,
                    "collections": [],
                    "brand": "Wishful",
                    "sku": "8907819282530",
                    "categories": [
                        "kurtas",
                        "topwear"
                    ],
                    "publish": "1",
                    "sort_order": 0,
                    "inventory_management": "none",
                    "inventory_management_level": "variant",
                    "inventory_quantity": 6,
                    "available": 1,
                    "created_on": "2020-05-08T11:04:21.355Z",
                    "metafields": {
                        "style_code": "20FES10543-213048"
                    },
                    "attributes": [
                        {
                            "name": "Color",
                            "value": "Pink",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb183"
                        },
                        {
                            "name": "Neck",
                            "value": "Mandarin",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb184"
                        },
                        {
                            "name": "Sleeve",
                            "value": "3/4 Sleeve",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb185"
                        },
                        {
                            "name": "Occasion",
                            "value": "Festive",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb186"
                        },
                        {
                            "name": "Pattern",
                            "value": "Striped",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb187"
                        },
                        {
                            "name": "Material",
                            "value": "Viscose",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb188"
                        },
                        {
                            "name": "Size",
                            "value": "10",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb189"
                        },
                        {
                            "name": "For Complaints",
                            "value": "Customer Care No 8800698168, customercare@tcnsclothing.com",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb18a"
                        },
                        {
                            "name": "Manufactured & Packed for",
                            "value": "TCNS Clothing Co. Limited",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb18b"
                        },
                        {
                            "name": "Marketed By",
                            "value": "TCNS Clothing Co. Limited",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb18c"
                        },
                        {
                            "name": "Name of Manufacturer",
                            "value": "TCNS LIMITED B-16",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb18d"
                        },
                        {
                            "name": "Place of Manufacturer",
                            "value": "B-16 Sector-58 NOIDA UP-201301",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb18e"
                        },
                        {
                            "name": "Quantity",
                            "value": "1N",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb18f"
                        },
                        {
                            "name": "Registered Office Address",
                            "value": "Unit No 112 F/F Rectangle-1 D-4 Saket, New Delhi DL-110407",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb190"
                        },
                        {
                            "name": "Closure",
                            "value": "No",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb191"
                        },
                        {
                            "name": "FabricContent",
                            "value": "100% Viscose",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb192"
                        },
                        {
                            "name": "Fit",
                            "value": "Regular",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb193"
                        },
                        {
                            "name": "SlitDetail",
                            "value": "Straight",
                            "group": "default",
                            "_id": "5eb55abadc3ba00abb0cb194"
                        }
                    ],
                    "images": [
                        {
                            "image": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8b/5eb53cb319e5a564d4527de0/5eb53cb319e5a564d4527de0.jpg",
                            "caption": "",
                            "tags": "",
                            "_id": "5eb53cb119e5a564d4527d8b",
                            "_metadata": {
                                "image": {
                                    "type": "image/jpeg",
                                    "name": "5e846625e63ebcc8621cd69e.jpg",
                                    "_id": "5eb53cb319e5a564d4527de0"
                                }
                            },
                            "tempSrc": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8b/5eb53cb319e5a564d4527de0/5eb53cb319e5a564d4527de0-240x240.jpg",
                            "preview": true
                        },
                        {
                            "image": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8c/5eb53cb419e5a564d4527dfa/5eb53cb419e5a564d4527dfa.jpg",
                            "caption": "",
                            "tags": "",
                            "_id": "5eb53cb119e5a564d4527d8c",
                            "_metadata": {
                                "image": {
                                    "type": "image/jpeg",
                                    "name": "5e846625e63ebcc8621cd69f.jpg",
                                    "_id": "5eb53cb419e5a564d4527dfa"
                                }
                            },
                            "tempSrc": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8c/5eb53cb419e5a564d4527dfa/5eb53cb419e5a564d4527dfa-240x240.jpg",
                            "preview": true
                        },
                        {
                            "image": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8d/5eb53cb419e5a564d4527de6/5eb53cb419e5a564d4527de6.jpg",
                            "caption": "",
                            "tags": "",
                            "_id": "5eb53cb119e5a564d4527d8d",
                            "_metadata": {
                                "image": {
                                    "type": "image/jpeg",
                                    "name": "5e846625e63ebcc8621cd69d.jpg",
                                    "_id": "5eb53cb419e5a564d4527de6"
                                }
                            },
                            "tempSrc": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8d/5eb53cb419e5a564d4527de6/5eb53cb419e5a564d4527de6-240x240.jpg",
                            "preview": true
                        },
                        {
                            "image": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8e/5eb53cb319e5a564d4527de1/5eb53cb319e5a564d4527de1.jpg",
                            "caption": "",
                            "tags": "",
                            "_id": "5eb53cb119e5a564d4527d8e",
                            "_metadata": {
                                "image": {
                                    "type": "image/jpeg",
                                    "name": "5e846625e63ebcc8621cd69c.jpg",
                                    "_id": "5eb53cb319e5a564d4527de1"
                                }
                            },
                            "tempSrc": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8e/5eb53cb319e5a564d4527de1/5eb53cb319e5a564d4527de1-240x240.jpg",
                            "preview": true
                        },
                        {
                            "image": "ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8f/5eb53cb419e5a564d4527df0/5eb53cb419e5a564d4527df0.jpg",
                            "caption": "",
                            "tags": "",
                            "_id": "5eb53cb119e5a564d4527d8f",
                            "_metadata": {
                                "image": {
                                    "type": "image/jpeg",
                                    "name": "5e846625e63ebcc8621cd6af.jpg",
                                    "_id": "5eb53cb419e5a564d4527df0"
                                }
                            },
                            "tempSrc": "https://cdn.storehippo.com/s/5bfbc96dc68c7d0e02c39253/ms.products/5eb53cb119e5a564d4527d8a/images/5eb53cb119e5a564d4527d8f/5eb53cb419e5a564d4527df0/5eb53cb419e5a564d4527df0-240x240.jpg",
                            "preview": true
                        }
                    ],
                    "variants": [],
                    "options": [
                        {
                            "name": "size",
                            "values": [
                                "10",
                                "12",
                                "14",
                                "16",
                                "18",
                                "6",
                                "8"
                            ],
                            "_id": "5eb55abadc3ba00abb0cb182"
                        }
                    ],
                    "default_variant": null,
                    "approve": "approved",
                    "seller": "5bfbd39c0790f66e158b0be7",
                    "uniquesku": [
                        "8907819282530"
                    ],
                    "weight_updated": true,
                    "media": [],
                    "dimension": {},
                    "SEO": {},
                    "files": [],
                    "_created_by": "530d7f8bc6b8283a11000003",
                    "updated_on": "2020-05-12T06:55:27.441Z",
                    "_updated_by": "5d3848415b82914d861ceb94",
                    "_metadata": {
                        "i18n": {
                            "EN": {},
                            "AR": {}
                        }
                    },
                    "tax": "default",
                    "substore": [],
                    "features": [],
                    "is_catalog": "1",
                    "catalog_only": "1",
                    "option_set": "",
                    "configurable_fields": [
                        "price",
                        "compare_price",
                        "mrp_discount",
                        "sku",
                        "barcode",
                        "weight",
                        "inventory_management",
                        "inventory_allow_out_of_stock",
                        "inventory_quantity",
                        "min_limit_to_buy_this_product",
                        "max_limit_to_buy_this_product",
                        "tag"
                    ],
                    "sellerDetails": {
                        "title": "demo-rohan",
                        "status": "approved",
                        "default_seller": "1",
                        "balance": 170223.7378,
                        "role": "seller",
                        "_id": "5bfbd39c0790f66e158b0be7",
                        "images": [],
                        "country": "IN",
                        "bank_details": {},
                        "info": "",
                        "alias": "demo-rohan",
                        "substore": [],
                        "metafields": {},
                        "address": "1080p, 2nd Floor, 12",
                        "city": "Gurgaon",
                        "zip_code": "122011",
                        "state": "Haryana",
                        "user": {
                            "_id": "5bfbd39c0790f66e158b0be7",
                            "first_name": "rohan",
                            "email": "rohan.gupta@test.com",
                            "phone": "+917458778458",
                            "password": "$2b$10$5HcawWJhiL5hLJMRD7jOPeaDYE6UeQ.lKv4lJhvERZ7kh3bkxPGE2",
                            "active": "1",
                            "role": "superadmin",
                            "verified": "0",
                            "child_entity_roles": [
                                "seller"
                            ],
                            "approve_seller": "1",
                            "verified_text": "5bfbd39c0790f66e158b0be6",
                            "mobile_otp": "338693",
                            "verified_time": "1543230364746",
                            "phone_verified": "0",
                            "use_temporary_password": "0",
                            "account": [],
                            "created_on": "2018-11-26T11:06:04.752Z",
                            "_created_by": "530d7f8bc6b8283a11000003",
                            "updated_on": "2020-05-12T06:55:27.569Z",
                            "reset_verified_text": "",
                            "reset_verified_time": 1543230571683,
                            "gender": "",
                            "customer_groups": [],
                            "_updated_by": "5d3848415b82914d861ceb94",
                            "roles": [
                                "seller",
                                "superadmin"
                            ],
                            "balance": -1697879.8845,
                            "client_details": {},
                            "wallets": {}
                        }
                    },
                    "list_price": 2499,
                    "our_price": 2499,
                    "original_price": 2499
                },
                "total_tax": 0,
                "total_with_tax": 2499
            }
        ],
        "sub_total": 2499,
        "total": 2499,
        "item_count": "1",
        "email": "jamesjohn@gmail.com",
        "user_id": "5e1ec5203735093314764ce4",
        "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"
        },
        "shipping_address": {
            "address": "B-1341, Unitech Park ,Sector -39",
            "city": "Gurgaon",
            "country": "IN",
            "full_name": "John Parker",
            "phone": "9876545676",
            "state": "Haryana",
            "zip": "122001"
        },
        "payment_method": {
            "settings": {}
        },
        "status": "open",
        "financial_status": "Pending",
        "delivery_status": null,
        "shipping_status": null,
        "cart_id": null,
        "discounts": [],
        "discount_total": 0,
        "shipping_method": {},
        "shipping_method_name": null,
        "shipping_total": 0,
        "currency": {},
        "taxes": [],
        "taxes_total": 0,
        "gift_cards": [],
        "gift_card_total": 0,
        "ecoupon": {},
        "options": {},
        "additional_charges": [],
        "metafields": {},
        "price_type": "inclusive",
        "txn_id": null,
        "channel": "user",
        "balance_amount": 0,
        "wallets": [],
        "client_details": {
            "selected_language": "EN"
        },
        "created_on": "2020-05-12T06:59:05.247Z",
        "seller": "5bfbd39c0790f66e158b0be7",
        "seller_name": "demo-rohan",
        "seller_email": "rohan.gupta@test.com",
        "seller_details": {
            "title": "demo-rohan",
            "status": "approved",
            "default_seller": "1",
            "balance": 170223.7378,
            "role": "seller",
            "_id": "5bfbd39c0790f66e158b0be7",
            "images": [],
            "country": "IN",
            "bank_details": {},
            "info": "",
            "alias": "demo-rohan",
            "substore": [],
            "metafields": {},
            "address": "1080p, 2nd Floor, 12",
            "city": "Gurgaon",
            "zip_code": "122011",
            "state": "Haryana",
            "user": {
                "_id": "5bfbd39c0790f66e158b0be7",
                "first_name": "rohan",
                "email": "rohan.gupta@test.com",
                "phone": "+917458778458",
                "password": "$2b$10$5HcawWJhiL5hLJMRD7jOPeaDYE6UeQ.lKv4lJhvERZ7kh3bkxPGE2",
                "active": "1",
                "role": "superadmin",
                "verified": "0",
                "child_entity_roles": [
                    "seller"
                ],
                "approve_seller": "1",
                "verified_text": "5bfbd39c0790f66e158b0be6",
                "mobile_otp": "338693",
                "verified_time": "1543230364746",
                "phone_verified": "0",
                "use_temporary_password": "0",
                "account": [],
                "created_on": "2018-11-26T11:06:04.752Z",
                "_created_by": "530d7f8bc6b8283a11000003",
                "updated_on": "2020-05-12T06:55:27.569Z",
                "reset_verified_text": "",
                "reset_verified_time": 1543230571683,
                "gender": "",
                "customer_groups": [],
                "_updated_by": "5d3848415b82914d861ceb94",
                "roles": [
                    "seller",
                    "superadmin"
                ],
                "balance": -1697879.8845,
                "client_details": {},
                "wallets": {}
            }
        },
        "version": "ms.0.3.0",
        "order_id": "OID1762",
        "notify_customer": "no",
        "fulfillment_status": "pending",
        "notes": [],
        "fulfillments": [],
        "payment_details": {},
        "_created_by": "530d7f8bc6b8283a11000003",
        "updated_on": "2020-05-12T07:17:16.316Z",
        "_updated_by": "530d7f8bc6b8283a11000003"
    }
}
GET /api/1.1/entity/ms.orders   
Retrieves a list of orders

Examples

list orders

Request
Response
{
  "messages": [
    {
      "name": "ms.entity.orders.list",
      "level": "success",
      "key": "ms.entity.orders.list"
    }
  ],
  "data": [
    {
      "_id": "55bef9159cad703e28e43b5e",
      "order_id": "OID221",
      "items": [
        {
          "_id": "55bc94ade2b2ac2728d4e827",
          "name": "Polka Dot Shirt /TSF3447",
          "product_id": "554764ca0553a0bc62500152",
          "product_url": "/product/polka-dot-shirt-tsf3447",
          "metafields": {
            "size": "size_charts/554c73f5a84106ea74fa8de9/554c73e46e5bae4c19946f6c.jpg",
            "size_chart": "size_charts/554c73f5a84106ea74fa8de9/554c73e46e5bae4c19946f6c.jpg"
          },
          "weight": "150",
          "selected_options": {
            "color": "White",
            "size": "L"
          },
          "variant_id": "White|L",
          "vendor": null,
          "price": "399.60",
          "list_price": 999,
          "discounts_percentage": "60.00",
          "discounts_total": "599.40",
          "discounts": [
            {
              "_id": "558a4186eeef6dd956381aab",
              "name": "Sale",
              "saved_amount": 599.4
            }
          ],
          "taxes": [
          ],
          "taxes_total": "0.00",
          "thumbnail_url": "ms.products/554764ca0553a0bc62500152/images/554764ca0553a0bc62500153/5547653b0553a0bc6250029a/5547653b0553a0bc6250029a-100x100.jpg",
          "image_url": "ms.products/554764ca0553a0bc62500152/images/554764ca0553a0bc62500153/5547653b0553a0bc6250029a/5547653b0553a0bc6250029a-1024x1024.jpg",
          "product": {
            "_id": "554764ca0553a0bc62500152",
            "name": "Polka Dot Shirt /TSF3447",
            "description": "Polka Dot Shirt",
            "option_set": "552269717215cce534407341",
            "_metadata": {
              "option_set": {
                "action": "automatic"
              }
            },
            "variants": [
              {
                "price": "999",
                "compare_price": "999",
                "sku": "TSF3447-OFFWHITE-L",
                "weight": "150",
                "inventory_management": "automatic",
                "inventory_quantity": "2",
                "options": [
                  {
                    "name": "color",
                    "value": "White"
                  },
                  {
                    "name": "size",
                    "value": "L"
                  }
                ],
                "variant_id": "White|L",
                "id": 7597
              },
              {
                "price": "999",
                "compare_price": "999",
                "sku": "TSF3447-OFFWHITE-M",
                "weight": "150",
                "inventory_management": "automatic",
                "inventory_quantity": "1",
                "options": [
                  {
                    "name": "color",
                    "value": "White"
                  },
                  {
                    "name": "size",
                    "value": "M"
                  }
                ],
                "variant_id": "White|M",
                "id": 29395
              },
              {
                "price": "999",
                "compare_price": "999",
                "sku": "TSF3447-OFFWHITE-S",
                "weight": "150",
                "inventory_management": "automatic",
                "inventory_quantity": "0",
                "options": [
                  {
                    "name": "color",
                    "value": "White"
                  },
                  {
                    "name": "size",
                    "value": "S"
                  }
                ],
                "variant_id": "White|S",
                "id": 61568
              },
              {
                "price": "999",
                "compare_price": "999",
                "sku": "TSF3447-OFFWHITE-XL",
                "weight": "150",
                "inventory_management": "automatic",
                "inventory_quantity": "2",
                "options": [
                  {
                    "name": "color",
                    "value": "White"
                  },
                  {
                    "name": "size",
                    "value": "XL"
                  }
                ],
                "variant_id": "White|XL",
                "id": 86974
              }
            ],
            "price": "999.00",
            "compare_price": "999.00",
            "collections": [
              "ss15"
            ],
            "brand": "THE VANCA",
            "sku": "TSF3447-OFFWHITE-L",
            "inventory_quantity": "2",
            "weight": "150",
            "categories": [
              "women",
              "topwear",
              "tops",
              "sale-2",
              "polka-collection"
            ],
            "publish": "1",
            "images": [
              {
                "image": "ms.products/554764ca0553a0bc62500152/images/554764ca0553a0bc62500153/5547653b0553a0bc6250029a/5547653b0553a0bc6250029a.jpg",
                "caption": "",
                "tags": "",
                "_id": "554764ca0553a0bc62500153",
                "_metadata": {
                  "image": {
                    "_id": "5547653b0553a0bc6250029a",
                    "name": "tsf34471.jpg.524233cc75.999xx.jpg",
                    "size": null,
                    "type": "image/jpeg"
                  }
                }
              },
              {
                "image": "ms.products/554764ca0553a0bc62500152/images/554764ca0553a0bc62500154/554765380553a0bc62500294/554765380553a0bc62500294.jpg",
                "caption": "",
                "tags": "",
                "_id": "554764ca0553a0bc62500154",
                "_metadata": {
                  "image": {
                    "_id": "554765380553a0bc62500294",
                    "name": "tsf34474.jpg.fd15ebc821.999xx.jpg",
                    "size": null,
                    "type": "image/jpeg"
                  }
                }
              },
              {
                "image": "ms.products/554764ca0553a0bc62500152/images/554764ca0553a0bc62500155/554765390553a0bc62500297/554765390553a0bc62500297.jpg",
                "caption": "",
                "tags": "",
                "_id": "554764ca0553a0bc62500155",
                "_metadata": {
                  "image": {
                    "_id": "554765390553a0bc62500297",
                    "name": "tsf34472.jpg.70f35b1f56.999xx.jpg",
                    "size": null,
                    "type": "image/jpeg"
                  }
                }
              },
              {
                "image": "ms.products/554764ca0553a0bc62500152/images/554764ca0553a0bc62500156/554765390553a0bc62500296/554765390553a0bc62500296.jpg",
                "caption": "",
                "tags": "",
                "_id": "554764ca0553a0bc62500156",
                "_metadata": {
                  "image": {
                    "_id": "554765390553a0bc62500296",
                    "name": "tsf34473.jpg.922dc3f85b.999xx.jpg",
                    "size": null,
                    "type": "image/jpeg"
                  }
                }
              }
            ],
            "attributes": [
              {
                "name": "fabric",
                "value": "Georgette ",
                "group": "default",
                "_id": "55bb8a43047d13de561d4c85"
              },
              {
                "name": "collar",
                "value": "Collar Neck",
                "group": "default",
                "_id": "55bb8a43047d13de561d4c86"
              },
              {
                "name": "sleeve",
                "value": "Long Sleeve",
                "group": "default",
                "_id": "55bb8a43047d13de561d4c87"
              },
              {
                "name": "Fit",
                "value": "Regular Fit",
                "group": "default",
                "_id": "55bb8a43047d13de561d4c88"
              },
              {
                "name": "_brand",
                "value": "THE VANCA",
                "_id": "55bb8a43047d13de561d4c89"
              }
            ],
            "SEO": {
              "title": "Polka Dot Shirt"
            },
            "product_has_multiple_variants": "1",
            "inventory_management": "automatic",
            "inventory_low_stock_quantity": "5",
            "alias": "polka-dot-shirt-tsf3447",
            "sort_order": 22,
            "created_on": "2015-05-04T12:32:57.679Z",
            "updated_on": "2015-07-31T14:46:27.121Z",
            "metafields": {
              "size": "size_charts/554c73f5a84106ea74fa8de9/554c73e46e5bae4c19946f6c.jpg",
              "size_chart": "size_charts/554c73f5a84106ea74fa8de9/554c73e46e5bae4c19946f6c.jpg"
            },
            "inventory_management_level": "variant",
            "available": 1,
            "_updated_by": "55018ee9b8f738e77f9fd195",
            "options": [
              {
                "name": "color",
                "value": "White"
              },
              {
                "name": "size",
                "value": "L"
              }
            ],
            "default_variant": {
              "price": "999",
              "compare_price": "999",
              "sku": "TSF3447-OFFWHITE-L",
              "weight": "150",
              "inventory_management": "automatic",
              "inventory_quantity": "2",
              "options": [
                {
                  "name": "color",
                  "value": "White"
                },
                {
                  "name": "size",
                  "value": "L"
                }
              ],
              "variant_id": "White|L",
              "id": 7597
            },
            "dimension": {
            },
            "features": [
            ],
            "variant_id": "White|L",
            "id": 7597,
            "list_price": "999",
            "our_price": 999,
            "original_price": "999"
          },
          "discount_total": "599.40",
          "quantity": 1,
          "sub_total": "999.00",
          "total": "399.60"
        }
      ],
      "sub_total": "399.60",
      "total": 448.6,
      "item_count": 1,
      "status": "open",
      "financial_status": "Paid",
      "delivery_status": null,
      "shipping_status": "Ready to ship",
      "cart_id": "55bc92039cad703e28e40ff7",
      "email": "charmingme.s@gmail.com",
      "user_id": null,
      "discounts": [
      ],
      "discount_total": 0,
      "discounts_total": 0,
      "shipping_method": {
        "_id": "555065f48d3b90e43b45ec40",
        "name": "Delivery Charges",
        "price": 49,
        "discounts_total": 0,
        "discounts_percentage": 0
      },
      "shipping_method_name": "Delivery Charges",
      "shipping_total": "49.00",
      "currency": {
        "name": "INR",
        "conversion_rate": "1"
      },
      "taxes": [
      ],
      "taxes_total": "0.00",
      "gift_cards": [
      ],
      "gift_card_total": "0.00",
      "ecoupon": {
      },
      "options": {
      },
      "billing_address": {
        "country": "IN",
        "full_name": "Sreya Ray",
        "address": "No 33 and 33/1 Krishna Reddy Colony,Domlur Layout",
        "city": "Bangalore",
        "state": "Karnataka",
        "zip": "560071",
        "phone": "7259004793"
      },
      "shipping_address": {
        "country": "IN",
        "full_name": "Sreya Ray",
        "address": "No 33 and 33/1 Krishna Reddy Colony,Domlur Layout",
        "city": "Bangalore",
        "state": "Karnataka",
        "zip": "560071",
        "phone": "7259004793"
      },
      "additional_charges": [
      ],
      "metafields": {
      },
      "price_type": "inclusive",
      "txn_id": "vPBCEX853",
      "channel": "user",
      "payment_method": {
        "type": "payment_gateways",
        "enabled": "1",
        "settings": {
          "gateways": [
            {
              "id": 42071,
              "gateway": "ccavenue",
              "gateway_options": {
                "key": "tzese3kh3cwkz4k9mu48cdeo2bwfngg2",
                "merchantid": "M_raj20967_20967"
              }
            }
          ],
          "gateway": "ccavenue"
        },
        "name": "Online Payment",
        "_id": "5433c08a8d72182379836d04",
        "image": "ms.settings/5256837ccc4abf1d39000001/551e517c838b165e08011f7d.gif",
        "_metadata": {
          "image": {
            "_id": "551e517c838b165e08011f7d",
            "name": "ccavenue_logo.gif",
            "size": 3162,
            "type": "image/gif"
          }
        }
      },
      "balance_amount": 0,
      "wallets": [
      ],
      "invoice_number": null,
      "client_details": {
        "appCodeName": "Mozilla",
        "appName": "Netscape",
        "appVersion": "5.0 (Windows NT 5.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.125 Safari/537.36",
        "platform": "Win32",
        "cookieEnabled": true,
        "languages": [
          "en-US",
          "en"
        ],
        "device": "WEB"
      },
      "version": "ms.0.3.0",
      "created_on": "2015-08-03T05:16:05.021Z",
      "updated_on": "2015-08-03T09:43:08.162Z",
      "fulfillments": [
        {
          "tracking_number": "781082161340",
          "tracking_company": "shippo- FEDEX",
          "service": "FEDEX_EXPRESS_SAVER",
          "method": "regular",
          "price": "68.40",
          "status": "Ready to ship",
          "_id": "55bf37ac7325c0f42e19b750"
        }
      ],
      "shipping_label": "//cdn.storehippo.com/s/54f3fe54e8e5022a0edeebda/ms.shipping/55bf37aa7325c0f42e19b747_shipping.pdf",
      "PickupConfirmationNumber": "131",
      "Location": "DAEA",
      "_updated_by": "55018ee9b8f738e77f9fd195",
      "_resolvedData": {
        "_updated_by": {
          "_id": "55018ee9b8f738e77f9fd195",
          "email": "rajeev@thevanca.com",
          "sort_order": 35
        }
      }
    }
  ],
  "paging": {
    "total": 47,
    "count": 1,
    "limit": 1,
    "start": 0
  }
}