XpressBees Authentication Toekn Generation API Implementation Summary

Authentication Token Generation Details:

 URL: http://stageusermanagementapi.xbees.in/api/auth/generateToken
 Header
◦ Content-Type: application/json
◦ Authorization: Bearer xyz
 Sample Request
{
"username":"dummy",
"password":"Xpress@123",
"secretkey":"dummy"
}
◦ Fields Details

Field Data Type Mandatory Description

username string Y Shared by Xpressbees
password string Y Shared by Xpressbees
secretkey string Y Shared by Xpressbees

 Sample Response
◦ Successful:
{
"token":
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjQwMDEyIiwiZW1haWwiOjUsImFwcGtleSI
6IiRTSElQTUVOVCRBUEklIyQiLCJpYXQiOjE1NTQ5NzcwNjksImV4cCI6MTU1NDk4MDY2OX0.V
nowb1gA48gywNJLSQbF1CO3PLsswUI4stjVYAHBclc",
"code": 200
}
◦ Error/Validation:
{
"error": "Invalid user credentials",
"code": "103"
}
 Response Message Details

Response Code Response Message Remarks

200 No response message in this case, token is Response code is 200 for successful
generated in case of successful
103 Invalid user credentials Response code is 103 in case
invalid user credentials
104 Operation Failed, Please try again Please try again whenever get
Operation failed response from API

XpressBees Reverse Manifest API v1.0 1

 XpressBees Reverse Manifest API Implementation Summary

Push API Manifest Details:

 URL: http://api.staging.shipmentmanifestation.xbees.in/shipmentmanifestation/reverse
 Header
◦ Content-Type: application/json
◦ token: token from above api
◦ versionnumber: v1
 Method Type: POST
 JSON Request Sample:
{
"AirWayBillNO":"2454556600033" ,
"OrderNo": "10376373TEST293",
"BusinessAccountName": "Sales Demo",
"ProductID": "285760173T",
"Quantity": "1",
"ProductName": "Redmi 6 A Mom And Dad Back Cover",
"Instruction": "Brand packaging is damaged",
"IsCommercialProperty": "",
"CollectibleAmount": "142.50",
"ProductMRP": "142.50",
"DropDetails": {
"Addresses": [{
"Type": "Primary",
"Name": "SY Test",
"Address": "Bandra Bandra",
"City": "Mumbai",
"State": "Maharashtra",
"PinCode": "400061",
"EmailID": "",
"Landmark": ""
}],
"ContactDetails": [{
"Type": "Primary",

XpressBees Reverse Manifest API v1.0 2

 "PhoneNo": "8123456789"
}],
"IsGenSecurityCode": "",
"SecurityCode": "",
"IsGeoFencingEnabled": "",
"Longitude": "",
"Latitude": "",
"RadiusLocation": "",
"MidPoint": "",
"MinThresholdRadius": "",
"MaxThresholdRadius": ""
},
"PickupDetails": {
"Addresses": [{
"Type": "Primary",
"Name": "SACHIN G",
"Address": "Gharkul chowk , shivneri pan shop , hargude wasti chikhali",
"City": "Pune",
"State": "Maharashtra",
"PinCode": "411001",
"EmailID": "",
"Landmark": ""
}],
"ContactDetails": [{
"Type": "Primary",
"VirtualNumber": "",
"PhoneNo": "9123456789"
}],
"IsPickupPriority":"1",
"PriorityRemarks":"High value shipments",
"PickupSlotsDate": "",
"IsGenSecurityCode": "",
"SecurityCode": "",
"IsGeoFencingEnabled": "0",

XpressBees Reverse Manifest API v1.0 3

 "Longitude": "",
"Latitude": "",
"RadiusLocation": "",
"MidPoint": "",
"MinThresholdRadius": "",
"MaxThresholdRadius": ""
},
"PackageDetails": {
"Dimensions": {
"Length": "0.51",
"Width": "5.84",
"Height": "12.45"
},
"Weight": {
"BillableWeight": "12",
"VolWeight": "2.0",
"PhyWeight": "2.1"
}
},
"QCTemplateDetails": {
"TemplateId": null,
"TemplateCategory": ""
},
"TextCapture": [{
"Label": "IMEI number",
"Type": "text",
"ValueToCheck": "yes"
}],
"PickupProductImage": [{
"ImageUrl": "https://www/images/catalog/product/M/MO/MOBREDMI-6-A-MOSY-
P589477EA9E7508/1568789493625_0..jpg",
"TextToShow": ""
}],
"CaptureImageRule": {

XpressBees Reverse Manifest API v1.0 4

 "MinImage": "1",
"MaxImage": "4"
},
"HelpContent": {
"Description": "Proc Help Content",
"URL": "https://support.google.com/?hlen",
"IsMandatory": "1"
},
"GSTMultiSellerInfo": [{
"InvoiceNumber": "A1234555",
"InvoiceDate": "04-04-2019",
"InvoiceValue": 50058,
"ProductUniqueID": "Test12334",
"IsSellerRegUnderGST": "Yes",
"BuyerGSTRegNumber": "31ANKPT8882D1Z1",
"SellerName": "Seller Name",
"SellerGSTRegNumber": "11ANKPT8882D1Z1",
"SellerAddress": "Test Park, Pune",
"SupplySellerStatePlace": "Pune",
"SellerPincode": 454245,
"EBNExpiryDate": "20-09-2018 13:23:22",
"EWayBillSrNumber": "A494949",
"HSNDetails": [{
"HSNCode": "1234",
"ProductCategory": "Cases Covers",
"ProductDesc": "Product Desc",
"SGSTAmount": 10,
"CGSTAmount": 20.2,
"IGSTAmount": 0,
"GSTTaxTotal": 10,
"TaxableValue": 0,
"Discount": 0,
"GSTTaxRateCGSTN": 1.2,
"GSTTaxRateSGSTN": 1,

XpressBees Reverse Manifest API v1.0 5

 "GSTTAXRateIGSTN": 1
}]
}]
}

 token: need to pass token which is generated from api/auth/generateToken api

 Field List:

