0% found this document useful (0 votes)
448 views56 pages

Ekart B2C API Document - NonLarge - New - V1

Uploaded by

Gaurav Singh
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
448 views56 pages

Ekart B2C API Document - NonLarge - New - V1

Uploaded by

Gaurav Singh
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 56

‭Ekart B2C API Documentation‬

‭1. Create Shipment API‬


‭1.1 Forward‬
‭Input Parameters‬
‭Sample Request Payload‬
‭Sample Response Payload‬
‭1.2 Reverse‬
‭Input Parameters‬
‭Sample Request Payload‬
‭Sample Response Payload‬
‭hsPro1.2.1 Smart Checks‬
‭Input Parameters‬
‭Sample Request Payload‬
‭1.3 HandInHand(HIH) Services‬
‭Description‬
‭Sample Request Payload Prexo/REPLACEMENT‬
‭Sample Response Payload‬

‭2. Track Shipment API‬


‭Sample Request Payload‬
‭Sample Response Payload‬

‭3. Serviceability and SLA API‬


‭3.1 Forward‬
‭Input Parameters‬
‭Sample Request Payload‬
‭Sample Response Payload‬
‭3.2 Reverse‬
‭Input Parameters‬
‭Sample Request Payload‬
‭Sample Response Payload‬
‭3.3 Prexo/Replacement‬
‭Input Parameters‬
‭Sample Request Payload‬
‭Sample Response Payload‬

‭Failure‬

‭4. Critical Updates Integration‬


‭Sample Push Update Payload‬
‭Slotted update (in case of large slotted delivery)‬

‭4. Cancel/RTO API‬


‭Sample Request Payload‬
‭Sample Response Payload‬
‭5.‬‭Cancel RVP API‬
‭Sample Request Payload‬
‭Sample Response Payload‬

‭6‬‭. Update Shipment API‬


‭6‭.‬1 Update Dispatch_Date‬
‭Sample Request Payload‬
‭Sample Response Payload‬
‭6.2 RFR, Update Customer Contact, Update Customer Address‬
‭7‬‭. Auth API‬

‭Auth API‬
‭This allows the client to get a bearer token which will be used to authenticate all the other APIs.‬

‭ tage API URL -‬‭https://staging.ekartlogistics.com/auth/token‬


S
‭Production API URL -‬‭https://api.ekartlogistics.com/auth/token‬

‭ ttp Method Type -POST‬


H
‭Headers-‬
‭●‬ ‭Content-Type : application/json‬
‭●‬ ‭HTTP_X_MERCHANT_‬
‭●‬ ‭COD‬‭E : (As shared by Ekart Team)‬
‭●‬ ‭Authorization : (As shared by Ekart Team)‬
‭●‬ ‭This API will use Basic Auth mode. All the other APIs will follow Bearer Authentication.‬

‭Sample Response Body:‬

‭ uccess‬
S
‭{‬
‭"Authorization": "Bearer‬
‭eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJla2wtZHVyaW4tc3RhZ2UiLCJhdWQiOiJ7XCJtZXJjaG‬
‭FudFwiOlwiTVlOXCJ9IiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInVzZXIucHJv‬
‭ZmlsZSJdLCJpc3MiOiJodHRwOi8vMTAuMjQuMC4xNjUiLCJleHAiOjE2Mzc1Nzk3NjYsImlhdCI6MTYzNzU3Nj‬
‭E2NiwianRpIjoiZTkzMTIyOGItYWE3Ni00YzU1LThkNzctYzhkNDU2ZTZjOGI3IiwiY2xpZW50X2lkIjoiZWtsLWR1‬
‭cmluLXN0YWdlIn0.B4mgv7m3fwUvdIZ5teq9WJblxoojVe4Pg-yvxzh3KWmKno_r-XFTBUOAwjk4KxzNBa068‬
‭NgJr3uxbLmObh22RPSHKiRl8adB85vsDjohHgt0iAvXv4QWIrF9fDbSgW5nzRT1vPo-BtTu7QA1BupqLQb-_sU‬
‭cWHfsuRFe1bmFq1iV-nkzKdUPoL_w1rz89mY3Z6cqLUZ61KfzpRz6yR7A2gIw_HT31Tw5BUdcw435vAiVzdsM‬
‭pYeFhl2EcY0jJlN7eg8zBbacP-ObqUADyV8LBmMlY01of5eEJYeT6QOdZBEGaSbsaLv6-LekES1NAETmLL2Ho‬
‭BmSXH0JlYMl13BEA"‬
‭}‬

‭ ailure‬
F
‭Rate limit Exceeded - 403 Response status‬
‭{‬
‭"forbidden": "Rate limit exceeded"‬
‭}‬

I‭nvalid Credentials - 401 Response status‬


‭{‬
‭"unauthorised": "invalid_user_credential"‬
‭}‬

‭Token Details:‬
‭a.‬ ‭Expiry Time - 60min. Request a new token before that or you will get unauthorised response on all‬
‭APIs‬

‭1. Create Shipment API‬


‭The create shipment API allows clients to send the service and shipment information to Ekart systems.‬

‭1.1 Forward‬
‭ tage API URL -‬‭https://staging.ekartlogistics.com/v2/shipments/create‬
S
‭Production API URL -‬‭https://api.ekartlogistics.com/v2/shipments/create‬

‭ ttp Method Type -‬‭POST‬


H
‭Headers-‬
‭●‬ ‭Content-Type : application/json‬
‭●‬ ‭HTTP_X_MERCHANT_CODE : (As shared by Ekart Team)‬
‭●‬ ‭Authorization : Bearer <Token>‬

‭Input Parameters‬
‭ he section contains the description of all the fields available (including the optional fields) in the create‬
T
‭shipment API.‬

‭Attribute‬ ‭Values expected‬ ‭Validation‬ ‭Error Message‬


‭(Mandatory - yes/no)‬ ‭(Max Length)‬

c‭ lient_name‬ ‭ nique merchant code shared‬


U ‭ lient name should‬
C "‭ Client name is null "‬
‭(Mandatory - YES)‬ ‭once at the time of client‬ ‭not be blank‬ ‭“Invalid client name‬
‭on-boarding by eKart‬ ‭<value>”‬
‭ lient name should‬
C
‭be valid‬ <‭ value> is the value‬
‭sent in the payload‬

‭ oods_category‬
g ‭ ust be one of the following‬
M I‭f the field is passed, it‬ G
‭ oods category is‬
‭(Mandatory - NO)‬ ‭values:‬ ‭should not be null or‬ ‭either null or empty‬
‭1.‬ ‭ESSENTIAL‬ ‭empty.‬
‭2.‬ ‭NON_ESSENTIAL‬ I‭nvalid goods category,‬
I‭f not passed default value will‬ ‭Provided value: <value>‬
‭be NON_ESSENTIAL‬

s‭ ervice_code‬ ‭Service availed by client:‬ ‭ ust be present and‬


M "‭ serviceCode : Invalid‬
‭(Mandatory - YES)‬ ‭should be valid from‬ ‭Service Code, Provided‬
1‭ .‬ R ‭ EGULAR‬ ‭the list given in‬ ‭value: [<service_code>]"‬
‭2.‬ ‭ECONOMY ( surface‬ ‭description‬
‭only transportation i.e.‬ s‭ ervice_code is the‬
‭never by air)‬ ‭value sent for service‬
‭3.‬ ‭NDD‬ ‭code‬

I‭ndicates if it is a forward‬ ‭ ust be present and‬


M "‭ serviceDetails[0].servic‬
‭delivery or a reverse pickup.‬ ‭should be FORWARD‬ ‭eLeg : Service leg is‬
‭This should always be‬ ‭only‬ ‭null, Provided value:‬
‭ ervice_leg‬
S ‭‘FORWARD’‬ ‭[<service_leg>]"‬
‭(Mandatory - YES)‬
<‭ Service_leg> is the‬
‭value passed for this‬
‭field‬

s‭ ervice_types‬ ‭ ust be one of the following‬


M ‭Must be a valid value‬ ‭ o error. Value will be‬
N
‭(Mandatory - NO)‬ ‭values:‬ ‭ignored‬
‭1.‬ ‭REGIONAL_HANDOV‬
‭ER‬
‭2.‬ ‭DELAYED_DISPATCH‬

‭ assing delayed dispatched‬


p
‭postpones pickup by 1 month.‬

‭ mount_to_collect‬
a I‭ndicates the amount to be‬ ‭ hould be an‬
S "‭ amountToCollect :‬
‭(Mandatory - NO)‬ ‭collected from the customer‬ ‭INTEGER. If value is in‬ ‭Amount to collect‬
‭decimals, the‬ ‭should not exceed‬
‭decimals will be‬ ‭50000, Provided value:‬
‭removed‬ ‭[abc]",‬
‭"amountToCollect :‬
‭ hould >= 0 and‬
S ‭Amount to collect is‬
‭<=50,000‬ ‭Invalid, Provided value:‬
‭[abc]"‬

‭ ispatch_date‬
d I‭ndicates the dispatch date of‬ ‭ hould be in date‬
S "‭ dispatchDate : Invalid‬
‭(Mandatory - NO)‬ ‭the shipment, if the shipment‬ ‭format given below:‬ ‭Date Format, Provided‬
‭is to be dispatched by vendor‬ ‭yyyy-MM-dd‬ ‭value: [date_value]"‬
‭at some later date‬ ‭HH:mm:ss‬
‭And in Indian‬
‭standard time zone‬
‭(GMT+5:30)‬

‭ ustomer_promise_date‬
C I‭ndicates the date promised to‬ S
‭ hould be in date‬ "‭ customerPromiseDate :‬
‭(Mandatory - NO)‬ ‭the end customer.‬ ‭format given below:‬ ‭Invalid Date Format,‬
y‭ yyy-MM-dd‬ ‭ rovided value:‬
P
‭HH:mm:ss‬ ‭[date_value]"‬
‭And in Indian‬
‭standard time zone‬
‭(GMT+5:30)‬

‭ elivery_type‬
d I‭ndicates whether the‬ ‭ efault value is‬
D ‭"deliveryType : Invalid‬
‭(Mandatory - NO)‬ ‭shipment is small, medium or‬ ‭SMALL‬ ‭ elivery type, Provided‬
d
‭(Mandatory - for Large)‬ ‭large shipment (as per Ekart’s‬ ‭value: [<delivery_type>]"‬
‭definition). Should be one of:‬
‭1.‬ ‭SMALL‬
‭2.‬ ‭MEDIUM‬
‭3.‬ ‭LARGE‬

‭Source - data section:‬‭Either one of location code‬‭or address in source and return sections is mandatory.‬

l‭ocation_code‬ ‭ ocation codes must have‬


L ‭ ither one of the‬
E "‭ source : Location code‬
‭(Mandatory - NO)‬ ‭been sent by eKART‬ ‭location code or‬ ‭and Address both are‬
‭engineering team initially‬ ‭address in source and‬ ‭null, Provided value:‬
‭when onboarding details were‬ ‭return sections is‬ ‭[Locations(address=null,‬
‭shared by the client‬ ‭mandatory.‬ ‭locationCode=)]"‬
‭(Max Length- 120)‬

‭Source - address‬

‭ rst_name‬
fi ‭ ame of the seller‬
N "‭ source.address.firstNa‬
‭(Mandatory - YES)‬ ‭(Max Length- 120)‬ ‭me : Name is null or‬
‭empty, Provided value:‬
‭[]"‬

‭ ddress_line1‬
a ‭ ddress of the destination‬
A ‭ ddress_line1 can’t be‬ s‭ ource address_line1 is‬
a
‭(Mandatory - YES)‬ ‭location‬ ‭empty‬ ‭empty‬
‭(Max Length- 255)‬
‭ ddress_line2‬
a
‭(Mandatory - NO)‬

‭ incode‬
p ‭ incode of the destination‬
P ‭Should not be empty‬ s‭ ource pincode is‬
‭(Mandatory - YES)‬ ‭location‬ ‭empty‬
‭(Max Length- 10)‬ ‭ hould strictly be a 6‬
S
‭digit pincode‬ I‭nvalid source pincode‬
‭<value>‬

c‭ ity‬ ‭(Max Length- 64)‬ ‭Should not be empty‬ "‭ source.address.city :‬


‭(Mandatory - YES)‬ ‭City is null or empty,‬
‭Provided value: []"‬

s‭ tate‬ ‭(Max Length- 64)‬ ‭Should not be empty‬


‭(Mandatory - YES)‬

‭ rimary_contact_number‬ ‭seller phone number‬


p ‭Could be empty‬ s‭ eller contact number is‬
‭(Mandatory - YES)‬ ‭(Max Length- 21)‬ ‭empty‬
‭ mail_id‬
e ‭“‬‭Email id is invalid‬‭”‬
‭(Mandatory - NO)‬

‭Destination address - data section‬

‭ rst_name‬
fi ‭Name of the‬‭customer‬ "‭ destination.address.firs‬
‭(Mandatory - YES)‬ ‭(Max Length- 120)‬ ‭tName : Name is null or‬
‭empty, Provided value:‬
‭[]"‬

‭ ddress_line1‬
a ‭ ddress of the destination‬
A ‭ ddress_line1 can’t be‬ d
a ‭ estination‬
‭(Mandatory - YES)‬ ‭location‬ ‭empty‬ ‭address_line1 is empty‬
‭(Max Length- 255)‬
‭ ddress_line2‬
a
‭(Mandatory - NO)‬

‭ incode‬
p ‭ incode of the destination‬
P ‭Should not be empty‬ ‭ estination pincode is‬
d
‭(Mandatory - YES)‬ ‭location‬ ‭empty‬
‭(Max Length- 10)‬
‭ hould strictly be a 6‬
S I‭nvalid destination‬
‭digit pincode‬ ‭pincode <value>‬

