Helpcenter +918010117117 https://help.storehippo.com/s/573db3149f0d58741f0cc63b/ms.settings/5256837ccc4abf1d39000001/57614ef64256dc6851749879-480x480.png" [email protected] https://www.facebook.com/StoreHippohttps://twitter.com/StoreHippohttps://www.linkedin.com/company/hippoinnovations/https://plus.google.com/+Storehippo/posts
B4,309-10 Spaze iTech Park, Sector 49, Sohna Road, 122001 Gurgaon India
Create a Trial Store StoreHippo.com Contact Us
- Email:
[email protected]
Phone:
+918010117117
Related Topics
Understanding Themes Global Objects Global Widgets Startup ScriptsGlobal Entities
ms.email_logs ms.mailing_lists ms.invoices Overview ms.reviews ms.fulfillment ms.fulfillments ms.languages ms.coupon_codes ms.redirects ms.store_ledger ms.collections ms.enquiries ms.navigations ms.discounts_new ms.brands ms.notifications ms.ssl_certificates ms.domains ms.store_locations ms.categories ms.blogs ms.sellers ms.pages ms.orders ms.carts ms.users ms.productsOrders
(ms.orders)
Orders section lets you to manage your orders, process the shipment, manage returns and refunds.
Fields
| Value | 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: | ||||||||||||||||||||||||||||||
| 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:
| ||||||||||||||||||||||||||||||
| client_details Type: object Read Only | This object contain the detail of client system . These details is gathered for navigator object of javascript . Example: | ||||||||||||||||||||||||||||||
| 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_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:
| ||||||||||||||||||||||||||||||
| ecoupon Type: object Read Only | This is a deprecated object contain the coupon code and discount associated with it. Example:
| ||||||||||||||||||||||||||||||
| email Type: string | This field contain email id of customer. Example: | ||||||||||||||||||||||||||||||
| 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 | ||||||||||||||||||||||||||||||
| items Type: array | It is an array of object which stores details of product in cart. Example:
| ||||||||||||||||||||||||||||||
| 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:
| ||||||||||||||||||||||||||||||
| shipping_address Type: object Required | This field holds address at which order is to be shipped. Example:
| ||||||||||||||||||||||||||||||
| 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:
| ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| taxes Type: array | Array of taxes applicable on the order. Example:
| ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| fulfillment_status Type: string |
Commands
| Name | Routes |
|---|---|
| add | post /api/1/entity/ms.orders TRY IT ! |
| list | get /api/1/entity/ms.orders TRY IT ! |
| get | get /api/1/entity/ms.orders/{_id} TRY IT ! |
| delete | delete /api/1/entity/ms.orders/{_id} TRY IT ! |
| resendEmail | get /api/1/entity/ms.orders/{_id}/_/resendEmail TRY IT ! |
| additionalInfo | put /api/1/entity/ms.orders/{_id}/_/additionalInfo TRY IT ! |
| cancelOrder | put /api/1/entity/ms.orders/_/cancelOrder TRY IT ! |
| exportOrderTally | put /api/1/entity/ms.orders/_/exportOrderTally TRY IT ! |
| markAsShipped | put /api/1/entity/ms.orders/_/markAsShipped TRY IT ! |
| changeAddress | put /api/1/entity/ms.orders/_/changeAddress TRY IT ! |
| addTransactions | put /api/1/entity/ms.orders/_/addTransactions TRY IT ! |