Field Data Field Manda Description Example

Type Length tory
AirWayBillNO String 50 Y "AirWayBillNO":"245455660
0033"
OrderNo String 50 Y Order no against shipments "OrderNo":
manifestation "10376373TEST293"
BusinessAccountNa String 100 Y Unique account name for "BusinessAccountName":
me each client [share by "Sales Demo"
Xpressbess]
ProductID String 50 Y It's unique product id "ProductID": "285760173T"
against manifestation
Quantity Int Y Total qty to be picked "Quantity": "1"
ProductName String 500 Y Name of the product to be "ProductName": "Redmi 6 A
picked Mom And Dad Back Cover"
Instruction String 1000 N It is return reason if any "Instruction": "Brand
packaging is damaged"
IsCommercialProper Boolean N This value should be pass "IsCommercialProperty": ""
ty true or 1 for in case of
commercial property
CollectibleAmount Decimal (18,2) N Actual price of the product "CollectibleAmount":
that was charged to "142.50"
customer
ProductMRP Decimal (18,2) Y MRP of the product to be "ProductMRP": "142.50"
picked
DropDetails JSON Y It's drop location details "DropDetails": {
Object "Addresses": [{
"Type": "Primary",
Addresses JSON Y 1. It is Primary and
"Name": "SY Test",
array Secondary Type.
"Address": "Bandra",
object 2. Primary type is
"City": "Mumbai",
mandatory
"State": "Maharashtra",
3. Inner side of DropDetails
"PinCode": "400061",
Object
"EmailID": "",
Type String 10 Y 1.It should be Primary and

XpressBees Reverse Manifest API v1.0 6

Field Data Field Manda Description Example
Type Length tory
Secondary. "Landmark": ""
2. The value “Primary” }],
must me mandatory. "ContactDetails": [{
3. It should be inner side of "Type": "Primary",
Addresses json array object "PhoneNo": "8123456789"
}],
Name String 100 Y Name of destination, it
"IsGenSecurityCode": "",
should be inner side of
"SecurityCode": "",
Addresses json array object
"IsGeoFencingEnabled": "",
Address String 500 Y 1. Destination address "Longitude": "",
where the picked up "Latitude": "",
shipment is supposed to be "RadiusLocation": "",
delivered "MidPoint": "",
2. it should be inner side of "MinThresholdRadius": "",
Addresses json array object "MaxThresholdRadius": ""
City String 100 N 1. Drop city name }
2. It should be inner side of
Addresses json array object
State String 100 N 1. Drop State name
2. It should be inner side of
Addresses json array object
PinCode Int 6 Y Need to share drop
location pincode it should
be inner side of Addresses
json array object
EmailID String 50 N 1. Drop email id
2.It should be inner side of
Addresses json array
object
Landmark String 100 N Drop address landmark if
any
ContactDetails Json Y Inner side of DropDetails
array Object, It is Primary and
object Secondary Type. Primary
type is mandatory
PhoneNo String 10 Y It's is drop location mobile
number
Type String 15 Y It should be Primary and
Secondary. The value
“Primary” must me
mandatory. It should be
inner side of ContactDetails
json array object.