c‭ ity‬ ‭(Max Length- 64)‬ ‭Should not be empty‬ "‭ destination.address.city‬


‭(Mandatory - YES)‬ ‭: City is null or empty,‬
‭Provided value: []"‬

s‭ tate‬ ‭ tate of destination location‬


S
‭(Mandatory - YES)‬ ‭(Max Length- 64)‬

‭ rimary_contact_number‬ ‭Customer phone number‬


p ‭Should not be empty‬ "‭ destination.address.pri‬
‭(Mandatory - YES)‬ ‭(Max Length- 21)‬ ‭maryContactNumber :‬
‭Contact number is‬
‭empty or null, Provided‬
‭value:‬
‭[<primary_contact_num‬
‭ber>]"‬

‭ mail_id‬
e ‭“‬‭Email id is invalid‬‭”‬
‭(Mandatory - NO)‬

‭Return_location‬
‭ ontains the details of the location whether the RTO shipments have to be returned. If neither the‬
C
‭location_code nor the address is present, source location will be considered as the return_location.‬

l‭ocation_code‬ ‭ ocation codes must have‬


L ‭ ither one of location‬
E "‭ returnLocation :‬
‭(Mandatory - NO)‬ ‭been sent by eKART‬ ‭code or address in‬ ‭Location code and‬
‭engineering team initially‬ ‭source and return‬ ‭Address both are null,‬
‭when onboarding details were‬ ‭sections is mandatory.‬ ‭Provided value:‬
‭shared by the client‬ ‭[Locations(address=null,‬
‭(Max Length- 120)‬ ‭locationCode=)]"‬

‭ rst_name‬
fi ‭ ame of the customer‬
N "‭ returnLocation.address.‬
‭(Mandatory - YES)‬ ‭(Max Length- 120)‬ ‭firstName : Name is null‬
‭ r empty, Provided‬
o
‭value: []"‬

‭ ddress_line1‬
a ‭ ddress of the destination‬
A ‭ ddress_line1 can’t be‬ "‭ returnLocation.address.‬
a
‭(Mandatory - YES)‬ ‭location‬ ‭empty‬ ‭addressLine1 : Address‬
‭(Max Length- 255)‬ ‭is null or empty,‬
‭Provided value: []"‬

‭ ddress_line2‬
a
‭(Mandatory - NO)‬

‭ incode‬
p ‭ incode of the destination‬
P ‭Should not be empty‬ ‭ estination pincode is‬
d
‭(Mandatory - YES)‬ ‭location‬ ‭empty‬
‭(Max Length- 10)‬
‭ hould strictly be a 6‬
S I‭nvalid destination‬
‭digit pincode‬ ‭pincode <value>‬

c‭ ity‬ ‭(Max Length- 64)‬ ‭Should not be empty‬ "‭ returnLocation.address.‬


‭(Mandatory - YES)‬ ‭city : City is null or‬
‭empty, Provided value:‬
‭[]"‬

s‭ tate‬ ‭(Max Length- 64)‬


‭(Mandatory - YES)‬

‭ rimary_contact_number‬ ‭Customer phone number‬


p ‭Should not be empty‬ "‭ destination.address.pri‬
‭(Mandatory - YES)‬ ‭(Max Length- 21)‬ ‭maryContactNumber :‬
‭Contact number is‬
‭empty or null, Provided‬
‭value:‬
‭[<primary_contact_num‬
‭ber>]"‬

‭ mail_id‬
e ‭“‬‭Email id is invalid‬‭”‬
‭(Mandatory - NO)‬

‭Shipment Details‬

c‭ lient_reference_id‬ ‭ lient’s reference id for the‬


C ‭ an be same as‬
C I‭nvalid Client Reference‬
‭(Mandatory - NO)‬ ‭shipment‬ ‭‘tracking_id’‬ ‭ID <ID>‬
‭(Max Length- 15)‬ ‭Length should be < 16‬

‭ racking_id‬
T ‭ he tracking id of the‬
T ‭ hould not be NULL /‬
S -‭ "trackingId : Tracking Id‬
‭(Mandatory - YES)‬ ‭shipment. This field will‬ ‭blank‬ ‭can not be empty,‬
‭uniquely identify the shipment‬ ‭Should be in proper‬ ‭Provided value:‬
‭for a client.‬ ‭format (3 characters‬ ‭[<TRACKING_ID>]"‬
‭(Max Length- 14)‬ ‭of merchant code‬ ‭-"trackingId : Invalid‬
‭followed by ‘‬‭C‬‭’, ‘‬‭P‬‭’‬ ‭tracking ID, Provided‬
‭depending shipment‬ ‭value:‬
‭is COD or PREPAID‬ ‭[<TRACKING_ID>]"‬
‭followed by 10 unique‬
‭digits)‬
‭ hipment_value‬
S ‭ alue of the shipment in INR.‬
V ‭ an be a float or‬
C s‭ hipment_value is not in‬
‭(Mand‬ ‭Max value 100000‬ ‭integer‬ ‭correct format‬
‭atory - YES)‬

r‭ eturn_label_desc_1‬ ‭ ext to be displayed while‬


T ‭ ength should be less‬
L
‭(Mandatory - NO)‬ ‭printing the return label‬ ‭than 75 chars (will not‬
‭reject if this fails)‬

‭ eturn_label_desc_2‬
R ‭ ext to be displayed while‬
T ‭ ength should be less‬
L
‭(Mandatory - NO)‬ ‭printing the return label‬ ‭than 75 chars (will not‬
‭reject if this fails)‬

s‭ hipment_dimensions‬
‭First max value of LBH can be 75, second max value can be 55. Max volumetric weight (L*B*H/6000) can be‬
‭21.25‬

‭ ength‬
L ‭Length of the shipment (cms)‬ ‭ hould be a positive‬
S ‭shipment_length invalid‬
‭(Mandatory - NO)‬ ‭float.‬
‭(Mandatory - for Large)‬

‭ readth‬
B ‭Breadth of the shipment (cms)‬ ‭ hould be a positive‬
S s‭ hipment_breadth‬
‭(Mandatory - NO)‬ ‭float‬ ‭invalid‬
‭(Mandatory - for Large)‬

‭ eight‬
H ‭Height of the shipment (cms)‬ ‭ hould be a positive‬
S ‭shipment_height invalid‬
‭(Mandatory - NO)‬ ‭float‬
‭(Mandatory - for Large)‬

‭ eight‬
W ‭ eight of the shipment (kg).‬
W ‭ hould be a positive‬
S -‭ shipment_weight‬
‭(Mandatory - YES)‬ ‭Max value- 12 (not for large)‬ ‭float‬ ‭invalid‬
‭Min value- 0.1‬ ‭-Shipment weight‬
‭exceeds max allowed‬
‭value- 12(not for large)‬

‭Shipment Item Details‬


‭ shipment can contain multiple items. Should contain at-least 1 item. This section contains the details that‬
A
‭need to be added for each of the items present in the‬‭shipment‬

‭ roduct_id‬
p ‭ roduct number for the‬
P
‭(Mandatory - NO)‬ ‭shipment item (as per client)‬
‭(Mandatory - for Large)‬ ‭(Max Length- 64)‬

c‭ ategory‬ ‭ ategory of the shipment item.‬ ‭This is shared with BD‬


C
‭(Mandatory - NO)‬ ‭Like - ‘Mobiles’, ‘Apparels’, etc‬
‭(Mandatory - for Large)‬ ‭(Max Length- 50)‬

‭ roduct_title‬
P ‭ ame of the shipment item‬
N
‭(Mandatory - NO)‬ ‭(Max Length- 255)‬

‭ uantity‬
Q ‭ uantity of the shipment item‬
Q ‭ hould not be blank‬
S "‭ shipmentItems[0].quant‬
‭(Mandatory - YES)‬ ‭in the shipment‬ ‭Should be an integer‬ ‭ity : quantity is empty or‬
‭ ull, Provided value:‬
n
‭[<quantity>]"‬

‭ otal_sale_value‬
T ‭ otal sale value of the given‬
T ‭Should be a float‬ t‭ otal_sale_value is not‬
‭Mandatory - NO)‬ ‭shipment item.‬ ‭in correct format‬

‭ otal_tax_value‬
T ‭ otal tax value of the given‬
T ‭Should be a float‬ t‭ otal_tax_value is not in‬
‭Mandatory - NO)‬ ‭shipment item.‬ ‭correct format‬

‭ ax_breakup‬
T ‭ reakup of GST into cgst, sgst‬
B ‭ hould not be blank‬
S "‭ shipmentItems[0].cost.t‬
‭(Mandatory - NO)‬ ‭and igst‬ ‭Should be a float‬ ‭axBreakup.igst : IGST is‬
‭empty or null, Provided‬
‭value: [<cgst,igst,sgst>]"‬

s‭ eller_reg_name‬ ‭ egistered name of the seller‬


R ‭Should not be blank‬ s‭ eller_reg_name is not‬
‭(Mandatory - NO)‬ ‭(Max Length- 255)‬ ‭present‬

‭ stin_id‬
G ‭ STIN of seller‬
G ‭Should not be blank‬ ‭gstin_id is not present‬
‭(Mandatory - Yes)‬ ‭(Max Length- 30)‬

‭ sn‬
H ‭ SN of the shipment item,‬
H ‭ equired if shipment‬
R ‭ sn is not present‬
h
‭(Mandatory - NO)‬ ‭should be an 8 digit value‬ ‭value exceeds 50000‬ ‭HSN value is invalid‬

‭ rn‬
e ‭ lectronic Reference number‬
E ‭ equired if shipment‬
R
‭(Mandatory - NO)‬ ‭for the invoice‬ ‭value exceeds 50000‬

‭ iscount‬
d ‭ iscount provided for the‬
D ‭Should be float‬ ‭ iscount is not in‬
d
‭(Mandatory - NO)‬ ‭shipment item‬ ‭correct format‬

‭ rder_id‬
O ‭ rder id for the shipment item‬ ‭Should not be NULL‬
O ‭ hipment Item Attribute‬
S
‭(Mandatory - YES)‬ ‭(this corresponds to the order‬ ‭ORDER_ID is null"‬
‭id provided by the ecommerce‬
‭platform)‬
‭(Min Length- 6, Alphanumeric)‬

I‭nvoice_id‬ ‭Invoice ID for the transaction‬ ‭Should not be NULL‬ "‭ Shipment Item‬
‭(Mandatory - YES)‬ ‭Attribute INVOICE_ID is‬
‭ hould not exceed‬
S ‭null"‬
‭character limit of 16‬

‭ lphanumeric with /‬
A
‭and - are only allowed‬

‭ way_bill_number‬
E ‭ way bill number for the‬
E ‭ equired‬‭if shipment‬
R ‭ way bill number not‬
E
‭(Mandatory - NO)‬ ‭shipment‬ ‭value exceeds‬ ‭provided for high value‬
‭50000. Length should‬ ‭shipment‬
‭be 12‬

i‭tem_dimension‬ ‭ he dimensions of the item.‬


T
‭(Mandatory - NO)‬ ‭Will contain the length,‬
‭breadth, height and weight‬
i‭nformation of the shipment‬
‭item. If incorrect format is‬
‭provided, we will consider the‬
‭value as 0:0:0:0.‬

‭ rand_name‬
b ‭ he brand name of the‬
T
‭(Mandatory - NO)‬ ‭shipment item which should‬
‭be used while communicating‬
‭with the end customers.‬

‭Handling Attributes‬

i‭sFragile‬ I‭ndicates whether the‬ ‭Should not be NULL‬ "‭ Shipment Handling‬
‭(Mandatory - NO)‬ ‭shipment item is fragile. In‬ ‭Attribute isFragile has‬
‭case of invalid input (anything‬ ‭invalid value : <value>"‬
‭other than TRUE or FALSE), we‬
‭will consider it as FALSE.‬

i‭sDangerous‬ I‭ndicates whether the‬ ‭Should not be NULL‬ "‭ Shipment Handling‬
‭(Mandatory - NO)‬ ‭shipment item is dangerous. In‬ ‭Attribute isDangerous‬
‭case of invalid input (anything‬ ‭has invalid value :‬
‭other than TRUE or FALSE), we‬ ‭<value>"‬
‭will consider it as FALSE.‬

‭Sample Request Payload‬


