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

Related Topics

Understanding Themes Global Objects Global Widgets Startup Scripts

Global 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.products

Fulfillments

(ms.fulfillments)

{...} swagger

Fulfillments allow the user to split an order into multiple fulfillments to ship different items (and their varying quantity) independently.

Fields

Value Description
order_id
Type: string
 The record id of the associated orders.
items
Type: array
 Array of objects containing the details of items in the order.
items._id
Type: string
 Unique handler of product.
items.sku
Type: string
 Unique SKU (Stock Keeping Unit) of the Product.
items.quantity
Type: string
 Quantity of product item.
item_count
Type: number
 Total number of items in the fulfillment.
sub_total
Type: number
 Sub total amount of the fulfillment.
shipping_charge
Type: number
 Shipping charges applied to the fulfillment.
additional_charge
Type: number
 Additional charges applied to the fulfillment.
total
Type: number
 Total amount of the fulfillment.
status
Type: string
 Status of the fulfillment.
Example:

Pending, Shipped, Fulfilled or Cancelled
tracking_number
Type: string
 Tracking number of the shipment associated with the fulfillment.
tracking_status
Type: string
 Tracking status of a fulfillment in case it has been shipped, marked as delivered.
shipment_id
Type: string
 Record id of the shipment associated with the fulfillment (if any).
shipping_label
Type: string
 Link to shipping label of the shipment.
manifest
Type: string
 Link to manifest of the shipment.
fid
Type: string
 The id of the fulfillment.
Example:

 OID123-F1
type
Type: string
 Type of fulfillment. It can be cod or regular.
tracking_company
Type: string
 Logistics provider used to ship the fulfillment.
price
Type: string
 Logistics charges applied.
oid
Type: string
 OID of the associated order.

Commands

Name Routes
add post  /api/1/entity/ms.fulfillments TRY IT !
list get  /api/1/entity/ms.fulfillments TRY IT !
ship put  /api/1/entity/ms.fuflillments/{_id}/_/ship TRY IT !
markAsShipped put  /api/1/entity/ms.fuflillments/{_id}/_/markAsShipped TRY IT !
markAsDelivered put  /api/1/entity/ms.fulfillments/{_id}/_/markAsDelivered TRY IT !
cancel put  /api/1/entity/ms.fuflillments/{_id}/_/cancel TRY IT !