XpressBees Reverse Manifest API v1.0 7

Field Data Field Manda Description Example
Type Length tory
IsGenSecurityCode String 3 N 1. The value should be
Yes/No
2. It will be considered
default “No” if the value is
null/empty
3. It's should be inner side
of DropDetails json object
SecurityCode String 5 N This value should be pass if
want to verify certain NDR
for customer at the time of
delivery
IsGeoFencingEnable Boolean N This value should be true, if
d want to enable drop geo
fencing
It's should be inner side of
DropDetails json object
Latitude String 20 N It is Y if drop location
latitude value should be
pass
It's should be inner side of
DropDetails json object
Longitude String 20 N It is Y if drop location
longitude value should be
pass
RediusLocation Decimal (18,2) N Finding Points Within a
Distance of a
Latitude/Longitude for drop
It should be in meters
It's should be inner side of
DropDetails json object
MidPoint Decimal (18,2) N Finding mid points of drop
location
It should be in meter
It's should be inner side of
DropDetails json object
MaxThresholdRadiu Decimal (18,2) N Finding maximum Points
s Within a Distance of a
Latitude/Longitude for drop
It should be in meters
It's should be inner side of
DropDetails json object
MinThresholdRadiu Decimal (18,2) N Finding minimum Points
s Within a Distance of a

XpressBees Reverse Manifest API v1.0 8

Field Data Field Manda Description Example
Type Length tory
Latitude/Longitude for drop
It should be in meters
It's should be inner side of
DropDetails json object
PickupDetails JSON Y It's pick-up location details "PickupDetails": {
Object "Addresses": [{
"Type": "Primary",
Addresses Json Y 1. It is Primary and
"Name": "SACHIN G",
array Secondary Type.
"Address": "Gharkul
object 2. Primary type is
chowk , shivneri pan shop ,
mandatory
hargude wasti chikhali",
3. Inner side of
"City": "Pune",
PickupDetails Object
"State":
Type String 10 Y 1.It should be Primary and "Maharashtra",
Secondary. "PinCode": "411001",
2. The value “Primary” "EmailID": "",
must me mandatory. "Landmark": ""
3. It should be inner side of }],
Addresses json array object "ContactDetails": [{
Name String 100 Y 1. Person or Company "Type": "Primary",
name of pickup details "VirtualNumber": "",
2. It should be inner side of "PhoneNo":
Addresses json array object "9123456789"
}],
Address String 500 Y 1. It is drop address "IsPickupPriority":"1",
2. it should be inner side of "PriorityRemarks":"High
Addresses json array object value shipments",
City String 50 N 1. Pickup city name "PickupSlotsDate": "",
2. It should be inner side of "IsGenSecurityCode": "",
Addresses json array object "SecurityCode": "",
"IsGeoFencingEnabled": "",
State String 50 N 1. Pickup State name
"Longitude": "",
2. It should be inner side of
"Latitude": "",
Addresses json array object
"RadiusLocation": "",
PinCode Int 6 Y 1. Need to share pickup "MidPoint": "",
location pincode "MinThresholdRadius": "",
2. It should be inner side of "MaxThresholdRadius": ""
Addresses json array object }
EmailID String 50 N 1. Pickup email id
2.It should be inner side of
Addresses json array object
ContactDetails Json Y 1. Inner side of
array PickupDetails Object
object 2. It is Primary and
Secondary Type.

XpressBees Reverse Manifest API v1.0 9

Field Data Field Manda Description Example
Type Length tory
3. Primary type is
mandatory
Type String 10 Y 1. It should be Primary and
Secondary.
2. The value “Primary”
must me mandatory.
3. It should be inner side of
ContactDetails json array
object.
PhoneNo String 10 Y/N 1.. It's mapped with pickup
location mobile number at
client end and it is
mandatory if virtual
numbmer is not provided.
2. It should be inner side of
ContactDetails json array
object
VirtualNumber String 20 Y/N 1. It's mapped with pickup
location mobile number at
client end and it is
mandatory if pickup phone
number is not provided.
2.It should be inner side of
ContactDetails json array
object
IsPickupPriority Int N 1. Need to send
IsPickupPriority: 1 for
priority pickup shipment
PriorityRemarks String 100 N 1. this is remarks of
priority flag shipment
PickupSlotsDate Datetime N 1. It is pickup slots date
time
2. The date should not be
previous day date
3. Datetime format: dd-
MM-yyyy HH:mm:ss, eg 13-
08-2018 14:30:21