‭{‬
"‭ client_name": "MerchantCode",‬
‭"goods_category": "ESSENTIAL",‬
‭"services": [‬
‭{‬
‭"service_code": "REGULAR",‬
‭"service_details": [‬
‭{‬
‭"service_leg": "FORWARD",‬
‭"service_data": {‬
‭"service_types":[‬
‭{‬
‭"name": "regional_handover",‬
‭"value": "true"‬
‭},‬
‭{‬
‭"name": "delayed_dispatch",‬
‭"value": "true" #If this value is sent as TRUE in creation call then pickup date will be d+30‬
‭}‬
‭],‬
‭“vendor_name”:”Ekart”,‬
"‭ amount_to_collect": 1000,‬
‭"dispatch_date": "2018-10-29 11:30:00",‬
‭"customer_promise_date": "",‬
‭"delivery_type": "SMALL",‬
‭"source": {‬
‭“location_code”:”ABC_del_01”‬
‭},‬
‭"destination": {‬
‭"address": {‬
‭"first_name": "AVThamizhmahan",‬
‭"address_line1": "123/22 Garden Vazhudaretty Post Villupuram",‬
‭"address_line2": "Tamil Nadu",‬
‭"pincode": "400066",‬
‭"city": "Villupuram",‬
‭"state": "Tamil Nadu",‬
‭"primary_contact_number": "1234567890",‬
‭"email_id":"[email protected]"‬
‭}‬
‭},‬
‭"return_location": {‬
‭"address": {‬
‭"first_name": "AVThamizhmahan",‬
‭"address_line1": "3/1675 ES Garden Vazhudaretty Post Villupuram",‬
‭"address_line2": "Tamil Nadu",‬
‭"pincode": "400066",‬
‭"city": "Villupuram",‬
‭"state": "Tamil Nadu",‬
‭"primary_contact_number": "",‬
‭"email_id":"[email protected]"‬
‭}‬
‭}‬
‭},‬

‭"shipment": {‬
‭"client_reference_id": "ABCD",‬
‭"tracking_id": "CLTC0000000001",‬
‭"shipment_value": 2000,‬
‭"shipment_dimensions": {‬
‭"length": {‬
‭"value": 1‬
‭},‬
‭"breadth": {‬
‭"value": 1‬
‭},‬
‭"height": {‬
‭"value": 1‬
‭},‬
‭"weight": {‬
‭"value": 1‬
‭}‬
‭},‬
‭"return_label_desc_1": "",‬
‭"return_label_desc_2": "",‬
‭"shipment_items": [‬
‭{‬
"‭ product_id": "134883075",‬
‭"category": "Apparel",‬
‭"product_title": "Mast&HarbourBlackHandbag: Handbags",‬
‭"quantity": 1,‬
‭"cost": {‬
‭"total_sale_value": 500,‬
‭"total_tax_value": 100,‬
‭“tax_breakup”:{‬
‭“cgst”:0.0,‬
‭“sgst”:0.0,‬
‭“igst”:100.0‬
‭}‬
‭},‬
‭"seller_details": {‬
‭"seller_reg_name": "Seller Registered Legal Name",‬
‭“gstin_id”:””‬
‭},‬
‭“hsn” :””,‬
‭“ern”:””,‬
‭“discount”:0.0,‬
‭"item_attributes": [‬
‭{‬
‭"name": "order_id",‬
‭"value": "ABCD"‬
‭},‬
‭{‬
‭"name": "invoice_id",‬
‭"value": "INV1234"‬
‭},‬
‭{‬
‭"name": "item_dimensions",‬
‭"value": "l:b:h:w"‬
‭},‬
‭{‬
‭"name": "brand_name",‬
‭"value": "Peter England"‬
‭},‬
‭{‬
‭"name": "eway_bill_number",‬
‭"value": "EWB1234"‬
‭}‬
‭],‬
‭"handling_attributes": [‬
‭{‬
‭"name": "isFragile",‬
‭"value": "false"‬
‭},‬
‭{‬
‭"name": "isDangerous",‬
‭"value": "false"‬
‭}‬
‭]‬
‭}‬
‭]‬
‭}‬
‭}‬
]‭‬
‭}‬
‭]‬
‭}‬

‭Sample Response Payload‬


‭ uccess‬
S
‭{‬
‭"request_id": "R01",‬
‭"response": [‬
‭{‬
‭"tracking_id": "CLTC0000000001",‬
‭"status": "REQUEST_RECEIVED"‬
‭}‬
‭]‬
‭}‬

‭Failure‬
‭1.‬ ‭Payload validation - 400 Response Status‬
‭{‬
‭"response": [‬
‭{‬
‭"tracking_id": "CLTC0000000001",‬
‭"status": "REQUEST_REJECTED",‬
‭"message": [‬
‭"Largest value of dimension exceeds max allowed value - 75.0"‬
‭]‬
‭}‬
‭],‬
‭"request_id": "4cd55a87-1c1e-4a8d-aa48-6410a3cb8d07"‬
‭}‬

‭2.‬ D
‭ uplicate Tracking ID used - 400 Response Status‬
‭{‬
‭"response": [‬
‭{‬
‭"tracking_id": "CLTC0000000001",‬
‭"status": "REQUEST_REJECTED",‬
‭"message": [‬
‭"Shipment already exists with the same tracking ID"‬
‭]‬
‭}‬
‭],‬
‭"request_id": "8200966e-cc48-4ba9-902f-a520dc5a0d33"‬
‭}‬
‭3.‬ S
‭ erviceability Failure - 400 Response Status‬
‭{‬
‭"response": [‬
‭{‬
‭"tracking_id": "CLTC0000000001",‬
‭"status": "REQUEST_REJECTED",‬
‭"message": [‬
‭"No vendor has pickup serviceability"‬
‭]‬
‭}‬
‭],‬
‭"request_id": "e6ce3001-9771-4874-8a82-036b388f9c88"‬
‭}‬

‭4.‬ I‭neligible movement based on Orange/Green/Red zones - 400 Response Status‬


‭{‬
‭"response": [‬
‭{‬
‭"status": "REQUEST_REJECTED",‬
‭"message": [‬
‭"Movement is not allowed"‬
‭]‬
‭}‬
‭],‬
‭"request_id": "42ba78cb-8176-4bd0-9c9b-ef0c9a6f5c31"‬
‭}‬

‭5.‬ R
‭ ate limit Exceeded - 403 Response status‬
‭{‬
‭"forbidden": "Rate limit exceeded"‬
‭}‬
‭Response Codes:‬
‭200 - Request received‬
‭400 - Bad request (validation failed, message will contain the exact validation failed)‬
‭401 - Authorization failed‬
‭404 - Resource not found‬
‭403 - Forbidden (Rate limit exceeded)‬
‭500 - Service is down‬

‭1.2 Reverse‬
‭ tage API URL -‬‭https://staging.ekartlogistics.com/v2/shipments/create‬
S
‭Production API URL -‬‭https://api.ekartlogistics.com/v2/shipments/create‬

‭ ttp Method Type -‬‭POST‬


H
‭Headers-‬
‭●‬ ‭Content-Type : application/json‬
‭●‬ ‭HTTP_X_MERCHANT_CODE : (As shared by Ekart Team)‬
‭●‬ ‭Authorization : Bearer <Token>‬
‭Input Parameters‬
‭ he section contains the description of all the fields available (including the optional fields) in the create‬
T
‭shipment API for RVP shipments.‬

‭Attribute‬ ‭Values expected‬ ‭Validation‬ ‭Error Message‬


‭(Mandatory - yes/no)‬

‭client_name‬ ‭ nique merchant code‬


U ‭ lient name should‬
C "‭ Client name is null "‬
‭shared once at the time of‬ ‭not be blank‬ ‭“Invalid client name‬
‭(Mandatory - YES)‬ ‭client on-boarding by eKart‬ ‭<value>”‬
‭ lient name should‬
C
‭be valid‬ <‭ value> is the value‬
‭sent in the payload‬

‭ oods_category‬
g ‭ ust be one of the following‬
M I‭f the field is passed, it‬ G
‭ oods category is‬
‭(Mandatory - NO)‬ ‭values:‬ ‭should not be null or‬ ‭either null or empty‬
‭3.‬ ‭ESSENTIAL‬ ‭empty.‬
‭4.‬ ‭NON_ESSENTIAL‬ ‭Invalid goods category,‬
‭If not passed default value‬ ‭Provided value: <value>‬
‭will be NON_ESSENTIAL‬

s‭ ervice_code‬ ‭ ervice availed by client:‬


S ‭ ust be present and‬
M "‭ serviceCode : Invalid‬
‭(Mandatory - YES)‬ ‭RETURNS_SMART_CHECK‬ ‭should be valid from‬ ‭Service Code, Provided‬
‭RETURNS_BASIC_CHECK‬ ‭the list given in‬ ‭value: [<service_code>]"‬
‭RETURNS_CLOSED_BOX‬ ‭description‬
s‭ ervice_code is the‬
‭value sent for service‬
‭code‬

s‭ ervice_leg‬ I‭ndicates if it is a forward‬ ‭ ust be present and‬


M "‭ serviceDetails[0].servic‬
‭(Mandatory - YES)‬ ‭delivery or a reverse pickup.‬ ‭should be ‘REVERSE’‬ ‭eLeg : Service leg is‬
‭This should always be‬ ‭only‬ ‭null, Provided value:‬
‭‘REVERSE’‬ ‭[<service_leg>]"‬

<‭ Service_leg> is the‬


‭value passed for this‬
‭field‬

‭ elivery_type‬
d I‭ndicates whether the‬ ‭ efault value is‬
D ‭"deliveryType : Invalid‬
‭(Mandatory - NO)‬ ‭shipment is small, medium or‬ ‭SMALL‬ ‭ elivery type, Provided‬
d
‭large shipment (as per Ekart’s‬ ‭value: [<delivery_type>]"‬
‭definition). Should be one of:‬
‭1.‬ ‭SMALL‬
‭2.‬ ‭MEDIUM‬
‭3.‬ ‭LARGE‬

‭ ource details‬‭: Either location_code or the address‬‭should be present. If both are present, preference‬
S
‭will be given to location_code over address.‬

l‭ocation_code‬ ‭ ocation codes must have‬


L ‭ ither one of location‬
E "‭ source : Location code‬
‭(Mandatory - NO)‬ ‭been sent by eKART‬ ‭code or address in‬ ‭and Address both are‬
‭ ngineering team initially‬
e s‭ ource and return‬ ‭ ull, Provided value:‬
n
‭when onboarding details‬ ‭sections is mandatory.‬ ‭[Locations(address=null,‬
‭were shared by the client‬ ‭locationCode=)]"‬
‭(Max Length- 120)‬

‭Source - address‬

‭ rst_name‬
fi ‭ ame of the seller‬
N "‭ source.address.firstNa‬
‭(Mandatory - YES)‬ ‭(Max Length- 120)‬ ‭me : Name is null or‬
‭empty, Provided value:‬
‭[]"‬

‭ ddress_line1‬
a ‭ ddress of the destination‬
A ‭ ddress_line1 can’t be‬ s‭ ource address_line1 is‬
a
‭(Mandatory - YES)‬ ‭location‬ ‭empty‬ ‭empty‬
‭(Max Length- 255)‬
‭ ddress_line2‬
a
‭(Mandatory - NO)‬

‭ incode‬
p ‭ incode of the destination‬
P ‭Should not be empty‬ s‭ ource pincode is‬
‭(Mandatory - YES)‬ ‭location‬ ‭empty‬
‭(Max Length- 10)‬ ‭ hould strictly be a 6‬
S
‭digit pincode‬ I‭nvalid source pincode‬
‭<value>‬

c‭ ity‬ ‭(Max Length- 64)‬ ‭Should not be empty‬ "‭ source.address.city :‬


‭(Mandatory - YES)‬ ‭City is null or empty,‬
‭Provided value: []"‬

s‭ tate‬ ‭(Max Length- 64)‬ ‭Should not be empty‬


‭(Mandatory - YES)‬

‭ estination:‬‭Location code of the facility where the‬‭item has to be returned. Either location_code or the‬
D
‭address should be present. If both are present, preference will be given to location_code over address.‬

l‭ocation_code‬ ‭ ocation codes must have‬


L ‭ ither one of the‬
E "‭ destination : Location‬
‭(Mandatory - NO)‬ ‭been sent by eKART‬ ‭location code or‬ ‭code and Address both‬
‭engineering team initially‬ ‭address in source and‬ ‭are null, Provided value:‬
‭when onboarding details‬ ‭return sections is‬ ‭[Locations(address=null,‬
‭were shared by the client‬ ‭mandatory.‬ ‭locationCode=)]"‬
‭(Max Length- 120)‬

‭Destination - address‬

‭ rst_name‬
fi ‭ ame of the seller‬
N "‭ Destination.address.firs‬
‭(Mandatory - YES)‬ ‭(Max Length- 120)‬ ‭tName : Name is null or‬
‭empty, Provided value:‬
‭[]"‬

‭ ddress_line1‬
a ‭ ddress of the destination‬
A ‭ ddress_line1 can’t be‬ D
a ‭ estination‬
‭(Mandatory - YES)‬ ‭location‬ ‭empty‬ ‭address_line1 is empty‬
‭ ddress_line2‬
a ‭(Max Length- 255)‬
‭(Mandatory - NO)‬

‭ incode‬
p ‭ incode of the destination‬
P ‭Should not be empty‬ s‭ ource pincode is‬
‭(Mandatory - YES)‬ ‭location‬ ‭empty‬
‭(Max Length- 10)‬ ‭ hould strictly be a 6‬
S
‭digit pincode‬ I‭nvalid source pincode‬
‭<value>‬

c‭ ity‬ ‭(Max Length- 64)‬ ‭Should not be empty‬ "‭ Destination.address.cit‬


‭(Mandatory - YES)‬ ‭y : City is null or empty,‬
‭Provided value: []"‬

s‭ tate‬ ‭(Max Length- 64)‬ ‭Should not be empty‬


‭(Mandatory - YES)‬

‭Shipment Details‬

c‭ lient_reference_id‬ ‭ lient’s reference id for the‬


C ‭ an be same as‬
C
‭(Mandatory - NO)‬ ‭shipment‬ ‭‘tracking_id’‬
‭(Max Length- 15)‬

‭ racking_id‬
T ‭ he tracking id of the‬
T ‭ hould not be NULL /‬
S "‭ trackingId : Tracking Id‬
‭(Mandatory - YES)‬ ‭shipment. This field will‬ ‭blank‬ ‭can not be empty,‬
‭uniquely identify the‬ ‭Should be in proper‬ ‭Provided value:‬
‭shipment for a client.‬ ‭format (3 characters‬ ‭[<TRACKING_ID>]"‬
‭(Max Length- 14)‬ ‭of merchant code‬
‭followed by ‘‬‭R‬‭’‬
‭indicating Reverse‬
‭shipment, followed by‬
‭10 unique digits)‬

‭ hipment_value‬
S ‭ alue of the shipment in INR.‬
V ‭ an be a float or‬
C s‭ hipment_value is not in‬
‭(Mandatory - YES)‬ ‭Max value 100000‬ ‭integer‬ ‭correct format‬

s‭ hipment_dimensions‬
‭First max value of LBH can be 75, second max value can be 55. Max volumetric weight (L*B*H/6000) can‬
‭be 21.25‬

