<img src="abc.png" />
    
call to replace anchor tags contains '/admin' in href

Custom Logistics Provider End Points (Preview)

StoreHippo/ShipKaro allow logistics providers to offer their services to ShipKaro customers through standardized REST APIs. The logistics provider will need to specify the endpoints that accept the request in the given format and returns the response. This document covers the different support endpoints, the authentication method and request/response format for those endpoints.

Authentication

The endpoints should support basic HTTP authentication. 

Get Rates EndPoint

Request

{
    "address_to": {
        "name": "Mr Hippo",
        "street1": "309 Spaze iTech Park, Sec 49",
        "city": "Gurugram",
        "state": "HR",
        "zip": "122001",
        "country": "IN",
        "phone": "1234567890",
        "email": "mrhippo@shipkaro.com"
    },
    "address_from": {
        "name": "Mrs Hippo",
        "street1": "512 Barton Center, M. G. Road",
        "city": "Bengaluru",
        "state": "KA",
        "zip": "56080",
        "country": "IN",
        "phone": "1234567890",
        "email": "mrshippo@shipkaro.com"
    },
    "payment_mode ": "cod|prepaid",
    "parcels": [{
        "length": "10",
        "width": "15",
        "height": "10",
        "length_unit": "cm",
        "weight": "1",
        "weight_unit": "lb",
        "Order_id": "OID-123",
        "description": "Some details about the shipment",
        "Invoice_value": "1000"
    }]
}

Response

[
    {
        "provider": "ATO Express",
        "service_id": 'ato_overnight',
        "service_name": 'ATO Express Next Day Delivery',
        "logo_image": "http://atoexpress.in/logo.png",
        "amount": "32",
        "currency": "INR",
        "estimated_days": 1,
        "duration_terms": "Delivery within 1 day",
        "zone": "1",
        "messages": [],
        "test": "1"
    },
    {
        "provider": "ATO Express",
        "service_id": 'ato_priority',
        "service_name": 'ATO Express 2 Day Delivery',
        "logo_image": "http://atoexpress.in/logo.png",
        "amount": "32",
        "currency": "INR",
        "estimated_days": 2,
        "duration_terms": "Delivery within 2 days",
        "zone": "1",
        "messages": [],
        "test": "1"
    }
]

Create Shipment EndPoint

Request

{
    "address_to": {
        "name": "Mr Hippo",
        "street1": "309 Spaze iTech Park, Sec 49",
        "city": "Gurugram",
        "state": "HR",
        "zip": "122001",
        "country": "IN",
        "phone": "1234567890",
        "email": "mrhippo@shipkaro.com"
    },
    "address_from": {
        "name": "Mrs Hippo",
        "street1": "512 Barton Center, M. G. Road",
        "city": "Bengaluru",
        "state": "KA",
        "zip": "56080",
        "country": "IN",
        "phone": "1234567890",
        "email": "mrshippo@shipkaro.com"
    },
    "payment_mode ": "cod|prepaid",
    "parcels": [{
        "length": "10",
        "width": "15",
        "height": "10",
        "length_unit": "cm",
        "weight": "1",
        "weight_unit": "lb",
        "Order_id": "OID-123",
        "description": "Some details about the shipment",
        "Invoice_value": "1000"
    }],
    "service_id": "ato_overnight",
    "additional_info": ""
}

Response

{
    "status": "SUCCESS",
    "tracking_number": "AWBNUMBER",
    "label_url": "<url for the shipping label>",
    "tracking_url": "<url for tracking the shipment>",
    "rate":
        {
            "provider": "ATO Express",
            "service_id": "ato_overnight",
            "service_name": 'ATO Express Next Day Delivery',
            "amount": "32",
            "currency": "INR",

        },
    "estimated_days": 1,
    "duration_terms": "Delivery within 1 day",
    "zone": "1",
    "messages": [],
    "test": "1"
}