IsGenSecurityCode String 3 N 1. The value should be

Yes/No
2. It will be considered
default “No” if the value is
null/empty

XpressBees Reverse Manifest API v1.0 10

Field Data Field Manda Description Example
Type Length tory
3. It's should be inner side
of PickupDetails json object
SecurityCode String 5 N This value should be pass if
want to verify certain NPR
for customer at the time of
delivery
IsGeoFencingEnable Boolean N 1. This value should be
d true, if want to enable drop
geo fencing
2. It's should be inner side
of PickupDetails json object
Latitude String 20 N 1. It is Y if pickup location
latitude value should be
pass
2. It's should be inner side
of PickupDetails json object
Longitude String 20 N 1. It is Y if drop location
longitude value should be
pass
2. It's should be inner side
of PickupDetails json object
RediusLocation Decimal (18,2) N 1. Finding Points Within a
Distance of a 2.
Latitude/Longitude for
pickup
3. It should be in meters
4. It's should be inner side
of PickupDetails json object
MaxThresholdRadiu Decimal (18,2) N 1. Finding maximum Points
s Within a Distance of a
Latitude/Longitude for
pickup
2. It should be in meters
3. It's should be inner side
of PickupDetails json object
MinThresholdRadiu Decimal (18,2) N 1. Finding minimum Points
s Within a Distance of a 2.
Latitude/Longitude for
pickup
3. It should be in meters
4. It's should be inner side
of PickupDetails json object
MidPoint Decimal (18,2) N 1. Finding mid points of

XpressBees Reverse Manifest API v1.0 11