‭ ength‬
L ‭Length of the shipment (cms)‬ ‭ hould be a positive‬
S ‭shipment_length invalid‬
‭(Mandatory - NO)‬ ‭float.‬
‭(Mandatory - for‬
‭Large)‬

‭ readth‬
B ‭Breadth of the shipment (cms)‬ S
‭ hould be a positive‬ s‭ hipment_breadth‬
‭(Mandatory - NO)‬ ‭float‬ ‭invalid‬
‭(Mandatory - for‬
‭Large)‬

‭ eight‬
H ‭Height of the shipment (cms)‬ ‭ hould be a positive‬
S ‭shipment_height invalid‬
‭(Mandatory - NO)‬ ‭float‬
(‭Mandatory - for‬
‭Large)‬

‭ eight‬
W ‭ eight of the shipment (kg).‬
W ‭ hould be a positive‬
S -‭ shipment_weight‬
‭(Mandatory - YES)‬ ‭Max value- 12 (not for large)‬ ‭float‬ ‭invalid‬
‭Min value- 0.1‬ ‭-Shipment weight‬
‭exceeds max allowed‬
‭value- 12(not for large)‬

‭Shipment Item Details‬


‭ reverse shipment can contain one and only one item. This section contains the details that need to be‬
A
‭added for each of the items present in the‬‭shipment‬

‭ roduct_id‬
p ‭ roduct number for the‬
P
‭(Mandatory - NO)‬ ‭shipment item (as per client)‬
‭(Mandatory - for‬ ‭(Max Length- 64)‬
‭Large)‬

c‭ ategory‬ ‭ ategory of the shipment‬


C
‭(Mandatory - NO)‬ ‭item. Like - ‘Mobiles’,‬
‭(Mandatory - for‬ ‭‘Apparels’, etc‬
‭Large)‬ ‭(Max Length- 120)‬

‭ roduct_title‬
P ‭ ame of the shipment item‬
N
‭(Mandatory - NO)‬ ‭(Max Length- 255)‬

‭ uantity‬
Q ‭ uantity of the shipment item‬
Q ‭ hould not be blank‬
S "‭ shipmentItems[0].quant‬
‭(Mandatory - NO)‬ ‭in the shipment‬ ‭Should be an integer‬ ‭ity : quantity is empty or‬
‭null, Provided value:‬
‭[<quantity>]"‬

‭ otal_sale_value‬
T ‭ otal sale value of the given‬
T ‭Should be a float‬ t‭ otal_sale_value is not‬
‭(Mandatory - NO)‬ ‭shipment item.‬ ‭in correct format‬

‭ otal_tax_value‬
T ‭ otal tax value of the given‬
T ‭Should be a float‬ t‭ otal_tax_value is not in‬
‭(Mandatory - NO)‬ ‭shipment item.‬ ‭correct format‬

‭ ax_breakup‬
T ‭ reakup of GST into cgst,‬
B ‭ hould not be blank‬
S "‭ shipmentItems[0].cost.t‬
‭(Mandatory - NO)‬ ‭sgst and igst‬ ‭Should be a float‬ ‭axBreakup.igst : IGST is‬
‭empty or null, Provided‬
‭value: [<cgst,igst,sgst>]"‬

s‭ eller_reg_name‬ ‭ egistered name of the seller‬


R ‭Should not be blank‬ s‭ eller_reg_name is not‬
‭(Mandatory - NO)‬ ‭(Max Length- 255)‬ ‭present‬

‭ stin_id‬
G ‭ STIN of seller‬
G ‭Should not be blank‬ ‭gstin_id is not present‬
‭(Mandatory - Yes)‬ ‭(Max Length- 30)‬

‭ sn‬
H ‭ SN of the shipment item,‬
H ‭ equired if shipment‬
R ‭ sn is not present‬
h
‭(Mandatory - NO)‬ ‭should be an 8 digit value‬ ‭value exceeds 50000‬ ‭HSN value is invalid‬
‭ rn‬
e ‭ lectronic Reference number‬
E ‭ equired if shipment‬
R
‭(Mandatory - NO)‬ ‭for the invoice‬ ‭value exceeds 50000‬

‭ iscount‬
d ‭ iscount provided for the‬
D ‭Should be float‬ ‭ iscount is not in‬
d
‭(Mandatory - NO)‬ ‭shipment item‬ ‭correct format‬

‭ rder_id‬
O ‭ rder id for the shipment‬
O ‭Should not be NULL‬ ‭ hipment Item Attribute‬
S
‭(Mandatory - YES)‬ ‭item (this corresponds to the‬ ‭ORDER_ID is null"‬
‭order id provided by the‬
‭ecommerce platform)‬
‭(Min Length- 6, Alphanumeric)‬

I‭nvoice_id‬ ‭Invoice ID for the transaction‬ ‭Should not be NULL‬ "‭ Shipment Item‬
‭(Mandatory - YES)‬ ‭Attribute INVOICE_ID is‬
‭ hould not exceed‬
S ‭null"‬
‭character limit of 16‬

‭ lphanumeric with /‬
A
‭and - are only allowed‬

i‭tem_dimension‬ ‭ he dimensions of the item.‬


T
‭(Mandatory - NO)‬ ‭Will contain the length,‬
‭breadth, height and weight‬
‭information of the shipment‬
‭item. If incorrect format is‬
‭provided, we will consider the‬
‭value as 0:0:0:0.‬

‭Pickup Information‬‭(Mandatory - NO)‬


‭Basic information about the item to be picked up‬‭from the customer location‬

r‭ eason‬ ‭ eason for the customer‬


R
‭(Mandatory - NO)‬ ‭return‬

s‭ ub_reason‬
‭(Mandatory - NO)‬

‭ eason_description‬ D
R ‭ escription of the reason for‬
‭(Mandatory - NO)‬ ‭customer return‬

I‭mage‬ I‭mage URL of the item to be‬


‭(Mandatory - NO)‬ ‭picked‬

‭Smart pickup checks‬


‭ ategory specific pickup checks will be performed. The list of checks to be decided based on the‬
C
‭discussion with the client‬

‭Item_title‬ ‭ he name of the shipment‬


T ‭Should not be blank‬ I‭tem title in smart‬
‭item being picked‬ ‭checks cannot be‬
‭(Max Length- 255)‬ ‭empty‬

‭checks (key)‬ ‭ he name of the check to be‬


T
‭performed.For eg.‬
‭D_DAMAGE_CTH_CHECK.‬

‭inputs‬ I‭nput to perform the check.‬


‭For eg. for performing brand‬
‭check, the input will be brand‬
‭name‬

‭is_mandatory‬ ‭ lag indicating whether the‬


F ‭ hould not be‬
S ‭Is mandatory required‬
‭check is mandatory or‬ ‭null/blank‬
‭optional‬
‭ hould be one of the‬ I‭nvalid is_mandatory‬
S
‭following: true or false‬ ‭value <value>‬

‭Sample Request Payload‬


‭{‬
"‭ client_name":"MerchantCode",‬
‭"goods_category": "ESSENTIAL",‬
‭"services":[‬
‭{‬
‭"service_code":"RETURNS_SMART_CHECK",‬
‭"service_details":[‬
‭{‬
‭"service_leg":"REVERSE",‬
‭"service_data":{‬
‭"amount_to_collect":0,‬
‭"delivery_type":"SMALL",‬
‭"source":{‬
‭"address":{‬
‭"first_name":"AVThamizhmahan",‬
‭"address_line1":"3/1675 ES Garden Vazhudaretty Post Villupuram",‬
‭"address_line2":"Tamil Nadu",‬
‭"pincode":"400066",‬
‭"city":"Villupuram",‬
‭"state":"Tamil Nadu",‬
‭"primary_contact_number":""‬
‭}‬
‭},‬
‭"destination":{‬
‭"location_code":"ABC_del_01"‬
‭}‬
‭},‬
‭"shipment":{‬
‭"client_reference_id":"ABCD",‬
‭"tracking_id":"CLTC0000000001",‬
‭"Shipment_value":2000,‬
‭"shipment_dimensions": {‬
‭"length": {‬
‭"value": 1‬
‭},‬
‭"breadth": {‬
‭"value": 1‬
‭},‬
‭"height": {‬
‭"value": 1‬
‭},‬
‭"weight": {‬
‭"value": 1‬
‭}‬
‭},‬
‭"shipment_items":[‬
‭{‬
‭"product_id":"134883075",‬
‭"product_title":"Mast&HarbourBlackHandbag: Handbags",‬
‭"category":"Apparel",‬
‭"quantity":1,‬
‭"cost": {‬
‭"total_sale_value": 500,‬
‭"total_tax_value": 100,‬
‭"tax_breakup":{‬
‭"cgst":"0.0",‬
‭"sgst":"0.0",‬
‭"Igst":"0.0"‬
‭}‬

}‭,‬
‭"seller_details":{‬
‭"seller_reg_name":"Seller Registered Legal Name",‬
‭“gstin_id”:””‬
‭},‬
‭“hsn”:””,‬
‭“ern”:””,‬
‭“discount”:””,‬
‭"item_attributes":[‬
‭{‬
‭"name":"order_id",‬
‭"value":"ABCD"‬
‭},‬
‭{‬
‭"name":"invoice_id",‬
‭"value":"INV1234"‬
‭}‬
‭],‬
‭"pickup_info":{‬
‭"reason":"OTHER_REASON",‬
‭"sub_reason":"OTHER_REASON",‬
‭"reason_description":"Customer requested for Return"‬
}‭,‬
‭"smart_checks":[‬
‭{‬
‭"item_title":"BodyTantrumSolidMen'sGreyTrackPants",‬
‭"checks":{‬
‭"D_DAMAGE_CTH_CHECK":{‬
‭"inputs":{‬

}‭,‬
‭"is_mandatory":false‬
}‭,‬
‭"M_BRAND_CHECK_ON_PRODUCT_FOOTWEAR":{‬
‭"inputs":{‬
‭"brand_name":"BodyTantrum"‬
‭},‬
‭"is_mandatory":true‬
‭},‬
‭"M_PRODUCT_IMAGE_COLOR_PATTERN_MATCH":{‬
‭"inputs":{‬
‭"item_image":"http: //www.abc.xyz"‬
‭},‬
‭"is_mandatory":true‬
‭},‬
‭"M_BRAND_CHECK_ON_PRODUCT_APPAREL":{‬
‭"inputs":{‬
‭"brand_name":"BodyTantrum"‬
‭},‬
‭"is_mandatory":true‬
‭},‬
‭"P_TAG_AVAILABLE_CHECK":{‬
‭"inputs":{‬

}‭,‬
‭"is_mandatory":true‬
‭}‬
‭}‬
‭}‬
‭]‬
‭}‬
‭]‬
‭}‬
‭}‬
‭]‬
‭}‬
‭]‬
‭}‬

‭Sample Response Payload‬


‭ uccess‬
S
‭{‬
‭"request_id": "R02",‬
‭"response": [‬
‭{‬
"‭ tracking_id": "CLTC0000000001",‬
‭"status": "REQUEST_RECEIVED"‬
‭}‬
‭]‬
‭}‬

‭Failure‬
‭1.‬ ‭{‬
‭"request_id": "R02",‬
‭"response": [‬
‭{‬
‭"tracking_id": "CLTC0000000001",‬
‭"status": "REQUEST_REJECTED",‬
‭"message": "Reason for Request Rejection"‬
‭}‬
‭]‬
‭}‬
‭2.‬ ‭Rate limit Exceeded - 403 Response status‬
‭{‬
‭"forbidden": "Rate limit exceeded"‬
‭}‬

‭ esponse Codes:‬
R
‭200 - Request received‬
‭400 - Bad request (validation failed, message will contain the exact validation failed)‬
‭401 - Authorization failed‬
‭404 - Resource not found‬
‭403 - Forbidden (Rate limit exceeded)‬
‭500 - Service is down‬

‭hsPro1.2.1 Smart Checks‬

‭Input Parameters‬
‭ he section contains the description of all the smart checks available in the create shipment API for RVP‬
T
‭shipments.‬

‭ he payload will contain the information of smart check keys and their corresponding inputs along with if‬
T
‭the check is mandatory.‬

