Introduction

Overview How to call Authentication Request Response Pagination Filtering Sorting

API Reference

Fulfillment

(ms.fulfillment)

fulfillment

Fields
EndPoints

Fields

ValueDescription
method   
Type: string
Name of fulfillment methods used.
"method": "Fedex"
orderDetail   
Type: object
This field stores order details of the requested order.
{
    "items": [{
    	"name": "JETSET",
      	"price": 123,
      	"product": {"name": "JETSET", "description": "JETSET", "price": 123},
      	"description": "JETSET",
      	"name": "JETSET",
      	"price": 100,
      	"quantity": 1,
      	"total": 100,
      	"weight": 250
    }],
    "shipping_address": {
    	"address": "Spaze iTech park",
    	"city": "Gurugram",
    	"country": "IN",
    	"email": "test@gmail.com",
    	"full_name": "Maha Dev",
    	"phone": "+919898989898",
    	"state": "Haryana",
    	"zip": "122018",
    	"zip_code": "122018"
    }
}
items
Type: array
This field stores details of items.
[{
	"name": "JETSET",
    "price": 123,
    "product": {
    	"name": "JETSET",
      	"description": "JETSET",
      	"price": 123
    },
    "description": "JETSET",
    "name": "JETSET",
    "price": 100,
    "quantity": 1,
    "total": 100,
    "weight": 250
}]
shipping_address
Type: object
This field holds shipping address of the user.
{
	"address": "Spaze iTech park",
    "city": "Gurugram",
    "country": "IN",
    "email": "test@gmail.com",
    "full_name": "Maha Dev",
    "phone": "+919898989898",
    "state": "Haryana",
    "zip": "122018",
    "zip_code": "122018"
}
pickupAddress   
Type: object
This field holds address from where pickup of items will be done.
{
  "country": "IN",
  "phone": "+918826611834",
  "title": "demo-rohan",
  "address": "Sector 49",
  "city": "Jaipur",
  "state": "Rajasthan",
  "zip_code": "302005",
  "email": "testing@test.com",
  "country_name": "India"
}
country
Type: string
This field holds ISO code for the country.
"country": "IN"
phone
Type: string
This field holds phone number of the seller.
"phone": "+918826611834"
title
Type: string
This field holds the name of the store.
"title": "storehippo"
address
Type: string
This field holds address from where pickup of items will be done.
"address": "Sector 49, Sohna Road"
city
Type: string
This field holds city name from where pickup of items will be done.
"city": "Jaipur"
state
Type: string
This field holds state name from where pickup of items will be done.
"state": "Rajasthan"
zip_code
Type: string
This field holds zip code for the city.
"pickupAddress": {
	"zip_code": "302005"  
}
email
Type: string
This field holds email-ID from where pickup of items will be done.
"email": "testing@test.com"
country_name
Type: string
This field holds country name from where pickup of items will be done.
"country_name": "India"

Commands (Endpoints)

POST /api/1.1/entity/ms.fulfillment   
Creates a new fulfillment
DEL /api/1.1/entity/ms.fulfillment/{resource_id}   
Deletes a fulfillment
PUT /api/1.1/entity/ms.fulfillment/{resource_id}   
Updates an existing fulfillment
GET /api/1.1/entity/ms.fulfillment/{resource_id}   
Retrieves a single fulfillment
GET /api/1.1/entity/ms.fulfillment/_/getMethods   
This command is used to get the list of all providers.
GET /api/1.1/entity/ms.fulfillment/_/getRates   
This command is used to fetches the shipping rates of providers.

Examples

getRates

Request
{
  "data": {
    "method": "FedEx",
    "orderDetail": {
        "items": [{
        	"name": "JETSET",
            "price": 123,
            "product": {"name": "JETSET", "description": "JETSET", "price": 123},
            "description": "JETSET",
            "name": "JETSET",
            "price": 100,
            "quantity": 1,
            "total": 100,
            "weight": 250
         }],
         "shipping_address": {
         	"address": "Spaze iTech park",
            "city": "Gurgoan",
            "country": "IN",
            "email": "test@gmail.com",
            "full_name": "test12",
            "phone": "+919898989898",
            "state": "Haryana",
            "zip": "122018",
            "zip_code": "122018"
          }
    },
    "pickupAddress": {
    	"country": "IN",
        "phone": "+918826611834",
        "title": "demo-rohan",
        "address": "Sector 49",
        "city": "Jaipur",
        "state": "Rajasthan",
        "zip_code": "302005",
        "email": "testing@test.com",
        "country_name": "India"
     }
  }
}
Response
{
  data: 
   [ { name: 'FedEx',
       title: 'FedEx - FEDEX_EXPRESS_SAVER-SURFACE',
       logo: '//cdn.storehippo.com/s/53ad1eabbf5aae5a71b2f795/ms.logistics_integrations/59b7d0f6c6ab9523222b34c1/59ba1bb3a155a17124d1b7fd.png',
       service: 'FEDEX_EXPRESS_SAVER-surface',
       surface: '1',
       zone: 'D',
       eta: '6',
       method: 'regular',
       rate: '86.75',
       details: [Object],
       shippo: '0',
       shipkaro_index: 4 },
     { name: 'Delhivery',
       title: 'Delhivery',
       logo: '//cdn.storehippo.com/s/53ad1eabbf5aae5a71b2f795/ms.logistics_integrations/59b7d979430afc63230be690/59ba1c13a155a17124d1b85b.png',
       service: 'delhivery',
       surface: '0',
       zone: 'D',
       eta: '4',
       method: 'regular',
       rate: 65,
       details: [Object],
       shippo: '0',
       shipkaro_index: 4 } ]
}
GET /api/1.1/entity/ms.fulfillment   
Retrieves a list of fulfillment
GET /api/1.1/entity/ms.fulfillment/_/trackShipment   
This command is used to track the shipment of provider.
tracking_number
shipped_by

Examples

trackShipment

Request
{
  "data": {
    "shipped_by": "ato",
    "tracking_number": "00000000033"
  }
}
Response
{
  data: 
   { data: 
      { AwbNo: '00000000033',
        BookingDate: '9/10/2018 12:00:00 AM',
        Mode: 'AIR',
        PackageType: 'ND',
        Destination: 'KOLKATA',
        Status: 'Shipment Delivered',
        TrackingHistory: [Array],
        Message: null,
        Consignee: 'TEST',
        Place: 'TEST LINE 1',
        RCDate: '',
        RCName: '',
        Packages: '1' },
     shipped_by: 'ATO',
     tracking_status: 'Shipment Delivered',
     tracking_data: [ [Object] ] }
}