Field Data Field Manda Description Example
Type Length tory
pickup location
2. It should be in meter
3. It's should be inner side
of PickupDetails json object
PackageDetails JSON N It's shipment Dimensions "PackageDetails": {
Object and Weight details object "Dimensions": {
"Length": "0.51",
Dimensions JSON N It's shipment LBH details
"Width": "5.84",
Object object
"Height": "12.45"
Height Decimal (18,2) N 1. The dimension unit must },
be in “cm” "Weight": {
2. inner side of Dimensions "BillableWeight": "12",
json object "VolWeight": "2.0",
Length Decimal (18,2) N 1. The dimension unit must "PhyWeight": "2.1"
be in “cm” }
2. inner side of Dimensions }
json object
Width Decimal (18,2) N 1. The dimension unit must
be in “cm”
2. inner side of Dimensions
json object
Weight JSON It's shipment weight details
Object object
BillableWeight Decimal (18,2) N 1. The weight unit must be
in “kg”
2. inner side of Weight
object
PhyWeight Decimal (18,2) N 1. The weight unit must be
in “kg”
2. inner side of Weight
object
VolWeight Decimal (18,2) N 1. The weight unit must be
in “kg”
2. inner side of Weight
object
QCTemplateDetails JSON N Json object under the "QCTemplateDetails": {
Object reverse manifest json "TemplateId": null,
"TemplateCategory": ""
TemplateId String 20 N Registered template ID or
}
return reason code
TemplateCategory String 100 N It should be registered
template category
TextCapture JSON N "TextCapture": [{

XpressBees Reverse Manifest API v1.0 12

Field Data Field Manda Description Example
Type Length tory
Array "Label": "IMEI number",
Object "Type": "text",
"ValueToCheck": "yes"
Label String 200 N Label which display on
}]
ValueToCheck. e.g. : IMEI
Number
Type String 50 N Text type Ex:
phoneNumber,
emailAdress, number
ValueToCheck String 100 N Value which need to check
during QC
PickupProductImag JSON N "PickupProductImage": [{
e array "ImageUrl":
object "https://www/images/catal
og/product/M/MO/MOBRE
ImageUrl String 500 N Product image URL
DMI-6-A-MOSY-
TextToShow String 500 N Text to show on image P589477EA9E7508/156878
9493625_0..jpg",
"TextToShow": ""
}]
CaptureImageRule JSON N "CaptureImageRule": {
object "MinImage": "1",
"MaxImage": "4"
MinImage Int N Maximum image capture at
}
time of QC parameter
check
MaxImage Int N Maximum image capture at
time of QC parameter
check
HelpContent JSON Json object under the "HelpContent": {
object reverse manifest json "Description": "Proc Help
Contains details of help Content",
content to be display "URL":
"https://support.google.co
Description String 1000 N Help description
m/?hlen",
URL String 500 N Help page URL "IsMandatory": "true"
IsMandatory Boolean N True for display help }
content compulsory
GSTMultiSellerInfo JSON Information about manfiest "GSTMultiSellerInfo": [{
array gst details "InvoiceNumber":
object "A1234555",
"InvoiceDate": "04-04-
InvoiceNumber String 50 N 1. It is Y if shipment invoice
2019",
value(taxable value +
"InvoiceValue": 50058,
TotalGSTAmount) or

XpressBees Reverse Manifest API v1.0 13

Field Data Field Manda Description Example
Type Length tory
DeclaredValue >=50000 for "ProductUniqueID":
the particular product "Test12334",
2. inner side of "IsSellerRegUnderGST":
GSTMultiSellerInfo json "Yes",
object "BuyerGSTRegNumber":
"31ANKPT8882D1Z1",
InvoiceDate Date N 1. It is Y if shipment invoice
"SellerName": "Seller
value(taxable value +
Name",
TotalGSTAmount) or
"SellerGSTRegNumber":
DeclaredValue >=50000 for
"11ANKPT8882D1Z1",
the particular product
"SellerAddress": "Test Park,
2. Format: dd-MM-yyyy i.e.
Pune",
13-03-2019
"SupplySellerStatePlace":
3. inner side of
"Pune",
GSTMultiSellerInfo json
"SellerPincode": 454245,
object
"EBNExpiryDate": "20-09-
InvoiceValue Decimal (18,2) N 1. Total Invoice Value of the 2018 13:23:22",
product "EWayBillSrNumber":
2. inner side of "A494949",
GSTMultiSellerInfo json "HSNDetails": [{
object "HSNCode": "1234",
ProductUniqueID String 50 N 1. Unique id of product if "ProductCategory": "Cases
any Covers",
2. inner side of "ProductDesc": "Product
GSTMultiSellerInfo json Desc",
object "SGSTAmount": 10,
"CGSTAmount": 20.2,
BuyerGSTRegNumb String 100 N 1. It is Y if shipment invoice "IGSTAmount": 0,
er value(taxable value + "GSTTaxTotal": 10,
TotalGSTAmount) or "TaxableValue": 0,
DeclaredValue >=50000 for "Discount": 0,
the particular product "GSTTaxRateCGSTN": 1.2,
2. First 2 letter shall be "GSTTaxRateSGSTN": 1,
state code of pickup state + "GSTTAXRateIGSTN": 1
next 10 letters shall be Pan }]
Number format+ Next 1 }]
letter should be numeric +
Z + Next 1 letter should be
alfha numeric format eg.
11ANKPT8882D1Z1
3. inner side of
GSTMultiSellerInfo json
object
IsSellerRegUnderGS String 3 N 1. It should be Yes/No
T 2. inner side of
GSTMultiSellerInfo json

XpressBees Reverse Manifest API v1.0 14

Field Data Field Manda Description Example
Type Length tory
object
SellerName String 100 Y 1. inner side of
GSTMultiSellerInfo json
object
SellerGSTRegNumb 50 N 1. It is Y if shipment invoice
er value(taxable value +
TotalGSTAmount) or
DeclaredValue >=50000 for
the particular product
2. First 2 letter shall be
state code of pickup state +
next 10 letters shall be Pan
Number format+ Next 1
letter should be numeric +
Z + Next 1 letter should be
alfha numeric format eg
11ANKPT8882D1ZC
3. inner side of
GSTMultiSellerInfo json
object
SellerAddress String 500 Y 1. inner side of
GSTMultiSellerInfo json
object
SellerPincode Int 6 Y 1. inner side of
GSTMultiSellerInfo json
object
SupplySellerStatePla String 50 N 1. It is Y if shipment invoice
ce value(taxable value +
TotalGSTAmount) or
DeclaredValue >=50000 for
the particular product
2. inner side of
GSTMultiSellerInfo json
object
EBNExpiryDate Datetime N 1. EBN Expiry Date: Format:
dd-MM-yyyy HH:mm:ss eg.
29-01-2018 13:23:22
2. inner side of
GSTMultiSellerInfo json
object
EWayBillSrNumber String 50 N 1. The EBN against
shipment
2. inner side of

XpressBees Reverse Manifest API v1.0 15