‭Checks‬ ‭Inputs‬
‭M_BASIC_IMAGE_MATCH‬ ‭ITEM_IMAGE‬
‭M_PRODUCT_IMAGE_COLOR_PATTERN_MATCH‬ ‭ITEM_IMAGE‬
‭M_BRAND_CHECK_ON_PRODUCT_ALL‬ ‭BRAND_NAME‬
‭M_BRAND_CHECK_ON_PRODUCT_APPAREL‬ ‭BRAND_NAME‬
‭M_BRAND_CHECK_ON_TAG_ALL‬ ‭BRAND_NAME‬
‭M_BRAND_CHECK_ON_PRODUCT_FOOTWEAR‬ ‭BRAND_NAME‬
‭M_SIZE_CHECK_ON_PRODUCT_ALL‬ ‭SIZE‬
‭M_SIZE_CHECK_ON_PRODUCT_FOOTWEAR‬ ‭SIZE‬
‭M_SIZE_CHECK_ON_TAG_ALL‬ ‭SIZE‬
‭C_IMEI_CHECK‬ ‭IMEI_NO‬
‭M_BRAND_PRODUCT_TYPE_TV‬ ‭PRODUCT_TYPE_BRAND_NAME‬
‭M_PRODUCT_TYPE_CAPACITY_WM‬ ‭PRODUCT_TYPE_CAPACITY‬
‭M_PRODUCT_TYPE_CAPACITY_REF‬ ‭PRODUCT_TYPE_CAPACITY‬
‭M_PRODUCT_TYPE_REF‬ ‭PRODUCT_TYPE‬
‭M_PRODUCT_TYPE_TV‬ ‭PRODUCT_TYPE‬
‭M_PRODUCT_TYPE_WM‬ ‭PRODUCT_TYPE‬
‭M_SIZE_CHECK_TV‬ ‭SIZE‬
‭M_CAPACITY_CHECK_REF‬ ‭CAPACITY‬
‭M_CAPACITY_CHECK_WM‬ ‭CAPACITY‬
‭M_MODEL_CHECK‬ ‭MODEL_NAME‬
‭M_BRAND_CHECK_AC‬ ‭PRODUCT_TYPE_BRAND_NAME‬
‭M_TYPE_CHECK_AC‬ ‭PRODUCT_TYPE_CAPACITY‬
‭M_CAPACITY_AC‬ ‭CAPACITY‬
‭D_DAMAGE_CTH_CHECK‬ ‭null‬
‭D_STAIN_CHECK‬ ‭null‬
‭D_SCREEN_DAMAGE_CHECK‬ ‭null‬
‭D_MAJOR_BODY_DAMAGE_CHECK‬ ‭null‬
‭D_SWITCH_ON_CHECK‬ ‭null‬
‭D_BODY_DAMAGE_CHECK_LAPTOP_PREXO‬ ‭null‬
‭D_SCREEN_DAMAGE_TV‬ ‭null‬
‭D_BODY_DAMAGE_TV‬ ‭null‬
‭D_BODY_DAMAGE_REF‬ ‭null‬
‭D_BODY_DAMAGE_WM‬ ‭null‬
‭D_WORKING_CONDITION_TV‬ ‭null‬
‭D_WORKING_CONDITION_REF‬ ‭null‬
‭D_WORKING_CONDITION_WM‬ ‭null‬
‭D_BODY_DAMAGE_AC‬ ‭null‬
‭D_DISPLAY_PANEL_DAMAGE_CHECK_LAPTOP‬ ‭null‬
‭D_DISPLAY_ISSUE_CHECK_LAPTOP‬ ‭null‬
‭D_HINGES_DAMAGE_CHECK‬ ‭null‬
‭D_KEYS_MISSING_OR_DAMAGED_CHECK‬ ‭null‬
‭D_SCREEN_COMING_OUT_CHECK_MOBILE‬ ‭null‬
‭D_DISPLAY_ISSUE_CHECK_MOBILE‬ ‭null‬
‭D_BODY_DAMAGE_CRACKS_CHECK‬ ‭null‬
‭D_BODY_PARTS_MISSING_DAMAGED_CHECK‬ ‭null‬
‭D_BATTERY_BULGE_OR_BENT_CHECK‬ ‭null‬
‭D_FUNCTIONAL_CHECK‬ ‭null‬
‭D_BATTERY_MISSING_DAMAGED_CHECK‬ ‭null‬
‭D_RUST_DAMAGE_AC‬ ‭null‬
‭C_ICLOUD_LOCK_CHECK‬ ‭null‬
‭C_SERIAL_CHECK_LAPTOP_RVP‬ ‭SERIAL_NO‬
‭C_SERIAL_CHECK_LAPTOP_PREXO‬ ‭SERIAL_NO‬
‭C_SCREEN_LOCK_CHECK‬ ‭null‬
‭C_SIRI_CHECK‬ ‭null‬
‭C_LEGAL_INFO_CHECK‬ ‭null‬
‭C_SERIAL_CHECK_ON_BOX‬ ‭SERIAL_NO‬
‭C_SERIAL_CHECK‬ ‭SERIAL_NO‬
‭C_LAPTOP_PROCESSOR_CHECK‬ ‭PROCESSOR_TYPE‬
‭C_SERIAL_CHECK_ELECTRONICS‬ ‭SERIAL_NO‬
‭C_SERIAL_CHECK_LIFESTYLE‬ ‭SERIAL_NO‬
‭C_SERIAL_CHECK_WITHOUT_VALIDATION‬ ‭SERIAL_NO‬
‭C_SAMSUNG_FAKE_CHECK‬ ‭null‬
‭C_LAPTOP_DOA_SEAL_INTACT‬ ‭null‬
‭COMPLETION_CODE‬ ‭CODE‬
‭P_AVAILABILITY_CHECK‬ ‭ITEM_DESCRIPTION QUANTITY‬
‭P_TAG_AVAILABLE_CHECK‬ ‭null‬
‭P_BOX_AVAILABLE_CHECK‬ ‭null‬
‭P_BOX_CONDITION_CHECK‬ ‭null‬
‭P_WARRANTY_AVAILABLE_CHECK‬ ‭null‬
‭P_MRP_VALUE_CHECK‬ ‭MRP_VALUE‬
‭CHARGER_AVAILABLE_CHECK‬ ‭null‬
‭CHARGER_EARPHONE_AVAILABLE_CHECK‬ ‭null‬
‭P_DOA_SEAL_CHECK‬ ‭null‬
‭P_CHARGER_USB_AVAILABLE_CHECK‬ ‭ITEMS_NAME‬
‭P_BOX_AVAILABLE_CHECK_WITH_INPUT‬ ‭ITEM_NAME‬
‭COPPER_PIPE_AVAILABLE_CHECK_AC‬ ‭null‬
‭CHARGER_AVAILABLE_CHECK_WITH_INPUT‬ ‭ITEM_TYPE‬
‭P_QUANTITY_AC‬ ‭null‬
‭Sample Request Payload‬
‭{‬
‭"smart_checks": [{‬
‭"item_title": "BodyTantrumSolidMen'sGreyTrackPants",‬
‭"checks": {‬
‭"D_DAMAGE_CTH_CHECK": {‬
‭"inputs": {‬

}‭,‬
‭"is_mandatory": false‬
}‭,‬
‭"D_STAIN_CHECK": {‬
‭"inputs": {‬

}‭,‬
‭"is_mandatory": false‬
}‭,‬
‭"M_BRAND_CHECK_ON_PRODUCT_FOOTWEAR": {‬
‭"inputs": {‬
‭"brand_name": "BodyTantrum"‬
‭},‬
‭"is_mandatory": true‬
}‭,‬
‭"M_PRODUCT_IMAGE_COLOR_PATTERN_MATCH": {‬
‭"inputs": {‬
‭"item_image": "http: //www.abc.xyz"‬
‭},‬
‭"is_mandatory": true‬
‭},‬
‭"M_BRAND_CHECK_ON_PRODUCT_APPAREL": {‬
‭"inputs": {‬
‭"brand_name": "BodyTantrum"‬
‭},‬
‭"is_mandatory": true‬
‭},‬
‭"P_TAG_AVAILABLE_CHECK": {‬
‭"inputs": {‬

}‭,‬
‭"is_mandatory": true‬
‭}‬
‭}‬
‭}]‬
‭}‬

‭1.3 HandInHand(HIH) Services‬

‭Description‬
‭ he HIH services include product exchange and replacement. The payload will contain the information for‬
T
‭both the forward and the reverse legs in case of HIH services. The description of the fields have been‬
‭covered in earlier sections.‬

‭Sample Request Payload Prexo/REPLACEMENT‬


‭{‬
"‭ request_id":"R03",‬
‭"client_name":"CLIENT",‬
‭"goods_category": "ESSENTIAL",‬
‭"services":[‬
‭{‬
‭"service_code":"PREXO/REPLACEMENT"‬‭,‬
‭"service_details":[‬
‭{‬
‭"service_leg":"FORWARD",‬
‭"service_data":{‬
‭"vendor_name":"Ekart",‬
‭"amount_to_collect":1000,‬
‭"dispatch_date":"",‬
‭"customer_promise_date":"",‬
‭"delivery_type":"SMALL",‬
‭"source":{‬
‭"location_code":"d0449ad65da3447e"‬
‭},‬
‭"destination":{‬
‭"address":{‬
‭"first_name":"AVThamizhmahan",‬
‭"address_line1":"3/1675 ES Garden Vazhudaretty Post Villupuram",‬
‭"address_line2":"Tamil Nadu",‬
‭"pincode":"400066",‬
‭"city":"Villupuram",‬
‭"state":"Tamil Nadu",‬
‭"primary_contact_number":""‬
‭}‬
‭}‬
}‭,‬
‭"shipment":{‬
‭"client_reference_id":"ABCD",‬
‭"tracking_id":"CLTC0000000001",‬
‭"shipment_value":2000,‬
‭"shipment_dimensions":{‬
‭"length":{‬
‭"value":1‬
‭},‬
‭"breadth":{‬
‭"value":1‬
‭},‬
‭"height":{‬
‭"value":1‬
‭},‬
‭"weight":{‬
‭"value":1‬
‭}‬
‭},‬
‭"return_label_desc_1":"",‬
‭"return_label_desc_2":"",‬
‭"shipment_items":[‬
‭{‬
‭"Product_id":"134883075",‬
‭"category":"Apparel",‬
‭"product_title":"Mast&HarbourBlackHandbag: Handbags",‬
‭"quantity":1,‬
‭"cost":{‬
‭"total_sale_value":500,‬
‭"total_tax_value":100,‬
‭"tax_breakup":{‬
‭"cgst":0.0,‬
‭"sgst":0.0,‬
‭"igst":0.0‬
‭}‬
‭},‬
‭"seller_details":{‬
‭"seller_reg_name":"Seller Registered Legal Name",‬
‭"gstin_id":"asasas"‬
‭},‬
"‭ hsn":"",‬
‭"ern":"",‬
‭"item_attributes":[‬
‭{‬
‭"name":"order_id",‬
‭"value":"ABCD"‬
‭},‬
‭{‬
‭"name":"invoice_id",‬
‭"value":"INV1234"‬
‭},‬
‭{‬
‭"name":"item_dimensions",‬
‭"value":"l:b:h:w"‬
‭},‬
‭{‬
‭"name":"brand_name",‬
‭"value":"Peter England"‬
‭}‬
‭],‬
‭"handling_attributes":[‬
‭{‬
‭"name":"isFragile",‬
‭"value":"false"‬
‭},‬
‭{‬
‭"name":"isDangerous",‬
‭"value":"false"‬
‭}‬
‭]‬
‭}‬
]‭‬
‭"associated_tracking_ids"‬‭: [‬
‭"CLTR0000000002" //Tracking ID of the linked Reverse Shipment‬
‭]‬
‭}‬
}‭,‬
‭{‬
"‭ service_leg":"REVERSE",‬
‭"service_data":{‬
‭"vendor_name":"Ekart",‬
‭"amount_to_collect":0,‬
‭"delivery_type":"SMALL",‬
‭"source":{‬
‭"address":{‬
‭"first_name":"AVThamizhmahan",‬
‭"address_line1":"3/1675 ES Garden Vazhudaretty Post Villupuram",‬
‭"address_line2":"Tamil Nadu",‬
‭"pincode":"400066",‬
‭"city":"Villupuram",‬
‭"state":"Tamil Nadu",‬
‭"primary_contact_number":""‬
‭}‬
‭},‬
‭"destination":{‬
‭"location_code":"d0449ad65da3447e"‬
‭}‬
}‭,‬
‭"shipment":{‬
‭"client_reference_id":"ABCD",‬
‭"tracking_id":"CLTR0000000002",‬
‭"shipment_value":2000,‬
‭"shipment_items":[‬
‭{‬
‭"product_id":"134883075",‬
‭"product_title":"Mast&HarbourBlackHandbag: Handbags",‬
‭"item_content":{‬

}‭,‬
‭"category":"Apparel",‬
‭"quantity":1,‬
‭"cost":{‬
‭"total_sale_value":500,‬
‭"total_tax_value":100,‬
‭"tax_breakup":{‬
‭"cgst":100,‬
‭"sgst":0,‬
‭"igst":0‬
‭}‬
‭},‬
‭"seller_details":{‬
‭"seller_reg_name":"Seller Registered Legal Name",‬
‭"gstin_id":""‬
‭},‬
‭"item_attributes":[‬
‭{‬
‭"name":"order_id",‬
‭"value":"ABCD"‬
‭},‬
‭{‬
‭"name":"invoice_id",‬
‭"value":"INV1234"‬
‭}‬
‭],‬
‭"smart_checks":[‬
‭{‬
‭"item_title":"BodyTantrumSolidMen'sGreyTrackPants",‬
‭"checks":{‬
‭"D_DAMAGE_CTH_CHECK":{‬
‭"inputs":{‬

}‭,‬
‭"is_mandatory":false‬
}‭,‬
‭"D_STAIN_CHECK":{‬
‭"inputs":{‬

‭},‬
‭"is_mandatory":false‬
}‭,‬
‭"M_BRAND_CHECK_ON_PRODUCT_FOOTWEAR":{‬
‭"inputs":{‬
‭"brand_name":"BodyTantrum"‬
‭},‬
‭"is_mandatory":true‬
‭},‬
‭"M_BRAND_CHECK_ON_PRODUCT_APPAREL":{‬
‭"inputs":{‬
‭"brand_name":"BodyTantrum"‬
‭},‬
‭"is_mandatory":true‬
‭},‬
‭"P_TAG_AVAILABLE_CHECK":{‬
‭"inputs":{‬

}‭,‬
‭"is_mandatory":true‬
‭}‬
‭}‬
‭}‬
‭]‬
‭}‬
‭]‬
‭}‬
‭}‬
‭]‬
‭}‬
‭]‬
‭}‬

‭Sample Response Payload‬


‭{‬
‭"response": [‬
‭{‬
‭"tracking_id": "CLTC0000000001",‬
‭"status": "REQUEST_RECEIVED"‬
‭},‬
‭{‬
‭"tracking_id": "CLTR0000000002",‬
‭"status": "REQUEST_RECEIVED"‬
‭}‬
‭],‬
‭"request_id": "a1e60b4f-4e21-420c-a3a9-6c5c2556d5a8"‬
‭}‬
‭2. Track Shipment API‬
‭ he track shipment API allows clients to track a shipment(s). Can provide a comma separated list of‬
T
‭tracking IDs in payload. Using this API client can pull the data of an ongoing shipment or a delivered‬
‭shipment. Please find list of all the status and their description‬‭here‬‭.‬

