Ekart B2C API Document - NonLarge - New - V1
Ekart B2C API Document - NonLarge - New - V1
Failure
Auth API
This allows the client to get a bearer token which will be used to authenticate all the other APIs.
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"
}
Token Details:
a. Expiry Time - 60min. Request a new token before that or you will get unauthorised response on all
APIs
1.1 Forward
tage API URL -https://staging.ekartlogistics.com/v2/shipments/create
S
Production API URL -https://api.ekartlogistics.com/v2/shipments/create
Input Parameters
he section contains the description of all the fields available (including the optional fields) in the create
T
shipment API.
oods_category
g ust be one of the following
M If 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 Invalid goods category,
If not passed default value will Provided value: <value>
be NON_ESSENTIAL
mount_to_collect
a Indicates 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 Indicates 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 Indicates 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 Indicates 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 codeor address in source and return sections is mandatory.
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 Invalid source pincode
<value>
rst_name
fi Name of thecustomer " 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 Invalid destination
digit pincode pincode <value>
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.
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 Invalid destination
digit pincode pincode <value>
mail_id
e “Email id is invalid”
(Mandatory - NO)
Shipment Details
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)
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)
roduct_id
p roduct number for the
P
(Mandatory - NO) shipment item (as per client)
(Mandatory - for Large) (Max Length- 64)
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>]"
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)
Invoice_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 equiredif shipment
R way bill number not
E
(Mandatory - NO) shipment value exceeds provided for high value
50000. Length should shipment
be 12
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
isFragile Indicates 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.
isDangerous Indicates 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.
"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"
}
]
}
]
}
}
]
}
]
}
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"
}
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
oods_category
g ust be one of the following
M If 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
elivery_type
d Indicates 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 addressshould be present. If both are present, preference
S
will be given to location_code over address.
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 Invalid source pincode
<value>
estination:Location code of the facility where theitem 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.
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 Invalid source pincode
<value>
Shipment Details
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)
roduct_id
p roduct number for the
P
(Mandatory - NO) shipment item (as per client)
(Mandatory - for (Max Length- 64)
Large)
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>]"
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)
Invoice_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
s ub_reason
(Mandatory - NO)
eason_description D
R escription of the reason for
(Mandatory - NO) customer return
},
"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
}
}
}
]
}
]
}
}
]
}
]
}
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
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
}
}
}]
}
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.
},
"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
}
}
}
]
}
]
}
}
]
}
]
}
ailure
F
Rate limit Exceeded - 403 Response status
{
"forbidden": "Rate limit exceeded"
}
3.1 Forward
tage API URL -https://staging.ekartlogistics.com/v1/offerings
S
Production API URL -https://api.ekartlogistics.com/v1/offerings
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
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 Indicates 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 Indicates 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
ervice_type
s Indicates the type of service hould not be null or
S Invalid service type
(Mandatory - Yes) request. Should be FORWARD empty.
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
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.)
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 Indicates 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 Indicates 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
ervice_type
s Indicates the type of service hould not be null or
S Invalid service type
(Mandatory - Yes) request. Should be REVERSE empty.
3.3 Prexo/Replacement
tage API URL -https://staging.ekartlogistics.com/v1/offerings
S
Production API URL -https://api.ekartlogistics.com/v1/offerings
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.
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
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 Indicates 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 Indicates 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
ervice_type
s Indicates the type of service hould not be null or
S Invalid service type
(Mandatory - Yes) request. Should be PREXO or empty.
REPLACEMENT
Failure
Rate limit Exceeded - 403 Response status
{
"forbidden": "Rate limit exceeded"
}
{
"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"
}
Headers-
● HTTP_X_MERCHANT_CODE : (As shared by Ekart Team)
● Authorization : Bearer <Token>
ailure
F
Rate limit Exceeded - 403 Response status
{
"forbidden": "Rate limit exceeded"
}
Headers-
H
● TTP_X_MERCHANT_CODE : (As shared by Ekart Team)
● Authorization : Bearer <Token>
ailure
F
Bad Request 400
{
"request_id": "R04",
"response_details": [
{
"tracking_id": "<trackingId>",
"status": "REQUEST_REJECTED",
“message”: [“<error message>”]
}
]
}
Response
{
" request_id": "R08",
"response_details": [
{
"tracking_id": "CLTC0000000001",
"status": "REQUEST_RECEIVED/REQUEST_REJECTED",
"message": "Reason for Request Rejection"
}
]
}
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 allowedfor large. Pls note that if you are passing the
delayed_dispatch flag as TRUE then the pickup date will be d+30.
ailure
F
Rate limit Exceeded - 403 Response status
{
"forbidden": "Rate limit exceeded"
}
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>”
}
}
}
Response
{
" request_id": "R08",
"response_details": [
{
"tracking_id": "CLTC0000000001",
"status": "REQUEST_RECEIVED/REQUEST_REJECTED",
"message": "Reason for Request Rejection"
}
]
}
{
"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>"
}
{
" request_id": "R08",
"response_details": [
{
"tracking_id": "CLTC0000000001",
"status": "REQUEST_RECEIVED/REQUEST_REJECTED",
"message": "Reason for Request Rejection"
}
]
}
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"
}
Token Details:
b. Expiry Time - 60min. Request a new token before that or you will get unauthorised response on all
APIs
hese are by defaultrate limit per minutefor eachclient, 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