Field Data Field Manda Description Example
Type Length tory
GSTMultiSellerInfo json
object
HSNDetails JSON 1. It's information about
array product HSN details
object 2. inner side of HSNDetails
json object
HSNCode String 8 Y 1. HSN code of the
product/ Like product code
2. Should be alphanumeric
characters
3. inner side of HSNDetails
json object
ProductCategory String 100 Y 1. Shipment product
category
2. inner side of HSNDetails
json object
ProductDesc String 100 Y 1. Shipment product short
description
2. inner side of HSNDetails
json object
SGSTAmount Decimal (18,2) N 1.It is Y if shipment invoice
value(taxable value +
TotalGSTAmount) or
DeclaredValue >=50000 for
the particular product and
2. Will require
value/amount, this needs
to coupled with CGST, It is
required for Y for
local/within state sale
3. inner side of HSNDetails
json object
CGSTAmount Decimal (18,2) N 1. It is Y if shipment invoice
value(taxable value +
TotalGSTAmount) or
DeclaredValue >=50000 for
the particular product and
2. Will require
value/amount, this needs
to coupled with SGST
3. inner side of HSNDetails
json object
IGSTAmount Decimal (18,2) N 1. It is Y if shipment invoice

XpressBees Reverse Manifest API v1.0 16

Field Data Field Manda Description Example
Type Length tory
value(taxable value +
TotalGSTAmount) or
DeclaredValue >=50000 for
the particular product and
2. Y for inter state sale, Will
require value/amount, If
this is required then CGST
and SGST is not required
3. inner side of HSNDetails
json object
TaxableValue Decimal (18,2) N 1. Taxable value means
value on which CGST&SGST
or IGST is computed
2. It is Y if shipment invoice
value(taxable value +
TotalGSTAmount) or
DeclaredValue >=50000 for
the particular product
3. inner side of HSNDetails
json object
GSTTaxTotal Decimal (18,2) N 1. It is Y if shipment invoice
value(taxable value +
TotalGSTAmount) or
DeclaredValue >=50000 for
the particular product and
2. It should be sum of SGST,
CGST and IGST
3. inner side of HSNDetails
json object
GSTTAXRateIGSTN Decimal (18,2) N 1. IGST Rate/Percentage
2. inner side of HSNDetails
json object
GSTTaxRateCGSTN Decimal (18,2) N 1. CGST Rate/Percentage
2. inner side of HSNDetails
json object
GSTTaxRateSGSTN Decimal (18,2) N 1. SGST Rate/Percentage
2. inner side of HSNDetails
json object
Discount Decimal (18,2) N 1. Product discount value
2. inner side of HSNDetails
json object

XpressBees Reverse Manifest API v1.0 17

  Sample JSON Reponse:
◦ Required Output:

▪ Successful:

{ "AWBNo": "2557890002TEST", "ReturnCode": 100, "ReturnMessage":

"successful"}

◦ Validation/Error:

▪ { "AWBNo":"11127262193237782","ReturnCode":101,"ReturnMessage":"Token
expired","TokenNumber":null }

 API Respnose(Return Message and Retrun Code):

◦ Return Code Description:

Return Code Return Message

100 Successful
101 Token expired
103 Validation Message
104 Operation Failed

◦ Retrun Code and Retrun Message Description:

Response Code Response Message Remarks

100 successful Request accepted successful

100 AirWayBillNO Already exists If shipment is already exist
101 Invalid Token Token is not valid in XB end
101 Token expired Incase of token expired after
certain time of periods. Need to
call token generation api for new
token in this case and send it to
back in manifestation api.
104 Operation Failed The retry mechanism should be

XpressBees Reverse Manifest API v1.0 18

Response Code Response Message Remarks

implemented at client end

103 BusinessAccountName not provided This is mandatory field. Need to
be provided.
103 Client does not exist If business account name is not
mapped at XB end
103 OrderNo not provided Order no is mandatory field
103 OrderNo field length should be less than or equal Not accepted more than 50 char
to 50 char
103 SubOrderNo field length should be less than or Not accepted mroe than 50 char
equal to 50 char for sub order number as well
103 ProductID not provided Product id is mandatory
103 ProductName not provided ProductName is mandatory
103 Product Name field length should be less than or Not accepted more than 500 char
equal to 500 char in product name field
103 Invalid format of the Quantity field Only accepted integer field
103 Invalid format of the CollectibleAmount field Accepted decimal value (18,2)
format
103 ProductMRP not provided Product MRP is mandatory field
103 Invalid format of the ProductMRP field Accepted decimal value (18,2)
format
103 Invalid format of the IsCommercialProperty field Accepted boolean value
(true/false)
103 Invalid format of the IsMandatory field Accepted boolean value
(true/false) if HelpContent json
object is not null
103 HelpContent description not provided HelpContent description field is
required if HelpContent is not null
103 HelpContent description length should be less Not acceted more than 1000 char
than or equal to 1000 char
103 Drop Details Not Provided Drop Details json object is
mandatory
103 Drop Addresses Details Not Provided Drop Addresses Json array object
is mandatory
103 Drop Address Type Not Provided Type field in mandatory in Drop-
>Addresses object
103 Drop Primary Address Not provided Drop address primary details is
mandatory

XpressBees Reverse Manifest API v1.0 19

Response Code Response Message Remarks

103 Drop Address Type length should be less than or Not accepted more than 15 char
equal to 15 char
103 Drop address not provided Address field in mandatory in
Drop->Addresses object
103 Drop Address length should be less than or equal Not accepted more than 1000
to 1000 char char in address
103 Drop PinCode Not Provided Pincode field in mandatory in
Drop->Addresses object
103 Drop Pincode is invalid Accepted only pincode format
103 Drop pincode not serviceable In case of drop pincode not
serviceable at XB end
103 Drop Name Not Provided DropName field in mandatory in
Drop->Addresses object
103 Drop Name length should be less than or equal to Not accepted more than 100 char
100 char in name field
103 Drop City length should be less than or equal to 50 Not accepted more than 50 char
char in city field
103 Drop State length should be less than or equal to Not accepted more than 50 char
50 char in state field
103 Drop Landmark length should be less than or Not accepted more than 1000
equal to 1000 char char in landmark characters
103 Drop EmailID is invalid Accepted email id format
103 Drop Contact Details Not Provided Drop Contact Details json array
object is mandatory
103 Drop Contact Details Type Not Provided Drop contact details type is
mandatory field
103 Drop ContactDetail Type length should be less Not accepted more the 15 char
than or equal to 15 char
103 Drop Primary Contact Details Not Provided Drop primary contact details is
mandatory
103 Drop Phone number is invalid Need to send mobile number
format
103 Invalid format of the IsGeoFencingEnabled field Accepted boolean value
(true/false)
103 Drop SecurityCode length should be less than or Not accepted more than 10 char
equal to 10 char
103 Invalid format of the drop Latitude field
103 Drop Latitude field not provided Mandatory in case of

XpressBees Reverse Manifest API v1.0 20

Response Code Response Message Remarks

IsGeoFencingEnabled true
103 Invalid format of the Drop Longitude field
103 Drop Longitude field not provided Mandatory in case of
IsGeoFencingEnabled true
103 Invalid format of the Drop RadiusLocation field Accepted integer format
103 Invalid format of the Drop MidPoint field Accepted integer format
103 Invalid format of the Drop Max ThresholdRadius Accepted integer format
field
103 Drop Max ThresholdRadius length should be less Max 4 digit will be accepted
than or equal to 4 digits
103 Pickup Details Not Provided Pickup details json object is
mandatory
103 Pickup Addresses Details Not Provided Pickup Addressess Details array
object is mandatory
103 Pickup Address Type Not Provided PickupDetails- Addressess- Type
field is mandatory
103 Pickup Primary Address Not provided Mandatory field
103 Pickup address not provided Mandatory field
103 Pickup Address length should be less than or Pickup Address length should not
equal to 1000 char more than 1000 char
103 Pickup PinCode Not Provided Mandatory field
103 Pickup Pincode is invalid Accepted integer
103 Pickup pincode not serviceable If pickup pincode not serviceable
at XB end
103 Pickup Name Not Provided Mandatory field
103 Pickup Name length should be less than or equal Not accepted more than 100 char
to 100 char
103 Pickup EmailID is invalid Send this in email format
103 Pickup City length should be less than or equal to Pickup city length should not be
50 char more than 50 characters
103 Pickup State length should be less than or equal to Note accepted more than 50
50 char characters
103 Pickup Contact Details Not Provided Mandatory field
103 Pickup Contact Details Type Not Provided Pickup Contact Details- Type is
mandatory
103 Pickup Primary Contact Details Not Provided Mandatory field

XpressBees Reverse Manifest API v1.0 21

Response Code Response Message Remarks

103 Pickup mobile number not provided Mandatory field

103 Pickup Phone number is invalid Need to send in mobile number
format
103 Invalid format of the IsPickupPriority field Incase of IsPickupPriority value
not integer
103 Pickup IsGenSecurityCode field should be Yes/No Accepted Value Yes or No
103 Pickup SecurityCode length should be less than or Not accepted more than 10
equal to 10 char characters
103 Invalid format of the IsGeoFencingEnabled field IsGeoFencingEnabled : true/false
103 Invalid format of the Pickup Latitude field
103 Pickup Latitude field not provided Mandatory in case of
IsGeoFencingEnabled true
103 Invalid format of the Pickup Longitude field
103 Pickup Longitude field not provided Mandatory in case of
IsGeoFencingEnabled true
103 Invalid format of the Pickup RadiusLocation field Accepted in integer format
103 Invalid format of the Pickup MidPoint field Accepted in integer format
103 Invalid format of the pickup min thresholdradius Accepted in integer format
field
103 Invalid format of the Pickup Max ThresholdRadius Accepted in integer format
field
103 Invalid format of the IsPickupPriority field Accepted true/false
103 PriorityRemarks field length should be less than or Max length of PriorityRemarks
equal to 100 char field is 100 characters
103 Invalid format of the BillableWeight field Accepted decimal value
103 Invalid format of the VolWeight field Accepted decimal value
103 Invalid format of the PhyWeight field Accepted decimal value
103 PhyWeight should not Greater then 100kg Not accepted more than 100 kg
weight
103 Invalid format of the Width field Accepted decimal value
103 Invalid format of the Length field Accepted decimal value
103 Invalid format of the Height field Accepted decimal value
103 QC TemplateCategory length should be less than Not accepted 200 char inTemplate
or equal to 200 char category
103 Invalid templateId If template is not registered at XB
end

XpressBees Reverse Manifest API v1.0 22

Response Code Response Message Remarks

103 ImageUrl length should be less than or equal to Not accepted more than 500 char
500 char in image url
103 TextToShow length should be less than or equal to Not accepted more than 500 char
500 char
103 Invalid format of the MinImage field If CaptureImageRule not null and
format is not valid
103 Invalid format of the MaxImage field If CaptureImageRule not null and
format is not valid
103 Seller Name not provided Mandatory field
103 Seller address not provided Mandatory field
103 Seller Pincode not provided Mandatory field
103 Seller Invoice Date not provided Mandatory field
103 Seller Invoice Date format is not valid Format: dd-MM-yyyy
103 Invoice date should not be Greater than today
date
103 Invalid format of the invoice value field Accepted only decimal value
103 EWayBillSrNumber format is not valid Accepted alphanumeric value
103 Seller EBNExpiry Date format is not valid Format: dd-MM-yyyy HH:mm:ss
103 Seller GST RegNumber not provided Mandatory field
103 Buyer GST RegNumber not Provided Mandatory field
103 Buyer GST RegNumber not valid Accepted alphanumeric value
103 Seller GST RegNumber not valid Accepted alphanumeric value
103 Supply state place not provided Mandatory field
103 SupplySellerStatePlace length should be less than Not accepted more than 100
or equal to 100 char characters
103 IsSellerRegUnderGST should be yes or no Value should be Yes or No
103 HSNDetails not provided Mandatory
103 Product description not provided Mandatory field
103 HSN code length should be 8 char/number or less Not accepted more than 8
then 8 char/number characters
103 Invalid format of the HSNCode field Accepted alphanumeric value
103 Taxable Value not provided Mandatory field
103 Invalid format of the Taxable Value field Accepted decimal value
103 SGST amount not provided
103 SGST and CGST or ISGT amount not provided

XpressBees Reverse Manifest API v1.0 23

Response Code Response Message Remarks

103 CGST amount not provided

103 Invalid format of the SGST Value field Accepted decimal value
103 Invalid format of the CGST Value field Accepted decimal value
103 Invalid format of the CGST Value field Accepted decimal value
103 Invalid format of the IGST Value field Accepted decimal value
103 GST Tax Total Value not provided Mandatory
103 Invalid format of the GSTTaxTotal Value field Accepted decimal value
103 Invalid format of the Discount field Accepted decimal value
103 Invalid format of the GSTTaxRateCGSTN field Accepted decimal value
103 Invalid format of the GSTTaxRateSGSTN field Accepted decimal value
103 Invalid format of the GSTTAXRateIGSTN field Accepted decimal value
103 Invalid format of the TaxableShipmentValue field Accepted decimal value
103 Invalid format of the VatCstAmount field Accepted decimal value

XpressBees Reverse Manifest API v1.0 24