‭ tage API URL -‬‭https://staging.ekartlogistics.com/v2/shipments/track‬


S
‭Production API URL -‬‭https://api.ekartlogistics.com/v2/shipments/track‬

‭ ttp Method Type -‬‭POST‬


H
‭Headers-‬
‭●‬ ‭Content-Type : application/json‬
‭●‬ ‭HTTP_X_MERCHANT_CODE : (As shared by Ekart Team)‬
‭●‬ ‭Authorization : Bearer <Token>‬

‭Sample Request Payload‬


‭{"tracking_ids":["CLTC0000000001"]}‬

‭Sample Response Payload‬


‭ uccess‬
S
‭{‬
‭"CLTC0000000001": {‬
‭"shipment_type": "COD",‬
‭"cod_amount": "1999.0",‬
‭"shipment_id": "CLTC0000000001",‬
‭"shipment_value": "1999.0",‬
‭"order_id": "5180823923081454",‬
‭"external_tracking_id": "CLTC0000000001",‬
‭"delivery_type": "small",‬
‭"weight": "0.0",‬
‭"‭d‬ elivered‬‭": true,‬
‭"merchant_name": "ABC",‬
‭"history": [‬
‭{‬
‭"city": "Nirsa",‬
‭"‭s‬ tatus‬‭": "delivered",‬
‭"hub_notes": "30161417, Vikash Kumar Saw_1087905, ",‬
‭"cs_notes": "",‬
‭"‭e ‬ vent_date‬‭": "2018-08-28T18:03:33+0530",‬
‭"event_date_iso8601": "2018-08-28T18:03:33.000+05:30",‬
‭"hub_name": "NirsaHub_NRA",‬
‭"updated_datetime": "2018-08-28T18:03:33+0530",‬
‭"public_description": "Delivered to Customer"‬
‭},‬
‭{‬
‭"city": "Nirsa",‬
‭"status": "out_for_delivery",‬
‭"hub_notes": "30161417, Vikash Kumar Saw_1087905, ",‬
‭"cs_notes": "",‬
"‭ event_date": "2018-08-28T07:38:28+0530",‬
‭"event_date_iso8601": "2018-08-28T07:38:28.000+05:30",‬
‭"hub_name": "NirsaHub_NRA",‬
‭"updated_datetime": "2018-08-28T07:38:28+0530",‬
‭"public_description": "Out for delivery"‬
}‭,‬
‭{‬
"‭ city": "New Delhi",‬
‭"status": "in_transit",‬
‭"hub_notes": "",‬
‭"cs_notes": "",‬
‭"event_date": "2018-08-24T23:48:41+0530",‬
‭"event_date_iso8601": "2018-08-24T23:48:41.000+05:30",‬
‭"hub_name": "Bamnoli Sort Centre",‬
‭"updated_datetime": "2018-08-24T23:48:41+0530",‬
‭"public_description": "Received at Bamnoli Sort Centre"‬
}‭,‬
‭{‬
"‭ city": "New Delhi",‬
‭"status": "in_transit",‬
‭"hub_notes": "",‬
‭"cs_notes": "",‬
‭"event_date": "2018-08-24T23:48:41+0530",‬
‭"event_date_iso8601": "2018-08-24T23:48:41.000+05:30",‬
‭"hub_name": "Bamnoli Sort Centre",‬
‭"updated_datetime": "2018-08-24T23:48:41+0530",‬
‭"public_description": "Shipment in-scanned at Bamnoli Sort Centre"‬
}‭,‬
‭{‬
"‭ city": "New Delhi",‬
‭"status": "in_transit",‬
‭"hub_notes": "",‬
‭"cs_notes": "",‬
‭"event_date": "2018-08-24T23:48:41+0530",‬
‭"event_date_iso8601": "2018-08-24T23:48:41.000+05:30",‬
‭"hub_name": "Bamnoli Sort Centre",‬
‭"updated_datetime": "2018-08-24T23:48:41+0530",‬
‭"public_description": "Dispatched to Bamnoli Sort Centre"‬
}‭,‬
‭{‬
"‭ status": "in_transit",‬
‭"event_date": "2018-08-24T23:48:42+0530",‬
‭"event_date_iso8601": "2018-08-24T23:48:42+05:30",‬
‭"city": "Dwarka",‬
‭"description": "Dispatched to Ekart Logistics",‬
‭"public_description": "Dispatched to Ekart Logistics",‬
‭"cs_notes": null‬
}‭,‬
‭{‬
"‭ status": "in_transit",‬
‭"event_date": "2018-08-24T23:48:40+0530",‬
‭"event_date_iso8601": "2018-08-24T23:48:40+05:30",‬
‭"city": "Dwarka",‬
‭"description": "Received At EKL_Bamnoli1 ",‬
"‭ public_description": "Received At EKL_Bamnoli1 ",‬
‭"cs_notes": null‬
}‭,‬
‭{‬
"‭ status": "in_transit",‬
‭"event_date": "2018-08-24T19:41:23+0530",‬
‭"event_date_iso8601": "2018-08-24T19:41:23+05:30",‬
‭"city": "Dwarka",‬
‭"description": "dispatched_to_tc",‬
‭"public_description": "dispatched_to_tc",‬
‭"cs_notes": null‬
}‭,‬
‭{‬
"‭ status": "pickup_complete",‬
‭"event_date": "2018-08-24T17:27:14+0530",‬
‭"event_date_iso8601": "2018-08-24T17:27:14+05:30",‬
‭"city": "Dwarka",‬
‭"description": "shipment_pickup_complete",‬
‭"public_description": "shipment_pickup_complete",‬
‭"cs_notes": null‬
}‭,‬
‭{‬
"‭ status": "out_for_pickup",‬
‭"event_date": "2018-08-24T10:24:02+0530",‬
‭"event_date_iso8601": "2018-08-24T10:24:02+05:30",‬
‭"city": "Bangalore",‬
‭"description": "shipment_out_for_pickup",‬
‭"public_description": "shipment_out_for_pickup",‬
‭"cs_notes": null‬
}‭,‬
‭{‬
"‭ status": "pickup_scheduled",‬
‭"event_date": "2018-08-23T12:15:35+0530",‬
‭"event_date_iso8601": "2018-08-23T12:15:35+05:30",‬
‭"city": "Bangalore",‬
‭"description": "Expected at ekl-marketplace ",‬
‭"public_description": "Expected at ekl-marketplace ",‬
‭"cs_notes": null‬
}‭,‬
‭{‬
"‭ status": "shipment_created",‬
‭"event_date": "2018-08-23T12:15:35+0530",‬
‭"event_date_iso8601": "2018-08-23T12:15:35+05:30",‬
‭"city": "Bangalore",‬
‭"description": "Dispached by Seller",‬
‭"public_description": "Dispached by Seller",‬
‭"cs_notes": null‬
‭}‬
]‭,‬
‭"receiver": {‬
‭"name": "RAJEEV",‬
‭"releation": "Self",‬
‭"relation": "Self",‬
‭"phone_number": "7777777777"‬
}‭,‬
‭"current_hub": {‬
‭"name": "NirsaHub_NRA",‬
‭"address1": "New Bhamal, Shop No 1, Near Bank of India, Jamtara Road, Nirsa, Dhanbad - 828205",‬
‭"address2": "null",‬
‭"city": "Nirsa",‬
‭"state": "Jharkhand",‬
‭"country": "India",‬
‭"pincode": "828206",‬
‭"zone": "East",‬
‭"description": null,‬
‭"display_name": "NirsaHub_NRA",‬
‭"coc_code": "NRA/NRA"‬
‭},‬
‭"assigned_hub": {‬
‭"name": "NirsaHub_NRA",‬
‭"address1": "New Bhamal, Shop No 1, Near Bank of India, Jamtara Road, Nirsa, Dhanbad - 828205",‬
‭"address2": "null",‬
‭"city": "Nirsa",‬
‭"state": "Jharkhand",‬
‭"country": "India",‬
‭"pincode": "828206",‬
‭"zone": "East",‬
‭"description": null,‬
‭"display_name": "NirsaHub_NRA",‬
‭"coc_code": "NRA/NRA"‬
‭},‬
‭"sender": {‬
‭"city": "Bangalore",‬
‭"state": "Karnataka",‬
‭"pincode": "560067",‬
‭"address1": "ABC Pvt. Ltd",‬
‭"address2": "Bangalore, 560067. ",‬
‭"phone": null,‬
‭"email": null,‬
‭"name": "abc.com"‬
‭},‬
‭"customer": {‬
‭"city": "CHIRKUNDA",‬
‭"country": "",‬
‭"pincode": "828203",‬
‭"address1": "CHIRKUNDAEGARCOOR",‬
‭"address2": "HOTEL SUNNY",‬
‭"name": "RAJEEV",‬
‭"state": "JHARKHAND",‬
‭"phone": "7777777777",‬
‭"email": null‬
‭},‬
‭"items": [‬
‭{‬
‭"order_id": "5180823923081454",‬
‭"item_type": "Apparel",‬
‭"item_price": 1999,‬
‭"item_description": "Apparel"‬
‭}‬
]‭,‬
‭"vendor": "E-Kart Logistics",‬
‭"mh_inscanned": true,‬
‭"rto_detail": null,‬
‭"slotted_delivery": true,‬

‭"‬‭expected_delivery_slot‬‭": { // for large‬‭slotted delivery‬


‭"start_time": "2018-08-30 20:00:00",‬
‭"end_time": "2018-08-30 22:00:00",‬
‭},‬

"‭ ‭e ‬ xpected_delivery_date‬‭": "2018-08-30 23:59:59",‬‭// for non slotted delivery‬


‭"‭r‬ to‬‭": false,‬
‭"shipment_notes": [‬
‭{‬
‭"created_at": "2018-08-24T23:48:42+05:30",‬
‭"id": 2837675632,‬
‭"note": "AUTO-API-CALL",‬
‭"note_type": "vendor",‬
‭"shipment_id": 764493202,‬
‭"shipment_status_history_id": 6214675716,‬
‭"updated_at": "2018-08-24T23:48:42+05:30"‬
‭}‬
‭],‬
‭"shipment_tickets": null‬
‭}‬
‭}‬

‭ ailure‬
F
‭Rate limit Exceeded - 403 Response status‬
‭{‬
‭"forbidden": "Rate limit exceeded"‬
‭}‬

‭3. Serviceability and SLA API‬


‭The serviceability and SLA API allows clients to check the serviceability and SLA to service that request.‬

‭3.1 Forward‬
‭ tage API URL -‬‭https://staging.ekartlogistics.com/‬‭v1/offerings‬
S
‭Production API URL -‬‭https://api.ekartlogistics.com/v1/offerings‬

‭ ttp Method Type -‬‭POST‬


H
‭Headers-‬
‭●‬ ‭Content-Type : application/json‬
‭●‬ ‭HTTP_X_MERCHANT_CODE : (As shared by Ekart Team)‬
‭●‬ ‭Authorization : Bearer <Token>‬
‭Input Parameters‬
‭ he section contains the description of all the fields available (including the optional fields) in the‬
T
‭serviceability and SLA API for Forward type shipment.‬

‭Attribute‬ ‭Values expected‬ ‭Validation/‬ ‭Error Message‬


‭(Mandatory - yes/no)‬ ‭ onstraints‬
C

r‭ equest_id‬ ‭ string to identify the‬


A
‭(Mandatory - No)‬ ‭request.‬

‭ ustomer_pincode‬
c ‭ incode of the destination‬
P ‭ hould not be null or‬
S ‭Pincode is Invalid‬
‭(Mandatory - Yes)‬ ‭location.‬ ‭empty‬

‭ hould strictly be a 6‬
S
‭digit pincode‬

‭ eller_pincode‬
s ‭Pincode of the seller location.‬ ‭ hould not be null or‬
S ‭ eller Pincode cannot‬
S
‭(Mandatory - Yes)‬ ‭empty‬ ‭be null‬

‭ hould strictly be a 6‬
S ‭Pincode is Invalid‬
‭digit pincode‬

r‭ to_pincode‬ ‭ incode of the location where‬


P ‭ hould not be null or‬
S ‭Pincode is Invalid‬
‭(Mandatory - No)‬ ‭the shipment will be returned‬ ‭empty‬
‭if RTO‬
‭ hould strictly be a 6‬
S
‭digit pincode‬

l‭ength‬ ‭Length of the shipment (cms)‬


‭(Mandatory - No)‬

‭ readth‬
b ‭Breadth of the shipment (cms)‬
‭(Mandatory - No)‬

‭ eight‬
h ‭Height of the shipment (cms)‬
‭(Mandatory - No)‬

‭ eight‬
w ‭Weight of the shipment (kg)‬
‭(Mandatory - No)‬

‭ ispatch_date‬
d I‭ndicates the dispatch date of‬ ‭ hould be in date‬
S ‭Invalid Date Format‬
‭(Mandatory - No)‬ ‭the shipment.‬ ‭format given below:‬
‭yyyy-MM-dd‬
‭HH:mm:ss‬
‭And in Indian‬
‭standard time zone‬
‭(GMT+5:30)‬
‭ elivery_type‬
d I‭ndicates whether the‬ ‭Should not be empty‬ ‭Invalid delivery type‬
‭(Mandatory - No)‬ ‭shipment is small, medium or‬
‭large shipment (as per Ekart’s‬ ‭ efault value is‬
D
‭definition). Should be one of:‬ ‭SMALL‬
‭1.‬ ‭SMALL‬
‭2.‬ ‭MEDIUM‬
‭3.‬ ‭LARGE‬

