Helpcenter +918010117117 https://cdn.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

Fulfillment

(ms.fulfillment)

{...} swagger

Fields

ValueDescription
orderDetails
Type: object
This field stores order details of the requested order.
Example: 
{
    "orderDetail": {
      "_id": "254656887dfdgdtrts56",
      "items": [
        {
          "name": "test description",
          "weight": "500",
          "price": "200",
          "product": {
            "name": "test description",
            "description": "test description",
            "price": "200"
          },
          "quantity": "2",
          "total": "200"
        }
      ],
      "sub_total": "200",
      "total": "200",
      "item_count": 2,
      "financial_status": "Paid",
      "email": "[email protected]",
      "shipping_address": {
        "country": "AL",
        "phone": "09999999999",
        "type": "delivery_address",
        "full_name": "Full Name",
        "country_name": "Albania",
        "_id": "59a047e3728d492a3a6aa9a3",
        "address": "check",
        "zip": "383430",
        "state": "Elbasan",
        "email": "[email protected]",
        "created_on": "2017-08-25T15:53:07.968Z",
        "title": "Full Name",
        "city": "test"
      },
      "seller_details": {
        "gstin": "QGWSW254RG3RG34",
        "tin": "AFD3RGRGRRE"
      },
      "order_id": "OID233",
      "billing_address": {
        "country": "AL",
        "phone": "09999999999",
        "type": "delivery_address",
        "full_name": "Full Name",
        "country_name": "Albania",
        "_id": "59a047e3728d492a3a6aa9a3",
        "address": "check",
        "state": "Elbasan",
        "email": "[email protected]",
        "created_on": "2017-08-25T15:53:07.968Z",
        "title": "Full Name",
        "zip_code": "383430",
        "city": "test"
      }
    },
    "pickupAddress": {
      "country": "AL",
      "save_address": false,
      "phone": "09999999999",
      "city": "test",
      "type": "delivery_address",
      "full_name": "Full Name",
      "country_name": "Albania",
      "_id": "59a047e3728d492a3a6aa9a3",
      "address": "check",
      "zip": "383430",
      "state": "Elbasan",
      "email": "[email protected]",
      "created_on": "2017-08-25T15:53:07.968Z",
      "title": "Full Name",
      "zip_code": "383430"
    },
    "selected_date": {
      "readyPickup": "2017-11-17",
      "cutofftime": "1:00:00"
    },
    "selected_time": "11:00",
    "package_weight": 2125,
    "service": "delhivery",
    "package_dimensions": {
      "length": 23,
      "breadth": 22,
      "height": 21
    },
    "cod": 0,
    "other_details": {
      "weight": "500",
      "volumetric_weight": 2125.2
    }
  }
orderDetails.billing_address
Type: object
This field holds address associated with your credit card.
Example:
"billing_address": {
      "country": "AL",
      "phone": "09999999999",
      "type": "delivery_address",
      "full_name": "Full Name",
      "country_name": "Albania",
      "_id": "59a047e3728d492a3a6aa9a3",
      "address": "check",
      "state": "Elbasan",
      "email": "[email protected]",
      "created_on": "2017-08-25T15:53:07.968Z",
      "title": "Full Name",
      "zip_code": "383430",
      "city": "test"
    }
orderDetails.shipping_address
Type: object
This field holds the address where you want your items to be delivered.
Example:
"shipping_address": {
      "country": "AL",
      "phone": "09999999999",
      "type": "delivery_address",
      "full_name": "Full Name",
      "country_name": "Albania",
      "_id": "59a047e3728d492a3a6aa9a3",
      "address": "check",
      "zip": "383430",
      "state": "Elbasan",
      "email": "[email protected]",
      "created_on": "2017-08-25T15:53:07.968Z",
      "title": "Full Name",
      "city": "test"
    }
shipping_method
Type: string
This field holds name of shipping method used for shipping.
Example:

shippo 

cod
Type: string
It is a boolean field expanded as Cash On Delivery.
Example:

true

level
Type: string
Choose level1 or level2 for fulfillment method.
Example:

level1

pincode
Type: string
This field holds pin code of the city where you want your order to be delivered.
Example:

122001

provider_name
Type: string
This field holds name of the shipping service provider.
Example:

aramex

pickupAddress
Type: object
This field holds address from where pickup of items will be done.
Example: 
"pickupAddress": {
    "country": "AL",
    "save_address": false,
    "phone": "09999999999",
    "city": "test",
    "type": "delivery_address",
    "full_name": "Full Name",
    "country_name": "Albania",
    "_id": "59a047e3728d492a3a6aa9a3",
    "address": "check",
    "zip": "383430",
    "state": "Elbasan",
    "email": "[email protected]",
    "created_on": "2017-08-25T15:53:07.968Z",
    "title": "Full Name",
    "zip_code": "383430"
  }
pickupAddress.zip_code
Type: string
This field holds zip code for the city.
Example:

122001

method
Type: string
Name of fulfillment methods used.
Example:

dtdc

selected_service
Type: object
Details of selected fulfillment service and rate.
Example: 
"selected_service": {
    "name": "DTDC_Express",
    "rate": "151.08",
    "title": "DTDC_Express",
    "method": "cod"
  }
selected_date
Type: object
Selected date to schedule pickup.
Example: 
"selected_date": {
    "readyPickup": "2016-09-19",
    "cutofftime": "6:00:00"
  }
selected_time
Type: string
Selected time to schedule pickup.
Example: 
"selected_time": "16:00"
tracking_number
Type: number
Read Only
This is a unique handler used for tracking the shipment.
Example: 
42225048666
tracking_status
Type: string
This field stores the status of the shipment.
Example: 
Pickup Cancelled
tracking_data
Type: array
This field contains details about overall stages a shipment has undergone.
Example: 
"tracking_data":[
    {
      "date": "2016-09-17T18:06:00",
      "description": "Pickup Cancelled",
      "location": "Gurgaon, India",
      "comment": ""
    },
    {
      "date": "2016-09-17T15:49:00",
      "description": "Pickup Scheduled",
      "location": "Gurgaon, India",
      "comment": ""
    },
    {
      "date": "2016-09-16T16:09:00",
      "description": "Record created.",
      "location": "Gurgaon, India",
      "comment": ""
    }
  ]
tracking_data.date
Type: string
Date of the shipment stage.
tracking_data.description
Type: string
Brief description about the stage of shipment.

Commands

NameRoutes
getNotificationsget  /api/1/entity/ms.fulfillment/_/getNotifications TRY IT !
getMethodsget  /api/1/entity/ms.fulfillment/_/getMethods TRY IT !
checkPickupAvailabilityget  /api/1/entity/ms.fulfillment/_/checkPickupAvailability TRY IT !
createPickuppost  /api/1/entity/ms.fulfillment/_/createPickup TRY IT !
checkDeliveryAvailability  /api/1/entity/ms.fulfillment/_/checkDeliveryAvailability TRY IT !
trackShipment  /api/1/entity/ms.fulfillment/_/trackShipment TRY IT !
getRatesget  /api/1/entity/ms.fulfillment/_/getRates TRY IT !