i‭s_dangerous‬ I‭ndicates whether the‬ ‭Default value is false‬


‭(Mandatory - No)‬ ‭shipment item is dangerous.‬

i‭s_fragile‬ I‭ndicates whether the‬ ‭Default value is false‬


‭(Mandatory - No)‬ ‭shipment item is fragile.‬

‭ ervice_type‬
s I‭ndicates the type of service‬ ‭ hould not be null or‬
S ‭Invalid service type‬
‭(Mandatory - Yes)‬ ‭request. Should be FORWARD‬ ‭empty.‬

‭Sample Request Payload‬


{‬

"request_id": "82b317b3-8c7c-4fdd-ac78-6726f6e67f3b",‬

"dispatch_date": "2020-03-20 23:30:00",‬

"customer_pincode": "560034",‬

"seller_pincode": "400045",‬

"rto_pincode": "600032",‬

"length": 20.0,‬

"breadth": 0.5,‬

"height": 1.3,‬

"weight": 2.6,‬

"delivery_type": "Small",‬

"service_type": "FORWARD",‬

"is_dangerous": true,‬

"is_fragile": false‬

}‬

‭Sample Response Payload‬


‭Success‬
{‬

"request_id": "82b317b3-8c7c-4fdd-ac78-6726f6e67f3b",‬

"serviceable": true,‬

"lane": "METRO",‬

"allowed_goods_category": "Essentials",‬

"prexo": true,‬

"prepaid_limit": 1000000,‬

"cod_limit": 49999,‬

"connections": {‬

"REGULAR": {‬

"serviceable": true,‬

"SLA": "3 days",‬

"packaging_requirement": "Any"‬

},‬

"ECONOMY": {‬

"serviceable": true,‬

"SLA": "5 days",‬

"packaging_requirement": "NonPlastic"‬

}‬

},‬

"rvp": true,‬

"cod": true‬

}‬

‭ ailure‬
F
‭Rate limit Exceeded - 403 Response status‬
{‬

"forbidden": "Rate limit exceeded"‬

}‬

‭3.2 Reverse‬
‭ tage API URL -‬‭https://staging.ekartlogistics.com/‬‭v1/offerings‬
S
‭Production API URL -‬‭https://api.ekartlogistics.com/v1/offerings‬

‭ ttp Method Type -‬‭POST‬


H
‭Headers-‬
‭●‬ ‭Content-Type : application/json‬
‭●‬ ‭HTTP_X_MERCHANT_CODE : (As shared by Ekart Team)‬
‭●‬ ‭Authorization : Bearer <Token>‬
‭Input Parameters‬
‭ he section contains the description of all the fields available (including the optional fields) in the‬
T
‭serviceability and SLA API for Reverse type shipment.‬

‭Attribute‬ ‭Values expected‬ ‭Validation/‬ ‭Error Message‬


‭(Mandatory - yes/no)‬ ‭ onstraints‬
C

r‭ equest_id‬ ‭ string to identify the‬


A
‭(Mandatory - No)‬ ‭request.‬

‭ ustomer_pincode‬
c ‭ incode of the source‬
P ‭ hould not be null or‬
S ‭Pincode is Invalid‬
‭(Mandatory - Yes)‬ ‭location.‬ ‭empty‬

‭ hould strictly be a 6‬
S
‭digit pincode‬

‭ eller_pincode‬
s ‭Pincode of the seller location.‬ ‭ hould not be null or‬
S ‭ oth seller and RC‬
B
‭(Mandatory - One of‬ ‭empty‬ ‭Pincode cannot be null.‬
‭seller_pincode or‬
‭rc_pincode is mandatory.‬ ‭ hould strictly be a 6‬
S ‭Pincode is Invalid.‬
‭If both present rc_pincode‬ ‭digit pincode‬
‭will be considered for‬
‭serviceability.)‬

r‭ c_pincode‬ ‭ incode of the location where‬


P ‭ hould not be null or‬
S ‭ oth seller and RC‬
B
‭(Mandatory - One of‬ ‭the shipment will be returned.‬ ‭empty‬ ‭Pincode cannot be null.‬
‭seller_pincode or‬
‭rc_pincode is mandatory.‬ ‭ hould strictly be a 6‬
S ‭Pincode is Invalid‬
‭If both present rc_pincode‬ ‭digit pincode‬
‭will be considered for‬
‭serviceability.)‬

l‭ength‬ ‭Length of the shipment (cms)‬


‭(Mandatory - No)‬

‭ readth‬
b ‭Breadth of the shipment (cms)‬
‭(Mandatory - No)‬

‭ eight‬
h ‭Height of the shipment (cms)‬
‭(Mandatory - No)‬

‭ eight‬
w ‭Weight of the shipment (kg)‬
‭(Mandatory - No)‬

‭ ispatch_date‬
d I‭ndicates the dispatch date of‬ ‭ hould be in date‬
S ‭Invalid Date Format‬
‭(Mandatory - No)‬ ‭the shipment.‬ ‭format given below:‬
‭yyyy-MM-dd‬
‭HH:mm:ss‬
‭And in Indian‬
s‭ tandard time zone‬
‭(GMT+5:30)‬

‭ elivery_type‬
d I‭ndicates whether the‬ ‭Should not be empty‬ ‭Invalid delivery type‬
‭(Mandatory - No)‬ ‭shipment is small, medium or‬
‭large shipment (as per Ekart’s‬ ‭ efault value is‬
D
‭definition). Should be one of:‬ ‭SMALL‬
‭SMALL‬
‭MEDIUM‬
‭LARGE‬

i‭s_dangerous‬ I‭ndicates whether the‬ ‭Default value is false‬


‭(Mandatory - No)‬ ‭shipment item is dangerous.‬

i‭s_fragile‬ I‭ndicates whether the‬ ‭Default value is false‬


‭(Mandatory - No)‬ ‭shipment item is fragile.‬

‭ ervice_type‬
s I‭ndicates the type of service‬ ‭ hould not be null or‬
S ‭Invalid service type‬
‭(Mandatory - Yes)‬ ‭request. Should be REVERSE‬ ‭empty.‬

‭Sample Request Payload‬


{‬

"request_id": "82b317b3-8c7c-4fdd-ac78-6726f6e67f3b",‬

"dispatch_date": "2020-03-20 23:30:00",‬

"customer_pincode": "560034",‬

"seller_pincode": "400045",‬

"rc_pincode": "600032",‬

"length": 20.0,‬

"breadth": 0.5,‬

"height": 1.3,‬

"weight": 2.6,‬

"delivery_type": "Small",‬

"service_type": "REVERSE",‬

"is_dangerous": true,‬

"is_fragile": false‬

}‬

‭Sample Response Payload‬


‭Success‬
{‬

"request_id": "82b317b3-8c7c-4fdd-ac78-6726f6e67f3b",‬

"serviceable": true,‬

"lane": "LOCAL",‬

"allowed_goods_category": "Any",‬

"connections": {‬

"REGULAR": {‬

"serviceable": true,‬

"SLA": "5 days"‬

},‬

"ECONOMY": {‬

"serviceable": false,‬

"reason": "NO_PICKUP_SERVICEABLE_VENDOR No vendor has pickup‬

serviceability"‬

}‬

}‬

}‬

‭ ailure‬
F
‭Rate limit Exceeded - 403 Response status‬
{‬

"forbidden": "Rate limit exceeded"‬

}‬

‭3.3 Prexo/Replacement‬
‭ tage API URL -‬‭https://staging.ekartlogistics.com/‬‭v1/offerings‬
S
‭Production API URL -‬‭https://api.ekartlogistics.com/v1/offerings‬

‭ ttp Method Type -‬‭POST‬


H
‭Headers-‬
‭●‬ ‭Content-Type : application/json‬
‭●‬ ‭HTTP_X_MERCHANT_CODE : (As shared by Ekart Team)‬
‭●‬ ‭Authorization : Bearer <Token>‬

‭Input Parameters‬
‭ he section contains the description of all the fields available (including the optional fields) in the‬
T
‭serviceability and SLA API for Prexo/Replacement type shipment.‬

‭Attribute‬ ‭Values expected‬ ‭Validation/‬ ‭Error Message‬


‭(Mandatory - yes/no)‬ ‭ onstraints‬
C

r‭ equest_id‬ ‭ string to identify the‬


A
‭(Mandatory - No)‬ ‭request.‬
‭ ustomer_pincode‬
c ‭ incode of the destination‬
P ‭ hould not be null or‬
S ‭Pincode is Invalid‬
‭(Mandatory - Yes)‬ ‭location.‬ ‭empty‬

‭ hould strictly be a 6‬
S
‭digit pincode‬

‭ eller_pincode‬
s ‭Pincode of the seller location.‬ ‭ hould cannot be null‬
S ‭ ource Pincode cannot‬
S
‭(Mandatory - Yes)‬ ‭or empty‬ ‭be null‬

‭ hould strictly be a 6‬
S ‭Pincode is Invalid.‬
‭digit pincode‬

r‭ to_pincode‬ ‭ incode of the location where‬


P ‭ hould not be null or‬
S ‭Pincode is Invalid‬
‭(Mandatory - No)‬ ‭the forward leg shipment will‬ ‭empty‬
‭be returned if RTO‬
‭ hould strictly be a 6‬
S
‭digit pincode‬

r‭ c_pincode‬ ‭ incode of the location where‬


P ‭ hould not be null or‬
S ‭Pincode is Invalid‬
‭(Mandatory - No)‬ ‭the reverse leg shipment will‬ ‭empty‬
‭be returned‬
‭ hould strictly be a 6‬
S
‭digit pincode‬

l‭ength‬ ‭Length of the shipment (cms)‬


‭(Mandatory - No)‬

‭ readth‬
b ‭Breadth of the shipment (cms)‬
‭(Mandatory - No)‬

‭ eight‬
h ‭Height of the shipment (cms)‬
‭(Mandatory - No)‬

‭ eight‬
w ‭Weight of the shipment (kg)‬
‭(Mandatory - No)‬

‭ ispatch_date‬
d I‭ndicates the dispatch date of‬ ‭ hould be in date‬
S ‭Invalid Date Format‬
‭(Mandatory - No)‬ ‭the shipment.‬ ‭format given below:‬
‭yyyy-MM-dd‬
‭HH:mm:ss‬
‭And in Indian‬
‭standard time zone‬
‭(GMT+5:30)‬

‭ elivery_type‬
d I‭ndicates whether the‬ ‭Should not be empty‬ ‭Invalid delivery type‬
‭(Mandatory - No)‬ ‭shipment is small, medium or‬
‭large shipment (as per Ekart’s‬ ‭ efault value is‬
D
‭definition). Should be one of:‬ ‭SMALL‬
‭SMALL‬
‭MEDIUM‬
‭LARGE‬

i‭s_dangerous‬ I‭ndicates whether the‬ ‭Default value is false‬


‭(Mandatory - No)‬ ‭shipment item is dangerous.‬

i‭s_fragile‬ I‭ndicates whether the‬ ‭Default value is false‬


‭(Mandatory - No)‬ ‭shipment item is fragile.‬

‭ ervice_type‬
s I‭ndicates the type of service‬ ‭ hould not be null or‬
S ‭Invalid service type‬
‭(Mandatory - Yes)‬ ‭request. Should be PREXO or‬ ‭empty.‬
‭REPLACEMENT‬

‭Sample Request Payload‬


{‬

"request_id": "82b317b3-8c7c-4fdd-ac78-6726f6e67f3b",‬

"dispatch_date": "2020-03-20 23:30:00",‬

"customer_pincode": "560034",‬

"seller_pincode": "400045",‬

"rto_pincode": "600032",‬

"rc_pincode": "600032",‬

"length": 20.0,‬

"breadth": 0.5,‬

"height": 1.3,‬

"weight": 2.6,‬

"delivery_type": "Small",‬

"service_type": "PREXO",‬

"is_dangerous": true,‬

"is_fragile": false‬

}‬

‭Sample Response Payload‬


‭Success‬
{‬

"request_id": "82b317b3-8c7c-4fdd-ac78-6726f6e67f3b",‬

"serviceable": true,‬

"lane": "ZONAL",‬

"allowed_goods_category": "Essentials",‬

"prepaid_limit": 1000000,‬

"cod_limit": 49999,‬

"connections": {‬

"REGULAR": {‬

"serviceable": true,‬

"SLA": "5 days",‬

"packaging_requirement": "NonPlastic"‬

},‬

"ECONOMY": {‬

"serviceable": false,‬

"reason": "NO_PICKUP_SERVICEABLE_VENDOR No vendor has pickup‬

serviceability"‬

}‬

},‬

"cod": true‬

}‬

‭Failure‬
‭Rate limit Exceeded - 403 Response status‬
{‬

"forbidden": "Rate limit exceeded"‬

}‬

‭4. Critical Updates Integration‬


‭ his is an optional feature, but is very helpful to get live updates of all the important events in a shipment‬
T
‭lifecycle. To enroll for this feature,‬‭the client‬‭client‬‭needs to share an https endPoint with the Ekart team, and‬
‭Ekart will send all the updates of the shipment at this endpoint along with the Tracking Id/AWB Number.‬
‭Please find details of all push updates‬‭here‬

‭Sample Push Update Payload‬


‭{‬
‭"reason": "",‬
‭"sub_reasons": [],‬
‭"request_id": null,‬
‭"vendor_tracking_id": "ABCC0001201928",‬
‭"merchant_reference_id": "ABCC0001201928",‬
‭"status": "delivered",‬
‭"shipment_type": "OutgoingShipment",‬
‭"remarks": "",‬
‭"merchant_code": "ABC",‬
‭"merchant_name": "ABC Corp.",‬
‭"event_date": "2019-01-27 20:47:52",‬
‭"courier_name": "flipkartlogistics-cod",‬
‭"seller_id": "ABC",‬
"‭ location": "fkl_Binola_ABC",‬
‭"event": "shipment_delivered"‬
‭}‬

‭Slotted update (in case of large slotted delivery)‬

‭{‬
‭"reason": "",‬
‭"sub_reasons": [],‬
‭"request_id": null,‬
‭"vendor_tracking_id": "ABCC0001201928",‬
‭"merchant_reference_id": "ABCC0001201928",‬
‭"status": "delivered",‬
‭"shipment_type": "OutgoingShipment",‬
‭"remarks": "",‬
‭"merchant_code": "ABC",‬
‭"merchant_name": "ABC Corp.",‬
‭"event_date": "2019-01-27 20:47:52",‬
‭"expected_delivery_slot": {‬
‭"start_time": "2019-01-27 20:47:52",‬
‭"end_time": "2019-01-27 20:47:52",‬
‭},‬
‭"event_date": "2019-01-27 20:47:52",‬
‭"courier_name": "flipkartlogistics-cod",‬
‭"seller_id": "ABC",‬
‭"location": "fkl_Binola_ABC",‬
‭"event": "slot_update"‬
‭}‬

‭4. Cancel/RTO API‬


‭ he create RTO API allows client to create an RTO for a shipment. This request will be allowed if the‬
T
‭shipment is not Out_for_delivery or if the shipment has not been already delivered.‬‭This is not allowed‬‭for‬
‭large post pickup‬

‭ tage API URL:‬‭https://staging.ekartlogistics.com/v2/shipments/rto/create‬


S
‭Production API URL:‬‭https://api.ekartlogistics.com/v2/shipments/rto/create‬

‭Http Method Type -‬‭PUT‬

‭Headers-‬
‭●‬ ‭HTTP_X_MERCHANT_CODE : (As shared by Ekart Team)‬
‭●‬ ‭Authorization : Bearer <Token>‬

‭Sample Request Payload‬


‭{‬
‭"request_id": "R04",‬
‭"request_details": [‬
‭{‬
‭"tracking_id": "CLTC0000000001",‬
‭"reason": "Reason for cancellation"‬
‭}‬
]‭‬
‭}‬

‭Sample Response Payload‬


‭ uccess‬
S
‭{‬
‭"request_id": "R04",‬
‭"response_details": [‬
‭{‬
‭"tracking_id": "CLTC0000000001",‬
‭"status": "REQUEST_RECEIVED/REQUEST_REJECTED",‬
‭"message": "Reason for Request Rejection"‬
‭}‬
‭]‬
‭}‬

‭ ailure‬
F
‭Rate limit Exceeded - 403 Response status‬
‭{‬
‭"forbidden": "Rate limit exceeded"‬
‭}‬

‭5. Cancel RVP API‬


‭ ancel RVP Api allows clients to Cancel RVP Pickups for a shipment. This request will be allowed if the‬
C
‭shipment is not picked. Cancellation won’t be allowed post pickups. Only single shipment is applicable as‬
‭part of a single RVP request.‬

‭ tage API URL:‬‭https://staging.ekartlogistics.com/v2/shipments/rvp/cancel‬


S
‭Production API URL:‬‭https://api.ekartlogistics.com/v2/shipments/rvp/cancel‬

‭Http Method Type -‬‭PUT‬

‭Headers-‬

‭‬ H
● ‭ TTP_X_MERCHANT_CODE : (As shared by Ekart Team)‬
‭●‬ ‭Authorization : Bearer <Token>‬

‭Sample Request Payload‬


‭{‬
‭"request_id": "R04",‬
‭"request_details": [‬
‭{‬
‭"tracking_id": “<trackingId>”,‬
‭"reason": “<Reason for Cancellation>”‬
‭}‬
‭]‬
‭}‬

‭Sample Response Payload‬


‭ uccess 200‬
S
‭{‬
‭"request_id": "R04",‬
‭"response_details": [‬
‭{‬
‭"tracking_id": "<trackingId>",‬
‭"status": "REQUEST_RECEIVED",‬
‭"status_code": 200‬
‭}‬
‭]‬
‭}‬

‭ ailure‬
F
‭Bad Request 400‬
‭{‬
‭"request_id": "R04",‬
‭"response_details": [‬
‭{‬
‭"tracking_id": "<trackingId>",‬
‭"status": "REQUEST_REJECTED",‬
‭“message”: [“<error message>”]‬
‭}‬
‭]‬
‭}‬

‭ ate limit Exceeded - 403 Response status‬


R
‭{‬
‭"forbidden": "Rate limit exceeded"‬
‭}‬

‭6. Update Shipment API‬


‭ he update shipment API allows client to update selected fields in the create shipment request.‬‭This is not‬
T
‭allowed for large.‬

‭ tage API URL -‬‭https://staging.ekartlogistics.com/v2/shipments/‬‭update‬


S
‭Production API URL -‬‭https://api.ekartlogistics.com/v2/shipments/‬‭update‬
‭ ttp Method Type -PUT‬
H
‭Headers-‬
‭●‬ ‭Content-Type : application/json‬
‭●‬ ‭HTTP_X_MERCHANT_CODE : (As shared by Ekart Team)‬
‭●‬ ‭Authorization : Bearer <Token>‬

‭Sample Request Payload‬


‭{‬
"‭ request_id": "R08",‬
‭"tracking_id": "CLTC0000000001",‬
‭"update_request_details": {‬
‭"service_data": {‬
‭"dispatch_date": "2017-03-02 00:00:00",‬
‭},‬
‭"shipment": {‬
‭"shipment_dimensions": {‬
‭"weight": {‬
‭"value": 1‬
‭}‬
‭}‬
‭}‬
‭}‬
‭}‬

‭Response‬
‭{‬
"‭ request_id": "R08",‬
‭"response_details": [‬
‭{‬
‭"tracking_id": "CLTC0000000001",‬
‭"status": "REQUEST_RECEIVED/REQUEST_REJECTED",‬
‭"message": "Reason for Request Rejection"‬
‭}‬
‭]‬
‭}‬

‭6.1 Update Dispatch_Date‬

‭ his allows the client to update the dispatch_date if the client is passing the value of delayed_dispatch flag‬
T
‭as true in the create request.‬‭This is not allowed‬‭for large. Pls note that if you are passing the‬
‭delayed_dispatch flag as TRUE then the pickup date will be d+30.‬

‭Sample Request Payload‬


‭{‬
"‭ request_id": "R08",‬
‭"tracking_id": "CLTC0000000001",‬
‭"update_request_details": {‬
‭"service_data": {‬
‭"dispatch_date": "2017-03-02 00:00:00"‬
‭},‬
‭"shipment": {}‬
‭}‬
‭}‬

‭Sample Response Payload‬


‭Success‬
{‭‬
‭"request_id": "R08",‬
‭"response_details": [‬
‭{‬
‭"tracking_id": "CLTC0000000001",‬
‭"status": "REQUEST_RECEIVED/REQUEST_REJECTED",‬
‭"message": "Reason for Request Rejection"‬
‭}‬
‭]‬
‭}‬

‭ ailure‬
F
‭Rate limit Exceeded - 403 Response status‬
‭{‬
‭"forbidden": "Rate limit exceeded"‬
‭}‬

‭6.2 RFR, Update Customer Contact, Update Customer Address‬

‭ tage API URL -‬‭https://staging.ekartlogistics.com/v2/shipments/update_shipment‬


S
‭Production API URL -‬‭https://api.ekartlogistics.com/v2/shipments/update_shipment‬

‭ ttp Method Type -PUT‬


H
‭Headers-‬
‭●‬ ‭Content-Type : application/json‬
‭●‬ ‭HTTP_X_MERCHANT_CODE : (As shared by Ekart Team)‬
‭●‬ ‭Authorization : Bearer <Token>‬

‭ FR:‬
R
‭{‬
‭"update_request_type": "RESCHEDULE_DELIVERY_DATE",‬
‭"update_request_details": {‬
‭"updated_delivery_date": "2022-11-04"‬
‭},‬
‭"tracking_id": "<tracking_id>"‬
‭}‬
‭Update Customer Contact:‬
‭​{‬
‭"tracking_id": "<tracking_id>",‬
‭"update_request_type": "CUSTOMER_CONTACT",‬
‭"update_request_details": {‬
‭"customer_address": {‬
‭"primary_contact_number": “<phone_number>”‬
‭}‬
‭}‬
‭}‬

‭ pdate Customer Address:‬


U
‭{‬
‭"tracking_id": "<tracking_id>",‬
‭"update_request_type": "CUSTOMER_DETAILS",‬
‭"update_request_details": {‬
‭"customer_address": {‬
‭"address_line1": "<address line 1>",‬
‭"address_line2": "<address line 2>",‬
‭"city": "<city>",‬
‭"state": "<state>",‬
‭"pincode": "<pincode>",‬
‭"primary_contact_number": "<phone_number>"‬
‭}‬
‭}‬
‭}‬

‭Response‬
‭{‬
"‭ request_id": "R08",‬
‭"response_details": [‬
‭{‬
‭"tracking_id": "CLTC0000000001",‬
‭"status": "REQUEST_RECEIVED/REQUEST_REJECTED",‬
‭"message": "Reason for Request Rejection"‬
‭}‬
‭]‬
‭}‬

‭EWB Update Request:‬


‭Clients need to get onboarded to use the EWB update functionality.‬

{‬

"update_request_type"‬
‭ :‬‭
‭ "UPDATE_EWB_ERN_INVOICE"‬
,‬

"update_request_details"‬
‭ : {‬

"attributes"‬
‭ : [‬

{‬

"name"‬
‭ :‬‭
‭ "eway_bill_number"‬
,‬

"value"‬
‭ :‬‭
‭ "EWB123456789"‬
},‬

{‬

"name"‬
‭ :‬‭
‭ "invoice_id"‬
,‬

"value"‬
‭ :‬‭
‭ "INV1234"‬
},‬

{‬

"name"‬
‭ :‬‭
‭ "ern"‬
,‬

"value"‬
‭ :‬‭
‭ "ern"‬
}‬

]‬

},‬

"tracking_id"‬
‭ :‬‭
‭ "<tracking_id>"‬
}‬

‭EWB Update Response:‬

‭{‬
"‭ request_id": "R08",‬
‭"response_details": [‬
‭{‬
‭"tracking_id": "CLTC0000000001",‬
‭"status": "REQUEST_RECEIVED/REQUEST_REJECTED",‬
‭"message": "Reason for Request Rejection"‬
‭}‬
‭]‬
‭}‬

‭7. Auth API‬


‭This allows the client to get a bearer token which will be used to authenticate all the other APIs.‬
‭ tage API URL -‬‭https://staging.ekartlogistics.com/auth/token‬
S
‭Production API URL -‬‭https://api.ekartlogistics.com/auth/token‬

‭ ttp Method Type -POST‬


H
‭Headers-‬
‭●‬ ‭Content-Type : application/json‬
‭●‬ ‭HTTP_X_MERCHANT_CODE : (As shared by Ekart Team)‬
‭●‬ ‭Authorization : (As shared by Ekart Team)‬
‭●‬ ‭This API will use Basic Auth mode. All the other APIs will follow Bearer Authentication.‬

‭Sample Response Body:‬

‭ uccess‬
S
‭{‬
‭"Authorization": "Bearer‬
‭eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJla2wtZHVyaW4tc3RhZ2UiLCJhdWQiOiJ7XCJtZXJjaG‬
‭FudFwiOlwiTVlOXCJ9IiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInVzZXIucHJv‬
‭ZmlsZSJdLCJpc3MiOiJodHRwOi8vMTAuMjQuMC4xNjUiLCJleHAiOjE2Mzc1Nzk3NjYsImlhdCI6MTYzNzU3Nj‬
‭E2NiwianRpIjoiZTkzMTIyOGItYWE3Ni00YzU1LThkNzctYzhkNDU2ZTZjOGI3IiwiY2xpZW50X2lkIjoiZWtsLWR1‬
‭cmluLXN0YWdlIn0.B4mgv7m3fwUvdIZ5teq9WJblxoojVe4Pg-yvxzh3KWmKno_r-XFTBUOAwjk4KxzNBa068‬
‭NgJr3uxbLmObh22RPSHKiRl8adB85vsDjohHgt0iAvXv4QWIrF9fDbSgW5nzRT1vPo-BtTu7QA1BupqLQb-_sU‬
‭cWHfsuRFe1bmFq1iV-nkzKdUPoL_w1rz89mY3Z6cqLUZ61KfzpRz6yR7A2gIw_HT31Tw5BUdcw435vAiVzdsM‬
‭pYeFhl2EcY0jJlN7eg8zBbacP-ObqUADyV8LBmMlY01of5eEJYeT6QOdZBEGaSbsaLv6-LekES1NAETmLL2Ho‬
‭BmSXH0JlYMl13BEA"‬
‭}‬

‭ ailure‬
F
‭Rate limit Exceeded - 403 Response status‬
‭{‬
‭"forbidden": "Rate limit exceeded"‬
‭}‬

I‭nvalid Credentials - 401 Response status‬


‭{‬
‭"unauthorised": "invalid_user_credential"‬
‭}‬

‭Token Details:‬
‭b.‬ ‭Expiry Time - 60min. Request a new token before that or you will get unauthorised response on all‬
‭APIs‬

‭8. Rate Limit at API level‬

‭ hese are by default‬‭rate limit per minute‬‭for each‬‭client, Although these numbers are‬
T
‭configured per api per client. After breaching the count, service will start failing with 403 errors.‬
‭Create Shipment API‬ ‭1200‬
‭Track API‬ ‭13500‬
‭Update API‬ ‭1800‬
‭Rto create API‬ ‭1200‬
‭Offering API‬ ‭600‬

You might also like