Get api token.
| Parameters |
Description |
Optional |
| email |
User Email |
No |
| password |
User Password |
No |
{
"email":"easyecom@easyecom.io",
"password":"easyecom@13$!"
}
{
"code": 200,
"message": null,
"data": {
"time_zone": "Asia/Kolkata",
"api_token": "736fc49ad1819277924058f724e7743f534149e3f62ba9b579f56d920a8fcf8e",
"user_role_id": 2,
"userName": "Ash Nutritional",
"credit_limit": null,
"credit_balance": null,
"c_id": 18663,
"u_id": 16211,
"currency_code": "INR",
"currency_name": "Indian Rupee",
"currency_unicode": "₹"
}
}
### Notice: You can't update inventory for products having is_combo =1. Each page has a limit of 50 items .
Updates stock of items available in inventory.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| company_product_id/sku |
Company Product Id/sku (can be obtained in the above API response) |
No |
| quantity |
Quantity |
No |
{
"sku":"ABCXYZ",
"quantity":10
}
{
"code": 200,
"message": "Successful",
"data": {
"sku": "ABCXYZ",
"message": "Inventory updated successfully",
"quantity": "10"
}
}
Confirm orders. Response returns the order_id that were successfully confirmed.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| order_id |
Order id (can be obtained in the above API response) |
No |
| invoice_num |
Invoice Number |
YES |
| invoice_prefix |
Invoice Prefix |
YES |
| invoice_date |
Invoice Date(yyyy-mm-dd) |
YES |
{
"status": 200,
"message": "",
"data": {
"Error": [],
"Success": [order_id]
}
}
Fetches the current tracking status and the tracking history.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| reference_code or awb_number |
Order Num of the order or AWB number of the order |
No |
{
"code": 200,
"message": "Successful",
"data": [
{
"last_status_update": "2021-09-21 18:50:44",
"suborder_id": 79324841,
"master_carrier_id": 5859,
"tier": 1,
"carrier_id": 13,
"status_id": 7,
"shipping_status_id": 3,
"reference_code": "15177",
"awbNumber": "13329212593908",
"invoiceId": 68222708,
"orderId": 46729772,
"invoiceAmount": 1585,
"tax": 241.78,
"shippingHistory": "[{\"status\":\"Picked - Shipment InScan from Manifest\",\"time\":\"20 Sep 2021, 20:06\",\"location\":\"DEL\\/PC1, Delhi NCR, DELHI\"},{\"status\":\"Out for Delivery - Out for delivery: 201934-Amesh Kiro (245470) (201934)-PDS21264090033201934-FromMob , MobileNo:- 9599504992\",\"time\":\"21 Sep 2021, 09:00\",\"location\":\"DEL\\/RHN, NEW DELHI, DELHI\"},{\"status\":\"Delivered\",\"time\":\"21 Sep 2021, 12:36\",\"location\":\"DEL\\/RHN, NEW DELHI, DELHI\"}]",
"currentShippingStatus": "Delivered",
"expectedDeliveryDate": "2021-09-22 00:00:00",
"carrierName": "XPRESSBEES",
"orderDate": "2021-09-17 22:05:20",
"invoiceDate": "2021-09-20",
"orderStatus": "Shipped",
"companyName": "Swiss Military Lifestyle Product Pvt Ltd.",
"companyLogo": null,
"city": "New Delhi",
"state": "Delhi",
"pin_code": "110085",
"last_status": null,
"edd_month": "September",
"edd_year": "2021",
"edd_day": "22",
"shippingHistory2": [
{
"status": "Picked - Shipment InScan from Manifest",
"time": "20 Sep 2021, 20:06",
"location": "DEL/PC1, Delhi NCR, DELHI",
"day": "20 Sep",
"timestamp": "20:06"
},
{
"status": "Out for Delivery - Out for delivery: 201934-Amesh Kiro (245470) (201934)-PDS21264090033201934-FromMob , MobileNo:- 9599504992",
"time": "21 Sep 2021, 09:00",
"location": "DEL/RHN, NEW DELHI, DELHI",
"day": "21 Sep",
"timestamp": "09:00"
},
{
"status": "Delivered",
"time": "21 Sep 2021, 12:36",
"location": "DEL/RHN, NEW DELHI, DELHI",
"day": "21 Sep",
"timestamp": "12:36"
}
],
"notes": []
}
]
}
Cancels a order.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| reference_code/invoice_id/suborder_num |
Reference Code/invoice_id/suborder_num of the order |
No |
| m_id |
marketplace Id |
Yes(mandatory when cancel using suborder_num only) |
Sample Request Body:
{
"reference_code":'OD1234'
}
{
"code":200,
"message":"Successfully Cancelled the Order with reference_code OD1234",
"data":{}
}
Creates Vendors. On successful Response,vendor_id will be returned.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| emailId |
Email Id of the Vendor |
No |
| firstName |
First Name of the Vendor |
Yes |
| lastName |
Last Name of the Vendor |
Yes |
| vendorCode |
Vendor Code if any |
Yes |
| companyName |
Company Name of the Vendor |
No |
| taxIdentificationNum |
Tax Identification Number of the Vendor |
Yes |
| street |
Vendor address |
Yes |
| city |
Vendor City |
Yes |
| state |
Vendor State |
No |
| zip |
Vendor pincode |
No |
| country |
Vendor Country |
No |
| contactNumber |
Vendor Contact Number |
Yes |
| currency |
Vendor Currency(should be a 3 character code ex: INR) |
No |
Sample Request Body:
{
"emailId":"johndoe@ecom.io",
"firstName":"john",
"lastName":"John",
"vendorCode":"",
"companyName":"Se03ae12",
"taxIdentificationNum":"AP123ED12W",
"street":"knvadjkv,sfdadwv",
"city":"Bangalore",
"state":"Karnataka",
"zip":"560102"
"country":"India",
"contactNumber":"9036559897",
"currency":"INR"
}
{
"code":200,
"message":"Vendor Created Successfully",
"data":"{'vendor_id':9863}"
}
Notice: Optional parameter keys should be present in the json body but can be left blank.
Updates Vendors. On successful Response,vendor_id will be returned.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| vendorId |
vendor_id which you get from CreateVendor API call |
No |
| emailId |
Email Id of the Vendor |
Yes |
| firstName |
First Name of the Vendor |
Yes |
| lastName |
Last Name of the Vendor |
Yes |
| vendorCode |
Vendor Code if any |
Yes |
| companyName |
Company Name of the Vendor |
Yes |
| taxIdentificationNum |
Tax Identification Number of the Vendor |
Yes |
| city |
Vendor City |
Yes |
| state |
Vendor State |
Yes |
| country |
Vendor Country |
Yes |
| contactNumber |
Vendor Contact Number |
Yes |
| currency |
Vendor Currency(should be a 3 character code ex: INR) |
Yes |
| daysToPrep |
Num of days to prepare |
Yes |
| daysToShip |
Num of days to Ship |
Yes |
Sample Request Body:
{
"vendorId":9313,
"emailId":"",
"firstName":"",
"lastName":"doe",
"vendorCode":"",
"taxIdentificationNum":"",
"city":"Mumbai",
"state":"Maharashtra",
"contactNumber":"",
"daysToShip":10
}
{
"code":400,
"message":"Updated Successfully",
"data":"{'vendor_id':9863}"
}
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| vendor_c_ids |
Comma separated EasyEcoms vendor cids |
Yes |
| created_after |
Vendor created date |
Yes |
{
"data": [
{
"vendor_name": "Bangalore Vendor",
"vendor_c_id": 413412,
"api_token": "vendors api token",
"address": {
"dispatch": {
"address": "VAISHNAVI NAKSHATRA, WANTPUR",
"city": "Bangalore",
"state_id": 12,
"state_name": "Karnataka",
"zip": "560067",
"country": "India"
},
"billing": {
"address": "VAISHNAVI NAKSHATRA, WANTPUR",
"city": "Banglaore",
"state_id": 12,
"state_name": "Karnataka",
"zip": "560022",
"country": "India"
}
}
}
],
"nextUrl": "/wms/V2/getVendors?cursor=jmcdFwFx835k6P2BmF92sHF**="
}
Creates Customers. On successful Response,customer_id will be returned.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| companyName |
Company Name of the Customer |
No |
| email |
Email Id of the Customer |
No |
| password |
Password to be set for the Customer Account |
No |
| taxIdentificationNumber |
Tax Identification Number of the Customer |
Yes |
| contactNumber |
Customer Contact Number |
Yes |
| country |
Customer Country |
No |
| billingStateId |
use getStates API for the ID |
No |
| billingStreet |
Customer Billing Street |
Yes |
| billingCity |
Customer Billing City |
Yes |
| billingPostalCode |
Customer Billing Postal Code |
No |
| currency |
Customer Base Currency(should be a 3 character code ex: INR) |
No |
| description |
Customer Description |
Yes |
| dispatchStateId |
use getStates API for the ID |
No |
| dispatchStreet |
Customer Dispatch Street |
Yes |
| dispatchCity |
Customer Dispatch City |
Yes |
| invoiceSeriesCode |
use getCompanyGroupDetails to get the details |
Yes |
| pricingGroupCode |
use getCompanyGroupDetails to get the details |
Yes |
| pricingGroupCode |
use getCompanyGroupDetails to get the details |
Yes |
| salesChannel |
salesChannel of the customer |
Yes |
| salesmanUserId |
sales man user id provided by EasyEcom |
Yes |
| b2bDiscountScheme |
json of price range discount percentage values |
Yes |
Sample Request Body:
{
"companyName": "testInvoice",
"email": "testinvoice@easyecom.io",
"password": "abcchet",
"taxIdentificationNumber": "ABC123EDR34",
"contactNumber": "9036512345",
"country": "India",
"billingStateId": 2,
"billingStreet": "kaikondrahalli,sarjapur road",
"billingCity": "bangalore",
"billingPostalCode": "560035",
"currency": "INR",
"description": "",
"dispatchStateId": 2,
"dispatchStreet": "kaikondrahalli,sarjapur road",
"dispatchCity": "bangalore",
"dispatchPostalCode": "560035",
"invoiceSeriesCode": 25727,
"pricingGroupCode": 148,
"no_copy_master":1,
"salesChannel":"Salon",
"salesmanUserId":17123,
"b2bDiscountScheme": {
"0-999": 17,
"1000-2999": 20,
"3000-5999": 23,
"6000-99999999": 25
},
"customerAttributes": {
"paymentTerm":{
"name": "30 Days",
"value": "30"
},
"deliveryTerm": {
"name": "10-15 Days",
"value": "15"
}
}
}
{
"code":200,
"message":"Customer created Successfully!",
"data":{
"customer_id":9320
}
}
Notice: Optional parameter keys should be present in the json body but can be left blank.
Updates Customers. On successful Response,customer_id will be returned.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| customerId |
customer_id which you get from CreateCustomer API call |
No |
| companyName |
Company Name of the Customer |
Yes |
| email |
Email Id of the Customer |
Yes |
| password |
Password to be set for the Customer Account |
Yes |
| taxIdentificationNumber |
Tax Identification Number of the Customer |
Yes |
| contactNumber |
Customer Contact Number |
Yes |
| country |
Customer Country |
Yes |
| billingState |
Customer Billing State |
Yes |
| billingStreet |
Customer Billing Street |
Yes |
| billingCity |
Customer Billing City |
Yes |
| billingPostalCode |
Customer Billing Postal Code |
Yes |
| currency |
Customer Base Currency(should be a 3 character code ex: INR) |
Yes |
| description |
Customer Description |
Yes |
| dispatchState |
Customer Dispatch State |
Yes |
| dispatchStreet |
Customer Dispatch Street |
Yes |
| dispatchCity |
Customer Dispatch City |
Yes |
| dispatchPostalCode |
Customer dispatch Postal Code |
Yes |
Sample Request Body:
{
"customerId": 9320,
"companyName": "abccet",
"email": "abccet@eacom.io",
"password": "abccet",
"taxIdentificationNumber": "ABX1234EDER",
"contactNumber": "8888899999",
"country": "India",
"currency": "INR",
"description": "puma company",
"billingStreet": "HSR,Sector1",
"billingCity": "Bangalore",
"billingState": "Karnataka",
"billingPostalCode": "560102",
"dispatchStreet": "HSR,Sector1",
"dispatchCity": "Bangalore",
"dispatchPostalCode": "560102",
"dispatchState": "Karnataka"
}
{
"code":200,
"message":"Updated Successfully",
"data":{
"customerId":9320
}
}
On successful Response,B2B customer details will be returned.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| customer |
optional filter which searches the customer which includes the characters mentioned in this field |
Yes |
| type |
b2b/stn |
No |
Description of the Response
| Label | Description |
|--------------------------------|---------------------------------|
|company_invoice_group_id |invoice group id of the customer |
|c_id | customerId |
|companyname | companyname |
|pricingGroup | any related pricing group |
|customer_support_email | customer email |
|customer_support_contact | customer contact number |
|branddescription | brand dexription if any |
|currency_code | currency code of the customer |
{
"code": 200,
"message": " Successfull",
"data": [
{
"company_invoice_group_id": 25725,
"c_id": 6937,
"companyname": "ABC India pvt ltd",
"pricingGroup": "Test group ",
"customer_support_email": "ram.mohan@abc.com",
"customer_support_contact": "9999999999",
"branddescription": null,
"currency_code": "INR",
"billingStreet": "one center",
"billingCity": "Vijayawada",
"billingZipcode": "521225",
"billingState": "Andhra Pradesh",
"billingCountry": "India",
"dispatchStreet": "one center",
"dispatchCity": "Vijayawada",
"dispatchZipcode": "521225",
"dispatchState": "Andhra Pradesh",
"dispatchCountry": "India"
},
{
"company_invoice_group_id": null,
"c_id": 8812,
"companyname": "abcxyz",
"pricingGroup": null,
"customer_support_email": "abcsss@gmail.com",
"customer_support_contact": "3.45679E+11",
"branddescription": "abcxyz delhi",
"currency_code": "INR",
"billingStreet": "cgjiu;gh",
"billingCity": "Delhi",
"billingZipcode": "12345678",
"billingState": "Delhi",
"billingCountry": "NULL",
"dispatchStreet": "cgjiu;gh",
"dispatchCity": "Delhi",
"dispatchZipcode": "12345678",
"dispatchState": "Karnataka",
"dispatchCountry": "NULL"
},
{
"company_invoice_group_id": null,
"c_id": 9320,
"companyname": "abccet",
"pricingGroup": null,
"customer_support_email": "abccet@eacom.io",
"customer_support_contact": "9036512345",
"branddescription": null,
"currency_code": "INR",
"billingStreet": "kaikondrahalli,sarjapur road",
"billingCity": "bangalore",
"billingZipcode": "560035",
"billingState": "Karnataka",
"billingCountry": "NULL",
"dispatchStreet": "kaikondrahalli,sarjapur road",
"dispatchCity": "bangalore",
"dispatchZipcode": "560035",
"dispatchState": "Karnataka",
"dispatchCountry": "NULL"
}
]
}
Creates Products. On successful Response,product_id will be returned.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| Brand |
Brand of the Product |
No |
| Category |
Category of the Product |
Yes |
| ModelName |
Model Name of the Product |
Yes |
| ModelNumber |
Model Number of the Product |
No |
| Description |
Description of the Product |
Yes |
| EANUPC |
EAN/UPC of the Product |
Yes |
| Sku |
Sku of the Product |
No |
| Mrp |
Mrp of the Product |
Yes |
| Cost |
Cost Price of the Product |
Yes |
| Weight |
Weight of the Product(gms) |
Yes |
| Length |
Length of the Product(cms) |
Yes |
| Height |
Height of the Product(cms) |
Yes |
| Width |
Width of the Product(cms) |
Yes |
| ImageURL |
Image url of the Product |
Yes |
| ProductTaxCode |
HSN Code of the Product |
Yes |
| Size |
Size of the Product(Ex:M,XXL) |
Yes |
| TaxRate |
Allowed valyes 0,3,5,12,18,28 |
Yes |
| Color |
Color of the Product |
Yes |
| AccountingSKU |
Accounting Item Name of the Product |
Yes |
| AccountingUnit |
Accounting Item Unit of the Product(Ex:pieces,numbers) |
Yes |
| materialType |
Can be either 1(finished goods) or 2(raw goods) |
No |
| itemType |
should be a valid value from the below itemType table |
Yes |
| subProducts |
should contain an array of atleast 2 products and should be present only for itemType 1 and 2 |
Yes |
| customFields |
Custom fields related to product if any and their value |
Yes |
| itemType |
Value |
| Child |
0 |
| Combo |
1 |
| Kit/BOM |
2 |
Sample Request Body:
{
"AccountingSKU": "",
"AccountingUnit": "",
"Brand": "BLUESTAR",
"Category": "Refrigerator",
"Color": "Black",
"Cost": "29152.72",
"Description": "BLUE STAR INVERTER Refrigerator 1.0 TON 3STAR 3CNHW12OATU (BI/BO)",
"EANUPC": "",
"Height": "",
"ImageURL": "",
"Length": "",
"ModelName": "BLUE STAR INVERTER Refrigerator 1.0 TON 3STAR 3CNHW12OATU (BI/BO)",
"ModelNumber": "BI/BO-3CNHW12OATU",
"Mrp": "44000.00",
"ProductTaxCode": "",
"Size": "",
"Sku": "Refrigerator-NonACSplit",
"TaxRuleName": "",
"Weight": "",
"Width": "",
"itemType":"1"
"materialType":1,
"subProduct": [ // should be present only for itemType 1 and 2
{
"sku": "misTik1",
"quantity": 1
},
{
"sku": "misTik2",
"quantity": 1
}
],
"customFields":{
"Door":"2",
"With Adapter":"yes"
}
}
{
"code":200,
"message":"Product created Successfully!",
"data":{
"product_id":18110605
}
}
Notice: Optional parameter keys should be present in the json body but can be left blank.
Gets All the master products for the location.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| category |
Category of the Product(only one at a time) |
Yes |
| includeLocations |
passing 1 will give you the inventory details of all the locations related to api_token passed/passing 0 will give the details of only one location for which api_token is related |
Yes |
| cpIds |
comma separated Cp IDs of the products (maximum 10) |
Yes |
| limit |
Number of products per page (maximum 200) |
Yes |
| product_type |
get Specific type of product |
Yes |
| active |
passign 1 will give active products/passign 0 will give inactive products |
Yes |
| updated_after |
product update datetime |
Yes |
| custom_fields |
include custom fields in the response |
Yes |
| product_type |
Value |
| Normal Product |
0 |
| Combo |
1 |
| Kit/BOM |
2 |
| Variant parent |
3 |
Sample Request Body:
https://api.easyecom.io/Products/GetProductMaster?api_token=yourapitoken&limit=30&category=abc&is_combo=1&custom_fields=1
{
"data": [
{
"cp_id": 52240404,
"product_id": 16170752,
"sku": "500ML",
"product_name": null,
"description": "VOOKI FLOOR+SURFACE CLEANER 20 X 500ML",
"active": 0,
"created_at": "2021-08-06 12:45:10",
"inventory": 0,
"product_type": "normal_product",
"brand": "VOOKI",
"colour": "NA",
"category_id": 148299,
"category_name": "Vooki Premium",
"company_name": "Teal & Terra_Gurgaon",
"c_id":3242,
"height": null,
"length": null,
"width": null,
"weight": null,
"cost": 0,
"mrp": 199,
"cp_sub_products_count": 0,
"model_no": "MVMPCCB20D500011",
"hsn_code": null,
"tax_rate": null,
"product shelf life": null,
"product_image_url": null
"additional_images": [
"https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/CPImages/38453772021051010742.jpeg?request-content-type=application/force-download",
"https://ee-uploaded-files.s3.ap-south-1.amazonaws.com/CPImages/84387202021051032815.jpeg",
"https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/CPImages/79248862021072962422.jpeg"
],
"custom_fields": [
{
"cp_id": 57697931,
"field_name": "Department",
"value": "Department 1",
"enabled": 1
},
{
"cp_id": 57697931,
"field_name": "Division",
"value": "Division 1",
"enabled": 1
},
{
"cp_id": 57697931,
"field_name": "Management",
"value": "Management 1",
"enabled": 1
},
{
"cp_id": 57697931,
"field_name": "Purpose",
"value": "Purpose 1",
"enabled": 1
},
{
"cp_id": 57697931,
"field_name": "Brand Number",
"value": "Brand 1",
"enabled": 1
},
{
"cp_id": 57697931,
"field_name": "Cat No.",
"value": "Cat 1",
"enabled": 1
}
]
},
{
"cp_id": 52278252,
"product_id": 16275573,
"sku": "TATC020",
"product_name": "3 Natural Facewash for the price of 2, 100ml each",
"description": null,
"active": 1,
"created_at": "2021-08-09 15:25:58",
"inventory": 0,
"product_type": "combo_product",
"brand": "Teal and Terra",
"colour": "NA",
"category_id": 138404,
"category_name": "Beauty",
"company_name": "Teal & Terra_Gurgaon",
"height": 15,
"length": 15,
"width": 10,
"weight": 500,
"cost": 0,
"mrp": 1360,
"cp_sub_products_count": 3,
"model_no": "",
"hsn_code": null,
"tax_rate": 0.18,
"product shelf life": null,
"product_image_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/TATC020_46042.jpg%253Fv%253D1624995628",
"sub_products": [
{
"sku": "TAT021",
"combo_cp_id": 52278252,
"quantity": 1,
"cpId": 52278336,
"product_id": 16275601,
"product_name": "Neem Face Wash with Basil & Aloe Vera, 100ml",
"height": 5,
"length": 13,
"width": 5,
"weight": 100,
"cost": 0,
"mrp": 680,
"cp_sub_products_count": 3,
"model_no": "",
"hsn_code": null,
"tax_rate": 0.18,
"product shelf life": null,
"product_image_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/TAT021_46042.jpg%253Fv%253D1624995718"
},
{
"sku": "TAT022",
"combo_cp_id": 52278252,
"quantity": 1,
"cpId": 52278354,
"product_id": 16275607,
"product_name": "Rose and Shea Butter Face Wash, 100ml",
"height": 5,
"length": 13,
"width": 5,
"weight": 100,
"cost": 0,
"mrp": 680,
"cp_sub_products_count": 3,
"model_no": "",
"hsn_code": null,
"tax_rate": 0.18,
"product shelf life": null,
"product_image_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/TAT022_46042.jpg%253Fv%253D1624995751"
},
{
"sku": "GP_face wash",
"combo_cp_id": 52278252,
"quantity": 1,
"cpId": 55180324,
"product_id": 16453044,
"product_name": "GP_face wash",
"height": 5,
"length": 14,
"width": 4,
"weight": 100,
"cost": 0,
"mrp": 680,
"cp_sub_products_count": 3,
"model_no": "TEAL AND TERRA",
"hsn_code": null,
"tax_rate": 0.18,
"product shelf life": null,
"product_image_url": null
}
]
},
{
"cp_id": 52278366,
"product_id": 16275611,
"sku": "TTCFH004",
"product_name": "Skin and Hair Care- Kumkumadi Oil with Onion & Castor Oil",
"description": null,
"active": 1,
"created_at": "2021-08-09 15:30:58",
"inventory": 0,
"product_type": "variant_parent",
"brand": "Teal & Terra",
"colour": null,
"category_id": 139588,
"category_name": "Combo",
"company_name": "Teal & Terra_Gurgaon",
"height": 10,
"length": 17,
"width": 10,
"weight": 800,
"cost": 0,
"mrp": 3,
"cp_sub_products_count": 2,
"model_no": "",
"hsn_code": null,
"tax_rate": 0.18,
"product shelf life": null,
"product_image_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/TTCFH004_46042.jpg%253Fv%253D1624995774",
"variants": [
{
"sku": "E5-B1NW-4OCX",
"parent_cpId": 52278366,
"cpId": 55404101,
"active": 1,
"product_id": 16473409,
"product_name": "Teal & Terra - Kumkumadi Oil with Onion Oil for Skin and Hair Repair Combo - Organic Range",
"created_at": "2021-09-15 14:10:25",
"inventory": 0,
"brand": "Teal and Terra",
"colour": null,
"category_id": 139588,
"category_name": "Combo",
"height": null,
"length": null,
"width": null,
"weight": null,
"cost": 3640,
"mrp": 3640,
"model_no": "E5-B1NW-4OCX",
"hsn_code": null,
"tax_rate": 0.18,
"product shelf life": null,
"product_image_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/E5_B1NW_4OCX_46042.com/file/d/1ZzaSTG9vFtwX7GORiKXuEzBqyRi2xlyS/view%253Fusp%253Dsharing"
},
{
"sku": "E5-B1NW-4OCX",
"parent_cpId": 52278366,
"cpId": 55506210,
"active": 1,
"product_id": 16473409,
"product_name": "Teal & Terra - Kumkumadi Oil with Onion Oil for Skin and Hair Repair Combo - Organic Range",
"created_at": "2021-09-21 13:37:21",
"inventory": 0,
"brand": "Teal and Terra",
"colour": null,
"category_id": 139588,
"category_name": "Combo",
"height": null,
"length": null,
"width": null,
"weight": null,
"cost": 3640,
"mrp": 3640,
"model_no": "E5-B1NW-4OCX",
"hsn_code": null,
"tax_rate": null,
"product shelf life": null,
"product_image_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/E5_B1NW_4OCX_46042.com/file/d/1ZzaSTG9vFtwX7GORiKXuEzBqyRi2xlyS/view%253Fusp%253Dsharing"
},
{
"sku": "E5-B1NW-4OCX",
"parent_cpId": 52278366,
"cpId": 56280547,
"active": 1,
"product_id": 16473409,
"product_name": "Teal & Terra - Kumkumadi Oil with Onion Oil for Skin and Hair Repair Combo - Organic Range",
"created_at": "2021-10-01 16:00:32",
"inventory": 0,
"brand": "Teal and Terra",
"colour": null,
"category_id": 139588,
"category_name": "Combo",
"height": null,
"length": null,
"width": null,
"weight": null,
"cost": 3640,
"mrp": 3640,
"model_no": "E5-B1NW-4OCX",
"hsn_code": null,
"tax_rate": null,
"product shelf life": null,
"product_image_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/E5_B1NW_4OCX_46042.com/file/d/1ZzaSTG9vFtwX7GORiKXuEzBqyRi2xlyS/view%253Fusp%253Dsharing"
},
{
"sku": "E5-B1NW-4OCX",
"parent_cpId": 52278366,
"cpId": 56314252,
"active": 1,
"product_id": 16473409,
"product_name": "Teal & Terra - Kumkumadi Oil with Onion Oil for Skin and Hair Repair Combo - Organic Range",
"created_at": "2021-10-04 13:20:14",
"inventory": 0,
"brand": "Teal and Terra",
"colour": null,
"category_id": 139588,
"category_name": "Combo",
"height": null,
"length": null,
"width": null,
"weight": null,
"cost": 3640,
"mrp": 3640,
"model_no": "E5-B1NW-4OCX",
"hsn_code": null,
"tax_rate": null,
"product shelf life": null,
"product_image_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/E5_B1NW_4OCX_46042.com/file/d/1ZzaSTG9vFtwX7GORiKXuEzBqyRi2xlyS/view%253Fusp%253Dsharing"
},
{
"sku": "E5-B1NW-4OCX",
"parent_cpId": 52278366,
"cpId": 56473080,
"active": 1,
"product_id": 16473409,
"product_name": "Teal & Terra - Kumkumadi Oil with Onion Oil for Skin and Hair Repair Combo - Organic Range",
"created_at": "2021-10-12 12:43:23",
"inventory": 0,
"brand": "Teal and Terra",
"colour": null,
"category_id": 139588,
"category_name": "Combo",
"height": null,
"length": null,
"width": null,
"weight": null,
"cost": 3640,
"mrp": 3640,
"model_no": "E5-B1NW-4OCX",
"hsn_code": null,
"tax_rate": null,
"product shelf life": null,
"product_image_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/E5_B1NW_4OCX_46042.com/file/d/1ZzaSTG9vFtwX7GORiKXuEzBqyRi2xlyS/view%253Fusp%253Dsharing"
},
{
"sku": "E5-B1NW-4OCX",
"parent_cpId": 52278366,
"cpId": 56910878,
"active": 1,
"product_id": 16473409,
"product_name": "Teal & Terra - Kumkumadi Oil with Onion Oil for Skin and Hair Repair Combo - Organic Range",
"created_at": "2021-10-28 17:08:17",
"inventory": 0,
"brand": "Teal and Terra",
"colour": null,
"category_id": 139588,
"category_name": "Combo",
"height": null,
"length": null,
"width": null,
"weight": null,
"cost": 3640,
"mrp": 3640,
"model_no": "E5-B1NW-4OCX",
"hsn_code": null,
"tax_rate": 0.18,
"product shelf life": null,
"product_image_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/E5_B1NW_4OCX_46042.com/file/d/1ZzaSTG9vFtwX7GORiKXuEzBqyRi2xlyS/view%253Fusp%253Dsharing"
},
{
"sku": "E5-B1NW-4OCX",
"parent_cpId": 52278366,
"cpId": 56912785,
"active": 1,
"product_id": 16473409,
"product_name": "Teal & Terra - Kumkumadi Oil with Onion Oil for Skin and Hair Repair Combo - Organic Range",
"created_at": "2021-10-28 18:02:00",
"inventory": 0,
"brand": "Teal and Terra",
"colour": null,
"category_id": 139588,
"category_name": "Combo",
"height": null,
"length": null,
"width": null,
"weight": null,
"cost": 3640,
"mrp": 3640,
"model_no": "E5-B1NW-4OCX",
"hsn_code": null,
"tax_rate": 0.18,
"product shelf life": null,
"product_image_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/E5_B1NW_4OCX_46042.com/file/d/1ZzaSTG9vFtwX7GORiKXuEzBqyRi2xlyS/view%253Fusp%253Dsharing"
},
{
"sku": "E5-B1NW-4OCX",
"parent_cpId": 52278366,
"cpId": 56913235,
"active": 1,
"product_id": 16473409,
"product_name": "Teal & Terra - Kumkumadi Oil with Onion Oil for Skin and Hair Repair Combo - Organic Range",
"created_at": "2021-10-28 18:08:30",
"inventory": 0,
"brand": "Teal and Terra",
"colour": null,
"category_id": 139588,
"category_name": "Combo",
"height": null,
"length": null,
"width": null,
"weight": null,
"cost": 3640,
"mrp": 3640,
"model_no": "E5-B1NW-4OCX",
"hsn_code": null,
"tax_rate": 0.18,
"product shelf life": null,
"product_image_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/E5_B1NW_4OCX_46042.com/file/d/1ZzaSTG9vFtwX7GORiKXuEzBqyRi2xlyS/view%253Fusp%253Dsharing"
},
{
"sku": "E5-B1NW-4OCX",
"parent_cpId": 52278366,
"cpId": 56913852,
"active": 1,
"product_id": 16473409,
"product_name": "Teal & Terra - Kumkumadi Oil with Onion Oil for Skin and Hair Repair Combo - Organic Range",
"created_at": "2021-10-28 18:30:55",
"inventory": 0,
"brand": "Teal and Terra",
"colour": null,
"category_id": 139588,
"category_name": "Combo",
"height": null,
"length": null,
"width": null,
"weight": null,
"cost": 3640,
"mrp": 3640,
"model_no": "E5-B1NW-4OCX",
"hsn_code": null,
"tax_rate": 0.18,
"product shelf life": null,
"product_image_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/E5_B1NW_4OCX_46042.com/file/d/1ZzaSTG9vFtwX7GORiKXuEzBqyRi2xlyS/view%253Fusp%253Dsharing"
},
{
"sku": "E5-B1NW-4OCX",
"parent_cpId": 52278366,
"cpId": 56914314,
"active": 1,
"product_id": 16473409,
"product_name": "Teal & Terra - Kumkumadi Oil with Onion Oil for Skin and Hair Repair Combo - Organic Range",
"created_at": "2021-10-28 18:32:29",
"inventory": 0,
"brand": "Teal and Terra",
"colour": null,
"category_id": 139588,
"category_name": "Combo",
"height": null,
"length": null,
"width": null,
"weight": null,
"cost": 3640,
"mrp": 3640,
"model_no": "E5-B1NW-4OCX",
"hsn_code": null,
"tax_rate": 0.18,
"product shelf life": null,
"product_image_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/E5_B1NW_4OCX_46042.com/file/d/1ZzaSTG9vFtwX7GORiKXuEzBqyRi2xlyS/view%253Fusp%253Dsharing"
},
{
"sku": "E5-B1NW-4OCX",
"parent_cpId": 52278366,
"cpId": 56983645,
"active": 1,
"product_id": 16473409,
"product_name": "Teal & Terra - Kumkumadi Oil with Onion Oil for Skin and Hair Repair Combo - Organic Range",
"created_at": "2021-11-02 15:29:57",
"inventory": 0,
"brand": "Teal and Terra",
"colour": null,
"category_id": 139588,
"category_name": "Combo",
"height": null,
"length": null,
"width": null,
"weight": null,
"cost": 3640,
"mrp": 3640,
"model_no": "E5-B1NW-4OCX",
"hsn_code": null,
"tax_rate": 0.18,
"product shelf life": null,
"product_image_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/E5_B1NW_4OCX_46042.com/file/d/1ZzaSTG9vFtwX7GORiKXuEzBqyRi2xlyS/view%253Fusp%253Dsharing"
}
]
}
],
"nextUrl": "/Products/GetProductMaster?cursor=9oHZj2iTMEe1LOvfFf/jIxp1nfLCP28Lng8jvmAXoZ1yrEl1TqrxXx0ty9bUt5gtzOssjvMhAQUx1vuJD_w8hfO3lUFjSy43VXhyfURav7nGEqJOXujkkde7bXGiadE2UtR4RUkc5iTg6ndK7gjkLMWovVN6IDYU8oVAQAq_3yLlbK3deHcvDCqamHIcs8KT"
}
Gets All the master products for the location.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| category |
Category of the Product(only one at a time) |
Yes |
| includeLocations |
passing 1 will give you the inventory details of all the locations related to api_token passed/passing 0 will give the details of only one location for which api_token is related |
Yes |
| cpIds |
comma separated Cp IDs of the products (maximum 10) |
Yes |
| product_type |
get Specific type of product |
Yes |
| active |
passign 1 will give active products/passign 0 will give inactive products |
Yes |
| product_type |
Value |
| Normal Product |
0 |
| Combo |
1 |
| Kit/BOM |
2 |
| Variant parent |
3 |
Sample Request Body:
https://api.easyecom.io/Products/GetProductMastersCount?api_token=yourapitoken&category=abc&is_combo=1
Creates Products. On successful Response,product_id will be returned.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| productId/ sku |
Product ID or master sku which you will get from CreateMasterProduct API |
No |
| Brand |
Brand of the Product |
Yes |
| Category |
Category of the Product |
Yes |
| ModelName |
Model Name of the Product |
Yes |
| ModelNumber |
Model Number of the Product |
Yes |
| Description |
Description of the Product |
Yes |
| EANUPC |
EAN/UPC of the Product |
Yes |
| Mrp |
Mrp of the Product |
Yes |
| Cost |
Cost Price of the Product |
Yes |
| Weight |
Weight of the Product(gms) |
Yes |
| Length |
Length of the Product(cms) |
Yes |
| Height |
Height of the Product(cms) |
Yes |
| Width |
Width of the Product(cms) |
Yes |
| ImageURL |
Image url of the Product |
Yes |
| ProductTaxCode |
HSN Code of the Product |
Yes |
| Size |
Size of the Product(Ex:M,XXL) |
Yes |
| Color |
Color of the Product |
Yes |
| AccountingSKU |
Accounting Item Name of the Product |
Yes |
| AccountingUnit |
Accounting Item Unit of the Product(Ex:pieces,numbers) |
Yes |
| customFields |
Custom fields related to product if any and their value |
Yes |
Sample Request Body:
{
"productId": 18110605,
"Color": "DarkGrey",
"Cost": "32000.00",
"Description": "BLUE STAR INVERTER Refrigerator 5STAR 3CNHW12",
"ModelName": "BLUE STAR INVERTER Refrigerator 5STAR 3CNHW12",
"Mrp": "42000.00",
"customFields": {
"Door": "3",
"Warranty": "10"
}
}
{
"data": [
{
"cp_id": 21855110,
"product_id": 13862051,
"sku": "Dazel_COM2",
"product_name": "Dazel_COM2",
"description": null,
"active": 1,
"created_at": "2020-05-20 17:46:53",
"inventory": 0,
"product_type": "combo_product",
"brand": "easyecom-test2",
"colour": "NA",
"category_id": 81790,
"category_name": "Unknown",
"company_name": "Jaiswal Servises",
"height": 0,
"length": 0,
"width": 0,
"weight": 0,
"cost": 200,
"mrp": 2000,
"cp_sub_products_count": 1,
"model_no": "",
"product shelf life": null,
"product_image_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/Dazel_COM2_187.jpg%25253Frequest-content-type%25253Dapplication/force-download",
"sub_products": [
{
"sku": "XBOX1",
"combo_cp_id": 21855110,
"quantity": 1,
"cpId": 21878852,
"product_name": null,
"height": 10,
"length": 10,
"width": 10,
"weight": 500
}
]
},
{
"cp_id": 22620948,
"product_id": 13982596,
"sku": "TestCombo123",
"product_name": "TestCombo123",
"description": "TestCombo123",
"active": 1,
"created_at": "2020-07-29 19:56:15",
"inventory": 0,
"product_type": "combo_product",
"brand": "Nike",
"colour": "NA",
"category_id": 81797,
"category_name": "Map",
"company_name": "Jaiswal Servises",
"height": 10,
"length": 10,
"width": 10,
"weight": 100,
"cost": 1000,
"mrp": 1000,
"cp_sub_products_count": 1,
"model_no": "TestCombo123",
"product shelf life": null,
"product_image_url": null,
"sub_products": [
{
"sku": "abcfdfdf_m",
"combo_cp_id": 22620948,
"quantity": 2,
"cpId": 22406446,
"product_name": "",
"height": 0,
"length": 0,
"width": 0,
"weight": 0
}
]
},
{
"cp_id": 22622739,
"product_id": 13982605,
"sku": "TestCombo1212",
"product_name": "TestCombo1212",
"description": "TestCombo1212",
"active": 1,
"created_at": "2020-07-29 20:13:52",
"inventory": 0,
"product_type": "combo_product",
"brand": "Nike",
"colour": null,
"category_id": 81797,
"category_name": "Map",
"company_name": "Jaiswal Servises",
"height": 10,
"length": 10,
"width": 10,
"weight": 100,
"cost": 1000,
"mrp": 1000,
"cp_sub_products_count": 2,
"model_no": "TestCombo1212",
"product shelf life": null,
"product_image_url": null,
"sub_products": [
{
"sku": "XBOX2",
"combo_cp_id": 22622739,
"quantity": 2,
"cpId": 21605800,
"product_name": "XBOX2",
"height": 10,
"length": 10,
"width": 10,
"weight": 10
},
{
"sku": "XBOX3",
"combo_cp_id": 22622739,
"quantity": 3,
"cpId": 21605801,
"product_name": "XBOX36",
"height": 10,
"length": 10,
"width": 10,
"weight": 10
}
]
}
],
"nextUrl": "/Products/GetProductMaster?cursor=M_ABRe18PkzSr_mOFJIBGYCH/ZbtwHvrbsfo2AoI8VhM0AsbGZ7EsVpZxJI2Hg9hxbOfTMgwHLjfyIB9Xem1xHJFGuasXKOE7PivYc66ZsKnsPl66q0Oj82Jr/7tjcLuRV8swlWtjWwGcgv9X7W3qSmrX_ZiQZ6lv9xujtmErVP90GnUFcpX2ZjSH88Kvo69tebfM7BlSeYf0IrH2aOraQ=="
}
Notice: Optional parameter keys should be present in the json body but can be left blank.
Lists available marketplaces.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
{
"code": 200,
"message": "Successful",
"data": [{
"id": 1,
"name": "EBAY_INDIA"
}, {
"id": 2,
"name": "Flipkart"
}, {
"id": 3,
"name": "Myntra"
}, {
"id": 4,
"name": "Snapdeal"
}, {
"id": 6,
"name": "SHOPCLUES"
}, {
"id": 8,
"name": "Amazon.in"
}]
}
Creates Purchase Order. On successful Response,Purchase Order ID will be returned.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| vendorId |
Vendor ID/Vendor Code for which purchase order has to be created. |
No |
| lineItemNumber |
item Number If Any |
Yes |
| sku |
SKU of the Product |
No |
| quantity |
Quantity of the Product |
No |
| unitPrice |
Unit Price of the Product including tax |
No |
| taxRate |
Tax Rate to be applied on the product |
Yes |
| taxValue |
Total tax value of the product |
Yes |
| taxType |
Kindly choose anyone of the value from the below taxType table |
Yes |
| referenceCode |
ReferenceCode of the PO |
No |
| docNumber |
Document Number of the PO |
Yes |
| address |
Address of the PO |
Yes |
| expDeliveryDate |
Expected Delivery Date of the PO |
Yes |
| shippingCost |
Shipping Cost involved |
Yes |
| createOrUpdate |
I for create and U for the update |
No |
| isCancel |
should be 1 if you are cancelling it |
Yes |
| updateTaxRate |
should be 1 if you want us to insert/update the tax rate of the product else 0 |
Yes |
taxType Table.
| taxType |
Value |
| IGST |
1 |
| CGST/SGST |
2 |
| Custom |
3 |
Sample Request Body:
{
"vendorId": 7940,
"referenceCode": "TestPo123",
"address": "",
"expDeliveryDate": "2019-07-20",
"shippingCost": 0,
"createOrUpdate": "I/U",
"isCancel": 1,
"docNumber": "12",
"updateTaxRate": 1,
"items": [
{
"lineItemNumber": "12",
"sku": "XBOX1",
"quantity": "5",
"unitPrice": 5,
"taxRate": "18",
"taxValue": 3.8,
"taxType": 1
}
]
}
{
"code": 200,
"message": "Purchase order Created Successfully!",
"data": {
"poId": 14290
}
}
Notice: Optional parameter keys should be present in the json body but can be left blank. By default the status of the Purchase will be Waiting for Approval.
Returns the PO created for the given date range.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| limit |
Max of 10 can be given. By default the limit will be 5 |
Yes |
| po_ids |
comma seperated EasyEcom's PO Ids |
yes |
| created_after |
PO Created Date |
Yes |
| created_before |
PO Created Date |
Yes |
| po_status_id |
PO Status Id. Can be chosen from the below table |
Yes |
Note: If none of the optional parameters are passed, be default a total of 5 POs data will be received in the Response according to PO created date.
PO status and their IDs
| ID | Status |
|-------|-----------------------|
|1 | Open |
|2 | Waiting for Approval |
|3 | Approved |
|4 | Rejected |
|5 | Completed |
|6 | Pending On Supplier |
|7 | Cancelled |
|8 | Payment Pending |
|9 | Payment Done |
|11 | Shipped to FF |
|12 | Pending dispatch on FF|
|13 | Shipped |
|14 | Shipped by FF |
|15 | Recived by FF |
|16 | Invoice Done By Vendor|
{
"data": [
{
"po_id": 1391155,
"total_po_value": "1980.0000",
"po_number": 9310,
"po_ref_num": "Auto PO",
"po_status_id": 5,
"po_created_date": "2022-02-05 12:26:23",
"po_updated_date": "2022-02-05 12:26:23",
"po_created_warehouse": "Hygiene Pvt Ltd",
"po_created_warehouse_c_id": 160189,
"vendor_name": "Hygiene Pvt Ltd",
"vendor_c_id": 160189,
"po_items": [
{
"purchase_order_detail_id": 40821932,
"cp_id": 237484169,
"product_id": 142715349,
"sku": "FS1P004",
"hsn": "481819000",
"model_no": "FSP1004",
"ean": "89080014343074",
"product_description": "Intimate Wet Wipes",
"original_quantity": 1980,
"pending_quantity": 0,
"item_price": "1.0000"
}
]
}
],
"nextUrl": "/wms/V2/getPurchaseOrderDetails?cursor=/57L9KaPhyGxJU**"
}
Return the grn created b/w the date range given.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| limit |
Max of 10 can be given. By default the limit will be 5 |
Yes |
| grn_ids |
comma seperated EasyEcom's GRN Ids |
yes |
| po_ids |
comma seperated EasyEcom's PO Ids |
yes |
| invoice_start_date |
GRN Invoice Date |
Yes |
| invoice_end_date |
GRN Invoice Date |
Yes |
| created_after |
GRN Created Date |
Yes |
| created_before |
GRN Created Date |
Yes |
| grn_status_id |
GRN Status Id. Can be chosen from the below table |
Yes |
Note: If none of the optional parameters are passed, be default a total of 5 GRNs data will be received in the Response according to GRN created date.
GRN status and their IDs
| ID | Status |
|-------|---------------|
|1 | CREATED |
|2 | QC Pending |
|3 | QC Complete |
|4 | Deleted |
{
"data": [
{
"grn_id": 11551,
"grn_invoice_number": "10231",
"total_grn_value": 226400,
"grn_status_id": 3,
"grn_status": "QC Complete",
"grn_created_at": "2022-01-31 14:03:49",
"grn_invoice_date": "2022-01-29",
"po_id": 1342254,
"po_number": 8925,
"po_ref_num": "",
"po_status_id": 3,
"po_created_date": "2022-01-21 12:52:38",
"po_updated_date": "2022-01-21 12:52:38",
"inwarded_warehouse": "Hygiene Pvt Ltd",
"inwarded_warehouse_c_id": 160289,
"vendor_name": "AVNA ENTERPRISES",
"vendor_c_id": 232504,
"grn_items": [
{
"grn_detail_id": 42642236,
"purchase_order_detail_id": 39777272,
"cp_id": 237428637,
"product_id": 142275517,
"sku": "DDB",
"hsn": null,
"model_no": "DDB",
"ean": "0",
"product_description": "Diapers Disposal Bag",
"original_quantity": 200000,
"pending_quantity": 176000,
"received_quantity": 24000,
"grn_detail_price": 1.1,
"shelf_id": 91014,
"expire_date": null,
"batch_code": null,
"available": 24000,
"reserved": 0,
"sold": 0,
"repair": 0,
"lost": 0,
"damaged": 0,
"gifted": 0,
"return_to_source": 0,
"return_available": 0,
"qc_pending": 0,
"qc_pass": 0,
"qc_fail": 0,
"transfer": 0,
"discard": 0,
"used_in_manufacturing": 0,
"adjusted": 0,
"near_expiry": 0,
"expiry": 0
}
]
}
],
"nextUrl": "/Grn/V2/getGrnDetails?cursor=0_9NSUQ****"
}
Inserts the pricing of the sku.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| priceGroupId |
Id of the pricing group created |
No |
| sku |
SKU of the Product |
No |
| minQty |
Min QTY |
No |
| maxQty |
If there is no max limit, pass -1 |
No |
| price |
Price of the product |
No |
Sample Request Body:
{
"priceGroupId": 67,
"priceItems": [
{
"sku": "ABCXYZ",
"minQty": 1,
"MaxQty":100,
"price":10000
},
{
"sku": "ABCXYZ",
"minQty": 101,
"MaxQty":-1,
"price":9000
},
{
"sku": "testkkk",
"minQty": 0,
"MaxQty":-1,
"price":15000
}]
}
{
"code":200,
"message":"Successfull",
"data":{
"Error":[]
}
}
Maps the channel listings with master sku in EasyEcom.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| channelId |
Easyecom channel Id |
No |
| identifier |
identifier for a product which differs from channel to channel |
No |
| masterSku |
master sku created in EasyEcom |
No |
Some of the identifiers for the marketplaces are given below
| Marketplace | Identifier |
|----------------|---------------------------------|
|Flipkart | FSN |
|Amazon | ASIN |
|Snapdeal | SUPC |
|Paytm | Paytm SKU |
Sample Request Body:
{
"channelId": 2,
"identifier": "WATDRFVPZKDCZ9HE",
"masterSku": "Cooler_12"
}
{
"code":200,
"message":"Successfull",
"data":[]
}
Function: getPaymentAndDeliveryTermDetails
End Point URL: /Maintenance/getCompanyAttributes?api_token=xxxxxxxx&type=payment
Returns the payment or delivery term names and code which will be useful in other API calls.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| type |
can take either payment or delivery as value |
No |
{
"code": 200,
"message": "Success",
"data": [
{
"flag_name": "15 Days",
"value": "15"
},
{
"flag_name": "30 Days",
"value": "30"
},
{
"flag_name": "45 Days",
"value": "45"
},
{
"flag_name": "60 Days",
"value": "60"
}
]
}
End Point URL: /Maintenance/getCompanyGroupDetails?api_token=xxxxxxxx&type=invoice&start_year=2019
Returns the invoice or pricing group values and code which will be useful in other API calls.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| type |
can take either invoice or pricing as value |
No |
| start_year |
mandatory if type is invoice |
|
{
"code": 200,
"message": "Success",
"data": [
{
"id": 25683,
"description": "Delhi Warehouse (D_)"
}
]
}
Returns the MarketPlace listings. If MasteSKu is not present then listing is not mapped to any master.Keep increase the page number till it gives empty array to get all the listings. page size increament is not recomendate.
{
"code": 200,
"message": "Listings Found",
"data": [
{
"name": "2GUD",
"sku": "294063.02",
"MasterSKU": null,
"mrp": 501,
"site_uid": "SXCFGRY8EHTGF8MT",
"listing_ref_number": "LSTSXCFGRY8EHTGF8MTTVPZDY",
"UID": "530d890d-ec4a-4812-aa35-962493dccf38",
"identifier": "SXCFGRY8EHTGF8MT",
"title": "UEBDANAI Hit Color Small Shoulder Handbags Women Lattice Crossbody Bag (Light Brown) Shoulder Bag"
},
{
"name": "2GUD",
"sku": "294357.02",
"MasterSKU": null,
"mrp": 715,
"site_uid": "SXCFGR2Z38F5TVWG",
"listing_ref_number": "LSTSXCFGR2Z38F5TVWGRHZFWK",
"UID": null,
"identifier": "SXCFGR2Z38F5TVWG",
"title": "UEBDANAI 2pcs/set Solid Color Clear Slingbag Women Crossbody Bags (Blue) Sling Bag"
}
}
Starts importing the listings for the selected marketplace/channel.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| marketplaceId |
Easyecom channel/marketplace Id |
No |
{
"code": 200,
"message": "Listing Import Started!!",
"data": []
}
Creates Order. On successful Response,Order ID will be returned.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| orderType |
Select valid order type from below . |
No |
| orderNumber |
Order Number . |
No |
| orderDate |
Order Date |
No |
| expDeliveryDate |
Expected Delivery date |
Yes |
| remarks1 |
Remarks if any |
Yes |
| remarks2 |
Remarks if any |
Yes |
| queue |
should be set to 1 if you want to queue the order(Should be utilized only for orders with order type businessorder and stocktransferorder) |
Yes |
| OrderItemId |
item id of the product |
Yes |
| Sku |
SKU of the Product |
No |
| itemDiscount |
Item level discount |
yes |
| Quantity |
Quantity of the Product |
No |
| Price |
Unit Price of the Product |
No |
| shippingCost |
shipping cost of the order |
yes |
| salesmanId |
salesmanId |
yes |
| discount |
discount cost of the order |
yes |
| marketplaceId |
marketplace id mandatory for retailorder type |
yes |
| paymentMode |
payment mode id from the below table |
No |
| shippingMethod |
shipping mode id from the below table |
No |
| custom_fields |
custo field id will be available using getCustomFields API |
yes |
| paymentTransactionNumber |
payment transaction number applicable for prepaid orders |
yes |
| packageWeight, packageHeight, packageWidth, packageLength |
Either all the fileds should mentioned or none. PackageWeight should be in grams and the rest in cms |
Yes |
| orderType | customerId |
|---------------------|-----------------|
|retailorder | should not be present |
|businessorder | Mandatory |
|stocktransferorder | Mandatory |
|productionorder | should not be present |
| paymentMode | paymentModeId |
|-------------|----------------|
|COD | 2 |
|PrePaid | 5 |
| shippingMethod | shippingMethodId |
|-------------------|-------------------|
|Standard COD | 1 |
|Standard Prepaid | 3 |
Sample Request Body:
{
"orderType":"productionorder",
"marketplaceId":2,
"orderNumber": "SampleOr001",
"orderDate": "2019-10-01",
"expDeliveryDate": "2019-10-10",
"remarks1": "abc",
"remarks2": "xyz",
"shippingCost": 20,
"discount": 20,
"walletDiscount":5,
"promoCodeDiscount":5,
"prepaidDiscount":5,
"paymentMode":5,
"paymentGateway":"PayU"
"shippingMethod":1,
"packageWeight":100,
"packageHeight":10,
"packageWidth":10,
"packageLength":10,
"queue":1,
"salesmanId":19743,
"paymentTransactionNumber":20201130191624,
"items": [
{
"OrderItemId": "123433245",
"Sku": "ABCXYZ",
"productName":"ABCXYZ Test Demo",
"Quantity": "5",
"Price": 5,
"itemDiscount": 1,
"custom_fields": [
{
"id": 773,
"value": "test"
},
{
"id": 774,
"value": "test1"
}
]
}
],
"customer":[ --- no need to send this for productionorder
{
"customerId":123, --- mandatory for businessorder and stocktransferorder.
"billing":{ --- mandatory only for retail order. If you provide billing and shipping for businessorder/stocktransferorder, it will overide the available address of the customer only for this order.
"name":"test",
"addressLine1":"testaddress1",
"addressLine2":"testaddress2",
"postalCode":"700852",
"city":"bangalore",
"state":"karnataka",
"country":"India",
"contact":"9956567723",
"email":"test@gmail.com"
},
"shipping":{
"name":"test1",
"addressLine1":"testaddress3",
"addressLine2":"testaddress4",
"postalCode":"560035",
"city":"bangalore",
"state":"karnataka",
"country":"India",
"contact":"9956567724",
"email":"test@gmail.com"
}
}
]
}
{
"code": 200,
"message": "SampleOr001 created successfully",
"data": []
}
Creates Kitted Product. On successful Response,product_id will be returned.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| Brand |
Brand of the Product |
Yes |
| Category |
Category of the Product |
Yes |
| ModelName |
Model Name of the Product |
Yes |
| ModelNumber |
Model Number of the Product |
Yes |
| Description |
Description of the Product |
Yes |
| EANUPC |
EAN/UPC of the Product |
Yes |
| Sku |
Sku of the Product |
No |
| Mrp |
Mrp of the Product |
Yes |
| Cost |
Cost Price of the Product |
Yes |
| Weight |
Weight of the Product(gms) |
Yes |
| Length |
Length of the Product(cms) |
Yes |
| Height |
Height of the Product(cms) |
Yes |
| Width |
Width of the Product(cms) |
Yes |
| ImageURL |
Image url of the Product |
Yes |
| ProductTaxCode |
HSN Code of the Product |
Yes |
| Size |
Size of the Product(Ex:M,XXL) |
Yes |
| Color |
Color of the Product |
Yes |
| AccountingSKU |
Accounting Item Name of the Product |
Yes |
| AccountingUnit |
Accounting Item Unit of the Product(Ex:pieces,numbers) |
Yes |
| materialType |
Can be either 1(finished goods) or 2(raw goods) |
Yes |
| subProducts |
should contain an array of atleast 2 products |
No |
| sku |
sku of the sub product |
No |
| quantity |
quantity of the subproduct to be addedd |
No |
Sample Request Body:
{
"AccountingSKU": "",
"AccountingUnit": "",
"Brand": "BLUESTAR",
"Category": "Refrigerator",
"Color": "Black",
"Cost": "29152.72",
"Description": "BLUE STAR INVERTER Refrigerator 1.0 TON 3STAR 3CNHW12OATU (BI/BO)",
"EANUPC": "",
"Height": "",
"ImageURL": "",
"Length": "",
"ModelName": "BLUE STAR INVERTER Refrigerator 1.0 TON 3STAR 3CNHW12OATU (BI/BO)",
"ModelNumber": "BI/BO-3CNHW12OATU",
"Mrp": "44000.00",
"ProductTaxCode": "",
"Size": "",
"Sku": "Refrigerator-NonACSplit",
"TaxRuleName": "",
"Weight": "",
"Width": "",
"materialType": 1,
"subProduct": [
{
"sku": "misTik1",
"quantity": 1
},
{
"sku": "misTik2",
"quantity": 1
}
]
}
{
"code":200,
"message":"Product created Successfully!",
"data":{
"product_id":18110605
}
}
Notice: Optional parameter keys should be present in the json body but can be left blank.
Returns all the kit products.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| search |
option filter which searches the character in sku and product name |
Yes |
{
"code": 200,
"message": "Success",
"data": [
{
"productId": 17186303,
"sku": "NSR_Bundle",
"accountingSku": "NSR_Bundle",
"accountingUnit": null,
"mrp": 1198,
"add_date": "2019-02-26 11:32:55",
"lastUpdateDate": "2019-05-25 12:36:12",
"cost": 72,
"HSNCode": "34013090",
"colour": null,
"weight": null,
"height": null,
"length": null,
"width": null,
"size": "350",
"material_type": 1,
"modelNumber": "NSR_Bundle",
"modelName": "Natural Soothing Relief Bundle (Pack Of Each RW 200ml + RL 150ml)",
"category": "Skin Care_18",
"brand": "The Moms Co.",
"c_id": 8376,
"maxQty":9041,
"subProducts": [
{
"sku": "TMCSBRW101",
"productId": 17186300,
"qty": 1,
"description": "Natural Soothing Relief Wash 200ml",
"cost": 121,
"availableInventory": 9103
},
{
"sku": "TMCSBRL102",
"productId": 17186301,
"qty": 1,
"description": "Natural Soothing Relief Lotion 150ml",
"cost": 61,
"availableInventory": 9041
}
]
}
]
}
Creates listings in EasyEcom.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| marketplaceId |
Marketplace ID of the listings which you get from getMarketplaceList API |
No |
| sku |
sku of the product |
No |
| listingRefNum |
parameter which will be used to update the inventory |
No |
| guid |
parameter which will be used to update the inventory |
No |
| mrp |
mrp of the product |
No |
| sellingPrice |
sellingPrice of the product |
Yes |
| category |
category of the product |
Yes |
| title |
title of the product |
Yes |
| imageURL |
imageURL of the product |
Yes |
| brand |
brand of the product |
Yes |
| size |
size of the product |
Yes |
| weight |
weight of the product |
Yes |
| height |
height of the product |
Yes |
| length |
length of the product |
Yes |
| breadth |
breadth of the product |
Yes |
| color |
color of the product |
Yes |
| identifier |
identifier of the product |
No |
| productUniqueCode |
productUniqueCode of the product |
Yes |
| cost |
cost of the product |
Yes |
| taxRate |
taxRate of the product |
Yes |
{
"marketplaceId": "2",
"sku": "abcd123",
"listingRefNum": "FKabcd123",
"guid": "FKguid",
"mrp": 2915,
"sellingPrice": 2500,
"category": "Electronics",
"title": "Trimmer",
"imageURL": "",
"brand": "Phillips",
"size": "XL",
"weight": 200,
"height": 5,
"length":10,
"breadth":5,
"color":"black",
"identifier":"abcd123",
"productUniqueCode":"123ABCD",
"cost":2400,
"taxRate":0.18
}
{
"code":200,
"message":"Successfully inserted the listing",
}
Gets the custom fields created in EasyEcom.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| type |
can be either product or order level custom field |
No |
| type | value |
|-------------|------------|
|product | 5 |
|order | 1 |
|create order | 2 |
{
"status": 200,
"data": [
{
"id": 773,
"c_id": 9397,
"m_id": 115,
"field_type_id": 1,
"field_name": "Reorder_Reason",
"location": null,
"enabled": 1,
"visible": 1,
"data_type": 1,
"packing_station": 0
}
]
}
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| queueId |
queueId |
No |
{
"code": 200,
"message": "Successful",
"data": {
"id": "21161148",
"job_name": "11602_1600665221BulkOrderTemplate(92).csv",
"c_id": "11602",
"m_id": "",
"ccid": "",
"batch_id": "",
"job_type_id": "54",
"channel_id": "",
"start_time": "",
"end_time": "",
"status_id": "4",
"entry_time": "2020-09-21 10:43:43",
"process_time": "2020-09-21 10:43:46",
"message": "Error",
"upload_file": "",
"result": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/CreateBulkOrderSku/Download/error_report_11602_2020092110434624.csv",
"notes": "",
"attempts": "",
"submit_id": "",
"parent_job_id": ""
}
}
Returns a Json response which has the orders details.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| limit |
Used for pagination. Max 250 and Default is 50 |
No |
| nextUrl |
Used for pagination.When nextUrl is present in the response, use the exact url without any filters to get response of next page |
No |
| reference_code |
Optional Filter Order Number |
Yes |
| invoice_id |
Optional Filter invoice id of EasyEcom |
Yes |
| order_id |
Optional Filter order id of EasyEcom |
Yes |
| marketShipped |
Optional Filter marketShipped equals to 1 gives marketplace shipped orders/marketShipped equals to 0 gives self shipped orders |
Yes |
| order_type |
Optional Filter Order Type and it must be a valid value from the below order_type table |
Yes |
| status_id |
Optional Filter.Incase of multiple statuses, kindly pass in the comma separated values |
Yes |
| created_after |
Optional Filter should be in the format Y-m-d H:i:s(2020-09-10 13:15:59) |
Yes |
| updated_after/ updated_before |
Optional Filter should be in the format Y-m-d H:i:s(2020-09-10 13:15:59).Both should be used or none should be used. |
Yes |
| invoice_start_date/ invoice_end_date |
Optional Filter should be in the format Y-m-d H:i:s(2020-09-10 13:15:59).Both should be used or none should be used. |
Yes |
| start_date |
Optional Filter |
Yes |
| end_date |
Optional Filter |
Yes |
| marketplaceId |
Marketplace ID for which you need to get the data.Incase of multiple Marketplaxce Ids, kindly pass in the comma separated values . Reference - getMarketplaceList API |
Yes |
| include_custom_fields |
passing 1 will fetch the custom fields of the orders |
Yes |
| include_ee_history |
passing 1 will fetch the easyecom history of the orders |
Yes |
| qcPassed |
passing 1 will fetch QC passed orders/passing 0 will fetch QC failed orders |
Yes |
Order Status Ids
| Id | Status |
|-------|-----------------------------|
|1 | Pending |
|2 | Assigned |
|3 | Confirmed |
|4 | Out of stock |
|5 | Printed |
|6 | Ready to dispatch |
|7 | Shipped |
|9 | Cancelled |
|10 | Returned |
|11 | Upcoming |
| order_type | value |
|----------------|-----------|
|Sale Order | 1 |
|STN | 2 |
|Production Order| 3 |
| Current Shipment Status | current_shipment_status_id |
|------------------------------------------------------------------------------------------------|---------------------------------|
|Pickup Scheduled/Generated | 18 |
|Out For Pickup | 19 |
|Picked Up | 21 |
|Shipped/In Transit/Delayed/Reached at Destination/Misrouted/Picked Up | 2 |
|Out For Delivery | 20 |
|Undelivered | 16 |
|Delivered | 3 |
|Shipment Lost | 22 |
|Shipment OnHold | 23 |
|Reverse Pickup Scheduled | 26 |
|Reverse Picked Up | 7 |
|RTO In-Transit | 24 |
|RTO Undelivered | 25 |
|Shipment OnHold | 23 |
|RTO Initiated | 17 |
|RTO Delivered | 9 |
|Shipment Lost | 22 |
{
"code": 200,
"message": "Successful",
"data": {
"orders": [
{
"invoice_id": 731800,
"order_id": 509988,
"queue_message": null,
"queue_status": 3,
"order_priority": 0,
"blockSplit": 0,
"reference_code": "17013",
"company_name": "Demop",
"warehouseId": 26564,
"seller_gst": "27AACCH5367G1ZH",
"import_warehouse_id": 26564,
"import_warehouse_name": "Demp",
"pickup_address": "B 7/2, Near Camlin Naka, Tarapur, Boisar, Dist- Palghar",
"pickup_city": "Tarapur",
"pickup_state": "Maharashtra",
"pickup_pin_code": "401506",
"pickup_country": "India",
"order_type": "B2C",
"order_type_key": "retailorder",
"replacement_order": 0,
"marketplace": "Woocommerce",
"marketplace_id": 38,
"qcPassed": 1,
"salesmanUserId": 0,
"order_date": "2021-11-30 16:12:43",
"tat": "2021-12-02 14:40:00",
"invoice_date": "2021-12-02 00:00:00",
"import_date": "2021-12-01 14:40:01",
"last_update_date": "2021-12-02 13:08:04",
"manifest_date": null,
"manifest_no": null,
"invoice_number": "M1-2122-60",
"marketplace_invoice_num": null,
"shipping_last_update_date": "2021-12-02 12:52:54",
"batch_id": null,
"message": null,
"courier": "sandyecom@gmail.com",
"carrier_id": 14365,
"awb_number": "73122776",
"Package Weight": 500,
"Package Height": 10,
"Package Length": 10,
"Package Width": 5,
"order_status": "Printed",
"order_status_id": 5,
"easyecom_order_history": [
{
"status": "Assigned",
"dateTime": "2021-01-01 00:03:14",
"status_id": "2"
},
{
"status": "Confirm start",
"dateTime": "2021-01-01 00:21:09",
"status_id": "13"
},
{
"status": "Confirm Success",
"dateTime": "2021-01-01 00:21:09",
"status_id": "16"
},
{
"status": "Confirm new",
"dateTime": "2021-01-02 09:37:42",
"status_id": "17"
},
{
"status": "Confirmed",
"dateTime": "2021-01-02 09:37:42",
"status_id": "3"
},
{
"status": "Printed",
"dateTime": "2021-01-02 10:07:19",
"status_id": "5"
}
],
"shipping_status": "Shipment Created",
"shipping_status_id": 1,
"shipping_history": [
{
"status": "RT-RTO (SHIPPER REQUEST)",
"time": "2021-01-15 12:29",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-UNDELIVERED SHIPMENT HELD AT LOCATION",
"time": "2021-01-15 11:23",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-UNDELIVERED SHIPMENT HELD AT LOCATION",
"time": "2021-01-13 11:46",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-UNDELIVERED SHIPMENT HELD AT LOCATION",
"time": "2021-01-12 08:33",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-UNDELIVERED SHIPMENT HELD AT LOCATION",
"time": "2021-01-11 08:53",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-CONSIGNEE REFUSED TO ACCEPT",
"time": "2021-01-10 09:37",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-REFUSAL CONFIRMATION CODE VERIFIED",
"time": "2021-01-10 09:36",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-SHIPMENT OUTSCAN",
"time": "2021-01-10 08:29",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-COLLECTABLE AMOUNT NOT READY",
"time": "2021-01-09 18:28",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-COLLECTABLE AMOUNT NOT READY",
"time": "2021-01-09 08:16",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-SHIPMENT OUTSCAN",
"time": "2021-01-09 08:07",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-COLLECTABLE AMOUNT NOT READY",
"time": "2021-01-08 12:43",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-SHIPMENT OUTSCAN",
"time": "2021-01-08 08:19",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-COLLECTABLE AMOUNT NOT READY",
"time": "2021-01-07 11:20",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-SHIPMENT OUTSCAN",
"time": "2021-01-07 08:03",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-COLLECTABLE AMOUNT NOT READY",
"time": "2021-01-06 08:44",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-SHIPMENT OUTSCAN",
"time": "2021-01-06 07:58",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-SHIPMENT INSCAN",
"time": "2021-01-06 06:58",
"location": "PATAMATA SERVICE CENTRE"
},
{
"status": "UD-SHIPMENT OUTSCANNED TO NETWORK",
"time": "2021-01-06 03:39",
"location": "VIJAYAWADA HUB"
},
{
"status": "UD-DIRECT CANVAS BAG SCANNED",
"time": "2021-01-06 00:28",
"location": "VIJAYAWADA HUB"
},
{
"status": "UD-SHIPMENT OUTSCANNED TO NETWORK",
"time": "2021-01-05 14:58",
"location": "HYDERABAD HUB"
},
{
"status": "UD-DIRECT CANVAS BAG SCANNED",
"time": "2021-01-05 08:28",
"location": "HYDERABAD HUB"
},
{
"status": "UD-SHIPMENT OUTSCANNED TO NETWORK",
"time": "2021-01-05 02:44",
"location": "AHMEDABAD HUB"
},
{
"status": "UD-DIRECT CANVAS BAG SCANNED",
"time": "2021-01-03 19:17",
"location": "AHMEDABAD HUB"
},
{
"status": "UD-SHIPMENT OUTSCANNED TO NETWORK",
"time": "2021-01-03 14:17",
"location": "BAREJA EPU"
},
{
"status": "UD-SHIPMENT INSCAN",
"time": "2021-01-03 12:19",
"location": "BAREJA EPU"
},
{
"status": "UD-PICK UP SCAN ON FIELD",
"time": "2021-01-02 16:56",
"location": "BAREJA EPU"
}
],
"payment_mode": "COD",
"payment_mode_id": 2,
"payment_gateway_transaction_number": null,
"buyer_gst": "NA",
"customer_name": "test",
"contact_num": "8097292690",
"address_line_1": "test",
"address_line_2": "test.",
"city": "MANDSAUR",
"pin_code": "574001",
"state": "Karnataka",
"country": "IN",
"email": "soorrna@rpsg.in",
"billing_name": "test",
"billing_address_1": "test",
"billing_address_2": "test.",
"billing_city": null,
"billing_state": "MP",
"billing_pin_code": "574001",
"billing_country": "IN",
"billing_mobile": "80972690",
"order_quantity": 1,
"documents": {
"easyecom_invoice": "https://s3-us-west-2.amazonaws.com/ee-uploaded-files-oregon/Invoice/38/73155.pdf?request-content-type=application/force-download",
"label": "https://s3-us-west-2.amazonaws.com/ee-uploaded-files-oregon/Labels/38/73155.pdf?request-content-type=application/force-download",
"intaxform": null,
"outtaxform": null,
"marketplaceinvoice": null,
"marketplace_tax_invoice": null
},
"total_amount": 373,
"total_tax": 0,
"total_shipping_charge": 49,
"total_discount": 0,
"collectable_amount": 373,
"tcs_rate": 0,
"tcs_amount": 0,
"suborders": [
{
"suborder_id": 84806901,
"suborder_num": "1108725",
"item_status": "Printed",
"shipment_type": "SelfShip",
"suborder_quantity": 1,
"item_quantity": 1,
"returned_quantity": 0,
"cancelled_quantity": 0,
"shipped_quantity": 1,
"tax_type": "GST",
"suborder_history": {
"qc_pass_datetime": "2021-12-01 14:40:00",
"confirm_datetime": "2021-12-02 12:52:49",
"print_datetime": "2021-12-02 13:08:10",
"manifest_datetime": null
},
"selling_price": "373",
"total_shipping_charge": null,
"total_miscellaneous": null,
"tax_rate": 0,
"tax": 0,
"product_id": 168835,
"company_product_id": 570329,
"sku": "drv265",
"sku_type": "Normal",
"sub_product_count": 1,
"marketplace_sku": "drv265",
"productName": "Goodness of Chyawanprash",
"description": null,
"category": "Uncategorized",
"brand": "Unknown",
"model_no": "",
"product_tax_code": null,
"ean": null,
"size": null,
"cost": null,
"mrp": 360,
"weight": null,
"length": null,
"width": null,
"height": null,
"scheme_applied": 0
}
]
}
],
"nextUrl": null
}
}
Creates a Account in EasyEcom.
| Parameters |
Description |
Optional |
| phone |
Contact Number of the Company |
No |
| company_name |
Company Name |
No |
| email |
Email ID of the company |
No |
| client_id |
Unique ID provided by EasyEcom |
No |
| branding_user_id |
Should be a Unique Id for each account in EasyEcom |
No |
| password |
Random string(or an actual password) |
No |
| shipping_address |
Shipping Address of the Company |
No |
| billing_address |
Billing Address of the Company |
No |
| state_code |
2 Character State Code |
No |
| pin_code |
Zip Code |
No |
| address_line_1 |
Address line 1 |
No |
| address_line_2 |
Address line 2 |
Yes |
| country |
Country |
No |
| companyLevelTaxRate |
Only for Indian Clients. values can be 0,3,5,12,18,28 |
Yes |
| confirm_without_inventory |
if not sent, will be set to 0 by default. Can be either 1 or 0 |
Yes |
state_code link - https://docs.google.com/spreadsheets/u/1/d/e/2PACX-1vTxztVKy9fB1lq2ZGj681r8-emdwzywcZVsziRjSFTBGVNTNtKPLHRPgdCVcjmWR8WxuJ9Bv6jhw0-A/pubhtml
Sample Request Body:
{
"phone": 9999999999,
"company_name": "Test company",
"email": "dsfasdf@asdasd.com",
"client_id": "",
"branding_user_id":"ec1234"
"password": "random_string",
"companyLevelTaxRate":5,
"confirm_without_inventory":1,
"shipping_address": {
"address_line_1": "address_line_1",
"address_line_2": "address_line_2",
"state_code": "UP",
"pin_code": "123456",
"country": "India"
},
"billing_address": {
"address_line_1": "address_line_1",
"address_line_2": "address_line_2",
"state_code": "UP",
"pin_code": "123456",
"country": "India"
}
}
{
"code": 200,
"message": "Account created",
"data": {
"token": "en225420196",
"companyId":"20133"
}
}
Creates a Location under the account the api_token is linked with in EasyEcom.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token of the Company under which you want to create the location |
No |
| phone |
Contact Number of the Location |
No |
| company_name |
Company Name |
No |
| email |
Email ID of the company |
No |
| client_id |
Unique ID provided by EasyEcom |
No |
| branding_user_id |
Should be a Unique Id for each account in EasyEcom |
No |
| password |
Random string(or an actual password) |
No |
| shipping_address |
Shipping Address of the Company |
No |
| billing_address |
Billing Address of the Company |
No |
| state_code |
2 Character State Code |
No |
| pin_code |
Zip Code |
No |
| address_line_1 |
Address line 1 |
No |
| address_line_2 |
Address line 2 |
Yes |
| country |
Country |
No |
| companyLevelTaxRate |
Only for Indian Clients. values can be 0,3,5,12,18,28 |
Yes |
| copyMaster |
Passing 1 will copy products and vendors from the account api_token is linked with else 0 |
Yes |
| manageInventory |
Passing 1 will allow you to manage inventory from the account api_token is linked with else 0 |
Yes |
| confirm_without_inventory |
if not sent, will be set to 0 by default. Can be either 1 or 0 |
Yes |
state_code link - https://docs.google.com/spreadsheets/u/1/d/e/2PACX-1vTxztVKy9fB1lq2ZGj681r8-emdwzywcZVsziRjSFTBGVNTNtKPLHRPgdCVcjmWR8WxuJ9Bv6jhw0-A/pubhtml
Sample Request Body:
{
"phone": 9999999999,
"company_name": "Test company",
"email": "dsfasdf@asdasd.com",
"client_id": "",
"branding_user_id":"ec1234"
"password": "random_string",
"companyLevelTaxRate":5,
"confirm_without_inventory":1,
"copyMaster":1,
"manageInventory":1,
"confirm_without_inventory":1,
"shipping_address": {
"address_line_1": "address_line_1",
"address_line_2": "address_line_2",
"state_code": "UP",
"pin_code": "123456",
"country": "India"
},
"billing_address": {
"address_line_1": "address_line_1",
"address_line_2": "address_line_2",
"state_code": "UP",
"pin_code": "123456",
"country": "India"
}
}
{
"code": 200,
"message": "Successfully Added Location",
"data": {
"token": "en225420196",
"companyId":"20443"
}
}
Adds a marketplace/storefront to an Account.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token of the Company |
No |
| username |
username for seller panel |
Yes |
| password |
Password for seller panel |
Yes |
| m_id |
marketplace id which will be available by getMarketplaceList API |
No |
| seller_id |
refer the below link for description |
No |
| seller_user_id |
refer the below link for description |
No |
| app_id |
refer the below link for description |
No |
| ref_key |
refer the below link for description |
No |
| app_secret |
refer the below link for description |
No |
| cp_auto_create |
passing 1 will auto create the master product and maps with the listing automatically |
No |
addMPCredentials description link - https://docs.google.com/document/d/e/2PACX-1vSo9CCN0N2VAmgEJLAQEusfEYBnINryvtHhrppCSYeOd3dKeqLJHOmqQdUAuWTD47sKJCSjjmFoTroC/pub
Sample Request Body:
{
"m_id": 2,
"seller_id": "asdfghj",
"seller_user_id": ,
"app_id": "876543sdfghjk",
"ref_key": ,
"app_secret": "123456",
"cp_auto_create": 1
}
{
"code": 200,
"message": "Credentials for Marketplace with m_id 2 added successfully",
"data": {}
}
Adds a Carrier to an Account.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token of the Company |
No |
| carrier_id |
Unique Id that will be provided by EasyEcom |
No |
| username |
no need for Pickrr/ShipRocket api user's username for ShipRocket |
No |
| password |
no need for Pickrr/ShipRocket api user's password for ShipRocket |
No |
| token |
Pickrr api token for Pickrr/ShipRocket LocationId for ShipRocket |
No |
Sample Request Body:
{
"carrier_id":5859,
"username":"dummy",
"password":"dummy",
"token":"asdfgh234567"
}
{
"code": 200,
"message": "Successfully added the Courier with carrier_id 5859",
"data": {
"webhookToken": "AQoTKkPseGRe_187_5859",
"trackingUpdateWebhookUrl": "https://webhook.easyecom.io/webhook/UpdateTrackingStatus?carrier_token=AQoTKkPseGRe_187_5859",
"companyCarrierId":288
}
}
End Point URL: /company/checkCompany?branding_user_id=&client_id
| Parameters |
Description |
Optional |
| branding_user_id |
branding_user_id |
No |
| client_id |
client_id |
No |
{
"code": 201,
"message": "Company Exists",
"data": {
"token": "ex161148",
"companyId": "20312",
}
}
{
"code": 200,
"message": "Company Doesn't Exists",
"data": {
}
}
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| invoiceId |
invocie id of EasyEcom |
No |
| courier |
Actual Courier Name |
No |
| awbNum |
AWB Number to be assigned |
No |
| shippingLabelUrl |
Shipping Label Url |
Yes |
| invoiceUrl |
invoiceUrl Url |
Yes |
| companyCarrierId |
company carrier id received in the response of addCarrierCredentials API |
No |
| origin_code |
Origin code for carrier credentials |
Yes |
| destination_code |
Destination code for carrier credentials |
Yes |
{
"invoiceId": "5673214",
"courier": "Bluedart",
"awbNum": "8764435435656",
"companyCarrierId":123,
"shippingLabelUrl":"https://s3-us-west-2.amazonaws.com/ee-uploaded-files-oregon/Labels/31/53768436.pdf",
"invoiceUrl":"https://s3-us-west-2.amazonaws.com/ee-uploaded-files-oregon/NewMarketplaceInvoice/8/62838396.pdf?request-content-type=application/force-download",
"origin_code":"65489",
"destination_code":"165489"
}
{
"code": 200,
"message": "Successfully Updated"
}
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| includeLocations |
passing 1 will give you the inventory details of all the locations related to api_token passed/passing 0 will give the details of only one location for which api_token is related |
No |
| sku |
optional filter. In case multiple SKUs, use comma separed values(max 20) |
Yes |
| limit |
By default it give 10 sku details (max 20) |
Yes |
| customers |
setting this to 1 will fetch the B2B Customers Inventory |
Yes |
{
"code": 200,
"message": "Successful",
"data": {
"inventoryData": [
{
"companyId": 106,
"companyName": "Management Pvt. Ltd. (",
"companyProductId": 345873,
"productId": 151813,
"availableInventory": "0",
"reservedInventory": "0",
"sku": "SC-BY-S",
"accountingSku": null,
"accountingUnit": null,
"mrp": 3989,
"creationDate": "2021-01-15 17:16:09",
"lastUpdateDate": "2021-04-13 15:28:05",
"cost": 0,
"skuTaxRate": 0.18,
"color": "grey",
"size": "48x24x4",
"weight": 7000,
"height": 30,
"length": 30,
"width": 90,
"sellingPriceThreshold": null,
"inventoryThreshold": null,
"category": "mattress",
"ImageUrl": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/product_images/SC_BY_S_106.jpg",
"brand": "SleepyCat",
"productName": "Mattress",
"modelNo": "SC-BY-S",
"productUniqueCode": "9404",
"description": "Mattress",
"is_combo": 0
}
],
"nextUrl": "/wms/V2/getInventoryDetails?cursor=qIPJJVMzig11l3gNp54bVwOo3q1C4DtIiH4n_mDHCm02o6FCbW7Vrd/JlAwUS/uWnm_nSnnFpN4B4vW9qM0oNvfpEUfZvP9lyWZMuiLt427Kq9xJI7lOLFxzhKUWaGGdnmHNpRm7Ng8JXztZc8aqzhON6Y6bBoE/5nxMnvyHsrrl9k1EtQTSKmDUBrXFNXeu"
}
}
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| id or email |
userId or UseremailId |
No |
{
"code": 200,
"message": "User retrieved Successfuly",
"data": [
{
"firstname": "test",
"lastname": "test",
"email": "demowow@abc.com",
"primary_contact": "9415249700",
"role_type_id": 37,
"role": "Aggregator Location Admin",
"employee_id": null,
"designation": null,
"territory": null
}
]
}
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| firstname |
firstName |
No |
| lastname |
lastName |
No |
| email |
User EmailId |
No |
| roleTypeId |
user roleTypeId |
No |
| password |
password |
No |
| secondaryEmail |
secondaryEmail |
Yes |
| contact |
user contact |
Yes |
| secondaryContact |
secondaryContact |
Yes |
| employeeId |
employeeId |
Yes |
| designation |
designation |
Yes |
| territory |
territory |
Yes |
Refer this document for RoleTypeId https://docs.google.com/spreadsheets/d/11_SoqdYwL7TrUIiFrATKZTMsMnTjV7ue931Tm4l_Ll0/edit?usp=sharing
{
"code": 200,
"message": "User Added Successfuly",
"data": {
"id": 22926,
"firstname": "test",
"lastname": "test",
"email": "afaf",
"role_type_id": "1"
}
}
| Parameters |
Description |
Optional |
| api_token |
Authentication Token of the primary location |
No |
{
"code": 200,
"message": "Successful",
"data": [
{
"company_id": 23196,
"location_name": "Primary",
"city": "Bensenville",
"state": "Illinois",
"country": "United States of America (USA)",
"zip": "60106-1510",
"copy_master_from_primary": 0,
"address": "811 E Grand Ave, Bensenville, IL 60106-3432",
"api_token": "76dfb52807678ee4c01f7542a04ea6973afb02",
"userId": 748,
"phone number": 8976490428,
"address_type": {
"pickup_address": {
"street": "811 E Grand Ave, Bensenville, IL 60106-3432",
"state": "Illinois",
"zipcode": "60106-1510",
"country": "United States of America (USA)"
},
"billing_address": {
"street": "811 E Grand Ave, Bensenville, IL 60106-3432",
"state": "Illinois",
"zipcode": "60106-1510",
"country": ""
},
"return_address": {
"street": "811 E Grand Ave, Bensenville, IL 60106-3432",
"state": "Illinois",
"zipcode": "60106-1510",
"country": "United States of America (USA)"
}
},
"stockHandle": 0,
},
{
"company_id": 23528,
"location_name": "Location1",
"city": "Bensenville",
"state": "Illinois",
"country": "United States of America (USA)",
"zip": "60106",
"copy_master_from_primary": 1,
"address": "811 E Grand Ave, Bensenville, IL 60106-3432",
"api_token": "76dfb52807678ee4c01f7542a04ea6973afb02",
"userId": 748,
"phone number": 7976490428,
"address_type": {
"pickup_address": {
"street": "811 E Grand Ave, Bensenville, IL 60106-3432",
"state": "Illinois",
"zipcode": "60106-1510",
"country": "United States of America (USA)"
},
"billing_address": {
"street": "811 E Grand Ave, Bensenville, IL 60106-3432",
"state": "Illinois",
"zipcode": "60106-1510",
"country": ""
},
"return_address": {
"street": "811 E Grand Ave, Bensenville, IL 60106-3432",
"state": "Illinois",
"zipcode": "60106-1510",
"country": "United States of America (USA)"
}
},
"stockHandle": 0,
},
{
"company_id": 23528,
"location_name": "Location2",
"city": "Bensenville",
"state": "Illinois",
"country": "United States of America (USA)",
"zip": "60106",
"copy_master_from_primary": 1,
"address": "811 E Grand Ave, Bensenville, IL 60106-3432",
"api_token": "76dfb52807678ee4c01f7542a04ea6973afb02",
"userId": 748,
"phone number": 5686490428,
"address_type": {
"pickup_address": {
"street": "811 E Grand Ave, Bensenville, IL 60106-3432",
"state": "Illinois",
"zipcode": "60106-1510",
"country": "United States of America (USA)"
},
"billing_address": {
"street": "811 E Grand Ave, Bensenville, IL 60106-3432",
"state": "Illinois",
"zipcode": "60106-1510",
"country": ""
},
"return_address": {
"street": "811 E Grand Ave, Bensenville, IL 60106-3432",
"state": "Illinois",
"zipcode": "60106-1510",
"country": "United States of America (USA)"
}
},
"stockHandle": 0,
}
]
}
| Parameters |
Description |
Optional |
| api_token |
Authentication Token of the primary location |
No |
{
"code": 200,
"countries": [
{
"id": 1,
"country": "India",
"default_currency_code": "INR",
"code_2": "IN",
"code_3": "IND"
},
{
"id": 2,
"country": "Pakistan",
"default_currency_code": "PKR",
"code_2": "PK",
"code_3": "PAK"
},
{
"id": 3,
"country": "United States of America (USA)",
"default_currency_code": "USD",
"code_2": "US",
"code_3": "USA"
},
{
"id": 4,
"country": "Afghanistan",
"default_currency_code": "AFN",
"code_2": "AF",
"code_3": "AFG"
},
{
"id": 5,
"country": "Aland Islands",
"default_currency_code": "EUR",
"code_2": "AX",
"code_3": "ALA"
},
{
"id": 6,
"country": "Albania",
"default_currency_code": "ALL",
"code_2": "AL",
"code_3": "ALB"
},
{
"id": 7,
"country": "Algeria",
"default_currency_code": "DZD",
"code_2": "DZ",
"code_3": "DZA"
},
{
"id": 8,
"country": "American Samoa",
"default_currency_code": "USD",
"code_2": "AS",
"code_3": "ASM"
},
{
"id": 9,
"country": "Andorra",
"default_currency_code": "EUR",
"code_2": "AD",
"code_3": "AND"
},
{
"id": 10,
"country": "Angola",
"default_currency_code": "AOA",
"code_2": "AO",
"code_3": "AGO"
}
]
}
| Parameters |
Description |
Optional |
| api_token |
Authentication Token of the primary location |
No |
| countryId |
Id of Country |
No |
{
"code": 200,
"states": [
{
"id": 211,
"name": "Azad Kashmir",
"is_union_territory": 0,
"zip_start_range": null,
"zip_end_range": null,
"postal_code": null,
"country_id": 2,
"Zone": null
},
{
"id": 212,
"name": "Balochistan",
"is_union_territory": 0,
"zip_start_range": null,
"zip_end_range": null,
"postal_code": null,
"country_id": 2,
"Zone": null
},
{
"id": 213,
"name": "Federally Administered Tribal ",
"is_union_territory": 0,
"zip_start_range": null,
"zip_end_range": null,
"postal_code": null,
"country_id": 2,
"Zone": null
},
{
"id": 214,
"name": "Gilgit-Baltistan",
"is_union_territory": 0,
"zip_start_range": null,
"zip_end_range": null,
"postal_code": null,
"country_id": 2,
"Zone": null
},
{
"id": 215,
"name": "Islamabad",
"is_union_territory": 0,
"zip_start_range": null,
"zip_end_range": null,
"postal_code": null,
"country_id": 2,
"Zone": null
},
{
"id": 216,
"name": "Khyber Pakhtunkhwa Province",
"is_union_territory": 0,
"zip_start_range": null,
"zip_end_range": null,
"postal_code": null,
"country_id": 2,
"Zone": null
},
{
"id": 217,
"name": "Punjab Province",
"is_union_territory": 0,
"zip_start_range": null,
"zip_end_range": null,
"postal_code": null,
"country_id": 2,
"Zone": null
},
{
"id": 218,
"name": "Sindh",
"is_union_territory": 0,
"zip_start_range": null,
"zip_end_range": null,
"postal_code": null,
"country_id": 2,
"Zone": null
}
]
}
Returns a Json response which has the orders details.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| item_wise |
when passed and equal to 1 returns itemwise data else returns order wise data |
No |
| limit |
Used for pagination. Max 250 and Default is 50 for orderwise data,Max 50 and default is 20 for item wise data |
No |
| nextUrl |
Used for pagination.When nextUrl is present in the response, use the exact url without any filters to get response of next page |
No |
| start_date |
Optional Filter |
Yes |
| end_date |
Optional Filter |
Yes |
{
"code": 200,
"message": "success",
"data": {
"orders": [
{
"order_id": 969391655,
"order_num": "922902073",
"order_date": "2020-12-22 05:30:00",
"customer_name": null,
"customer_type": "Retailer",
"customer_id": 99551,
"distributor_id": 99084,
"distributor_name": "ABC Pvt Ltd",
"order_item_id": "19084160864147916990758",
"sku": "BDOI011",
"category": "Oils18",
"company_product_id": 238395684,
"product_name": "Beard & Hair Growth Oil (50ml)",
"total_amount": 3374.99,
"discount": -1125.00,
"quantity": 6,
"employee_id": "99",
"employee_name": "Maish Kmar Vera",
"order_status": "Shipped",
"completed_time": "",
"city": "Haridwar",
"address": "Firoz Kanchi & Cosmetic, Haridwar",
"state": "Uttarakhand",
"super_stockist_id": 99184,
"super_stockist_name": "DRA BROERS",
"area_manager_id": "128",
"area_manager_name": "Himshu Kakr",
"regional_manager_id": "318",
"regional_manager_name": "Psun and",
"area_manager_territory": null,
"regional_manager_territory": null
}
],
"nextUrl": "/orders/getB2BOrderwiseData?cursor=NNuu0T357vetjyIL35Yi1BhWzgaKY7MT1pIzMzvOHpqw2159ePopgdyT6jG328C7g528RhfZKRrlc1476/tTI209MDZp6X3LR105udcgpOeVNkScCMZNXqYWxMt2MYpW/ztRiH5GVcn6j9jWRlUT_qo3NsxLFvr08_ObvVMHgevDM5iyGgIP5_5DeZt/DE4L"
}
}
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| start_date |
start_date |
No |
| end_date |
end_date |
No |
{
"code": 200,
"message": "Successful",
"data": [
{
"c_id": 170,
"job_type_id": 72,
"entry_date": "2021-01-11 22:54:11",
"file_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/InventorySnapshotMonthlyReport/InventorySnapshotHistory_170_20210111225422.csv?request-content-type=application/force-download"
},
{
"c_id": 170,
"job_type_id": 72,
"entry_date": "2021-01-13 22:53:01",
"file_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/InventorySnapshotMonthlyReport/InventorySnapshotHistory_170_20210113225308.csv?request-content-type=application/force-download"
},
{
"c_id": 170,
"job_type_id": 72,
"entry_date": "2021-01-14 22:54:10",
"file_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/InventorySnapshotMonthlyReport/InventorySnapshotHistory_170_20210114225418.csv?request-content-type=application/force-download"
},
{
"c_id": 170,
"job_type_id": 72,
"entry_date": "2021-01-15 22:55:12",
"file_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/InventorySnapshotMonthlyReport/InventorySnapshotHistory_170_20210115225520.csv?request-content-type=application/force-download"
},
{
"c_id": 170,
"job_type_id": 72,
"entry_date": "2021-01-16 22:54:16",
"file_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/InventorySnapshotMonthlyReport/InventorySnapshotHistory_170_20210116225423.csv?request-content-type=application/force-download"
},
{
"c_id": 170,
"job_type_id": 72,
"entry_date": "2021-01-17 22:55:06",
"file_url": "https://s3.ap-south-1.amazonaws.com/ee-uploaded-files/InventorySnapshotMonthlyReport/InventorySnapshotHistory_170_20210117225513.csv?request-content-type=application/force-download"
}
]
}
Updates Shipping and Billing Name,Address and Mobile No in Assigned and Pending Orders.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| order_id |
Order Id |
No |
| shipping_name |
Customer name |
Yes |
| shipping_address_line_1 |
Shipping Address Line 1 |
Yes |
| shipping_address_line_2 |
Shipping Address Line 2 |
Yes |
| shipping_city |
Shipping City |
Yes |
| shipping_state_id |
Id of Shipping State(Find above in getStates Api) |
Yes |
| shipping_pin_code |
Shipping pin code |
Yes |
| shipping_country |
Shipping country name |
Yes |
| shipping_mobile |
Mobile no |
Yes |
| billing_name |
Customer name |
Yes |
| billing_address_line_1 |
billing Address Line 1 |
Yes |
| billing_address_line_2 |
billing Address Line 2 |
Yes |
| billing_city |
billing City |
Yes |
| billing_state_id |
Id of billing State(Find above in getStates Api) |
Yes |
| billing_pin_code |
billping pin code |
Yes |
| billing_country |
billing country name |
Yes |
| billing_mobile |
Mobile no |
Yes |
{
"order_id":"123456",
"shipping_name":"XYZ",
"shipping_address_line_1":"C-404/4",
"shipping_address_line_2":"Navi Mumbai",
"shipping_city":"Mumbai",
"shipping_state_id":"15",
"shipping_country":"India",
"billing_name":"XYZ",
"billing_address_line_1":"C-404/4",
"billing_address_line_2":"Navi Mumbai",
"billing_city":"Mumbai",
"billing_state_id":"15",
"billing_country":"India",
"billing_pin_code":"110022",
"billing_mobile":"2334441122"
}
{
"status": 200,
"message": "Updation Successful"
}
An Asynchronous API which updates inventory for the mentioned SKUs. Maximun allowed limit per call is 500 SKUs.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| sku |
SKU of the product |
No |
| quantity |
Inventory Quantity that needs to be updated(should be less than 5000) |
No |
{
"skus": [
{
"sku": "Nokia 9",
"quantity": 1000
},
{
"sku": "Sam02",
"quantity": 1000
}
]
}
{"code":200,"message":"Successfully Queued","data":{"queueId":26984368}}
Fetch the inventory along with serials if available.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| sku |
SKU of the product |
No |
| status |
Inventory Status(1 for available inventory) |
No |
{
"code": 200,
"message": "Successful",
"data": {
"cpId": 20849463,
"warehouseId": 181,
"productId": 13523869,
"sku": "8904130841118",
"mrp": 1399,
"weight": 500,
"height": 13,
"length": 14,
"width": 14,
"modelNo": "8904130841118",
"description": "Boat Stone 260, Charcoal Black, 1000MAH",
"name": "Boat Stone 260, Charcoal Black, 1000MAH",
"count": 10,
"serials": [
"TD1186182",
"TD1186185",
"TD1186187",
"TD1186188",
"TD1186190",
"TD1186194",
"TD1186196",
"TD1186203",
"TD1186204",
"TD1186198"
],
"billDetailsId": []
}
}
Fetch the inventory along with serials if available.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| reference_code |
Reference Code of the order |
No |
| itemDetails |
details of products distributed by batch and expiry |
Yes |
{
"code": 200,
"message": "Successful",
"data": [
{
"invoice_id": 74366596,
"order_id": 52120616,
"blockSplit": 0,
"reference_code": "BV12",
"company_name": "BTRS",
"warehouse_id": 40834,
"seller_gst": "1232434646",
"assigned_company_name": "BTRS",
"assigned_warehouse_id": 40834,
"assigned_company_gst": "1232434646",
"warehouse_contact": null,
"pickup_address": "C/O- CO WORK CAFE, 2ND FLOOR, 28 BLOOMINGDALE LAYOUT, KAIKONDRAHALLI csacasc",
"pickup_city": "Bangalore",
"pickup_state": "Karnataka",
"pickup_pin_code": "560035",
"pickup_country": "India",
"order_type": "B2C",
"order_type_key": "retailorder",
"replacement_order": 0,
"marketplace": "Offline",
"marketplace_id": 10,
"market_shipped": 0,
"merchant_c_id": 123,
"qcPassed": 1,
"salesmanUserId": 0,
"order_date": "2021-12-18 05:30:00",
"tat": "2021-12-19 11:22:44",
"invoice_date": "",
"import_date": "2021-12-18 11:24:11",
"last_update_date": "2021-12-18 11:22:44",
"manifest_date": null,
"manifest_no": null,
"invoice_number": null,
"marketplace_invoice_num": "BV12",
"shipping_last_update_date": null,
"batch_id": null,
"message": null,
"courier": "SelfShip",
"carrier_id": 23,
"awb_number": null,
"Package Weight": 100,
"Package Height": 1,
"Package Length": 1,
"Package Width": 1,
"order_status": "Open",
"easyecom_order_history": null,
"shipping_status": null,
"shipping_status_id": null,
"tracking_url": null,
"shipping_history": null,
"payment_mode": "Online",
"payment_mode_id": 1,
"payment_gateway_transaction_number": null,
"buyer_gst": "NA",
"customer_name": "Abc",
"contact_num": "1234566678",
"address_line_1": "Abc",
"address_line_2": null,
"city": "Mumbai",
"pin_code": "400056",
"state": "Maharashtra",
"country": "India",
"email": "abc@gmail.com",
"billing_name": "Abc",
"billing_address_1": "Abc",
"billing_address_2": null,
"billing_city": "Mumbai",
"billing_state": "Maharashtra",
"billing_pin_code": "400056",
"billing_country": "India",
"billing_mobile": "1234566678",
"order_quantity": 1,
"documents": null,
"collectable_amount": 0,
"total_amount": 210,
"total_tax": 10.0001,
"breakup_types": {
"Item Amount Excluding Tax": 190.4761,
"Shipping Excluding Tax": 19.0476,
"Promotion Discount Excluding Tax": -9.5238,
"Item Amount IGST": 9.5238,
"Shipping IGST": 0.9524,
"Promotion Discount IGST": -0.4761
},
"tcs_rate": 0,
"tcs_amount": 0,
"order_items": [
{
"suborder_id": 86248144,
"suborder_num": "40834163980676449905414",
"invoicecode": null,
"shipment_type": "SelfShip",
"suborder_quantity": 1,
"item_quantity": 3,
"returned_quantity": 0,
"cancelled_quantity": 0,
"shipped_quantity": 3,
"tax_type": "GST",
"product_id": 16909785,
"company_product_id": 58292824,
"sku": "FGCOMBO",
"expiry_type": 0,
"components_data": [
{
"parent_sku": "FGCOMBO",
"component_sku": "FG00001",
"no_of_items": 1,
"component_cp_id": 45766053,
"component_product_id": 15903034,
"parent_cp_id": 58292824,
"component_ean": null,
"component_mrp": 45,
"component_brand_id": 7125123,
"component_cost": 0,
"amount_breakups": {
"Item Amount Excluding Tax": 74.5341,
"Shipping Excluding Tax": 7.4534,
"Promotion Discount Excluding Tax": -3.7267,
"Item Amount IGST": 3.7267,
"Shipping IGST": 0.3727,
"Promotion Discount IGST": -0.1863
}
},
{
"parent_sku": "FGCOMBO",
"component_sku": "FG00132",
"no_of_items": 1,
"component_cp_id": 45768754,
"component_product_id": 15903364,
"parent_cp_id": 58292824,
"component_ean": "NA",
"component_mrp": 25,
"component_brand_id": 7094391,
"component_cost": 0,
"amount_breakups": {
"Item Amount Excluding Tax": 41.4079,
"Shipping Excluding Tax": 4.1408,
"Promotion Discount Excluding Tax": -2.0704,
"Item Amount IGST": 2.0704,
"Shipping IGST": 0.207,
"Promotion Discount IGST": -0.1035
}
},
{
"parent_sku": "FGCOMBO",
"component_sku": "FG00010",
"no_of_items": 1,
"component_cp_id": 46559676,
"component_product_id": 15975634,
"parent_cp_id": 58292824,
"component_ean": "NA",
"component_mrp": 45,
"component_brand_id": 7125351,
"component_cost": 0,
"amount_breakups": {
"Item Amount Excluding Tax": 74.5341,
"Shipping Excluding Tax": 7.4534,
"Promotion Discount Excluding Tax": -3.7267,
"Item Amount IGST": 3.7267,
"Shipping IGST": 0.3727,
"Promotion Discount IGST": -0.1863
}
},
{
"parent_sku": "FGCOMBO",
"component_sku": "FG00180",
"no_of_items": 1,
"component_cp_id": 49910789,
"component_product_id": 16078988,
"parent_cp_id": 58292824,
"component_ean": null,
"component_mrp": 0.01,
"component_brand_id": 7125351,
"component_cost": 0
},
{
"parent_sku": "FGCOMBO",
"component_sku": "FG00019",
"no_of_items": 1,
"component_cp_id": 57667046,
"component_product_id": 16835482,
"parent_cp_id": 58292824,
"component_ean": null,
"component_mrp": 0.01,
"component_brand_id": 7125351,
"component_cost": null
}
],
"sku_type": "Combo",
"sub_product_count": 2,
"marketplace_sku": "FGCOMBO",
"productName": "Dairy combo",
"description": null,
"category": "ASSORTED",
"brand": "Epigamia",
"brand_id": 7094391,
"model_no": "A123",
"product_tax_code": "1234",
"ean": "NA",
"size": "NA",
"cost": 150,
"mrp": 200,
"weight": 100,
"length": 1,
"width": 1,
"height": 1,
"scheme_applied": 0,
"custom_fields": [],
"serials": [
null,
null,
null
],
"tax_rate": 5,
"selling_price": "210",
"breakup_types": {
"Item Amount Excluding Tax": 190.4761,
"Shipping Excluding Tax": 19.0476,
"Promotion Discount Excluding Tax": -9.5238,
"Item Amount IGST": 9.5238,
"Shipping IGST": 0.9524,
"Promotion Discount IGST": -0.4761
}
}
]
}
]
}
Fetch the inventory along with serials if available.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| enable |
1 to Enable/0 to disable |
No |
{
"code": 200,
"message": "Successfully Disabled the account with c_id 29737",
"data": []
}
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| invoice_id |
EasyEcom invoice_id |
No |
| is_api |
should always be set to 1 |
No |
{
"code": 200,
"message": "",
"data": {
"documents": {
"easyecom_invoice": "https://s3-us-west-2.amazonaws.com/ee-uploaded-files-oregon/Invoice/23/606838.pdf?request-content-type=application/force-download",
"label": "https://s3-us-west-2.amazonaws.com/ee-uploaded-files-oregon/Labels/23/606932.pdf?request-content-type=application/force-download",
"intaxform": null,
"outtaxform": null,
"marketplaceinvoice": "https://s3-us-west-2.amazonaws.com/ee-uploaded-files-oregon/MarketplaceInvoice/23/60932.pdf?request-content-type=application/force-download",
"marketplace_tax_invoice": null
},
"awb_number": "1313157084",
"carrier": "DE",
"carrier_id": 8351,
"invoice_reference": null,
"message": null,
"queue_status": "Finished"
}
}
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| invoice_id |
EasyEcom invoice_id |
No |
{
"api_token":"fb49c98f8e5598f26e3fb3cc1440eebba55d34e71620f7cd31c8b2e24711c3bb",
"invoice_id":59738205
}
{"code":200,"message":"QC Passed for invoice id 59738205","data":[]}
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| carrier_id |
Easyecom carrier_id |
No |
| marketplace_id |
EasyEcom marketplace id |
No |
| awb_numbers |
Tracking Numbers |
No |
{
"api_token": "fb49c98f8e5598f26e3fb3cc1440eebba55d34e71620f7cd31c8b2e24711c3bb",
"carrier_id": "5089",
"marketplace_id": "12",
"awb_numbers": [
"125620362655"
]
}
{"code":200,"message":"","data":["queue_id":3456743]}
Returns a Json response which has the orders details.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| limit |
Used for pagination. Max 250 and Default is 50 |
No |
| nextUrl |
Used for pagination.When nextUrl is present in the response, use the exact url without any filters to get response of next page |
No |
| reference_code |
Optional Filter Order Number |
Yes |
| invoice_id |
Optional Filter invoice id of EasyEcom |
Yes |
| order_id |
Optional Filter order id of EasyEcom |
Yes |
| created_after |
Optional Filter should be in the format Y-m-d H:i:s(2020-09-10 13:15:59) |
Yes |
| credit_note_start_date |
Optional Filter |
Yes |
| credit_note_end_date |
Optional Filter |
Yes |
| marketplaceId |
Optional Filter Marketplace ID on EasyEcom |
Yes |
{
"code": 200,
"message": "Successful",
"data": {
"credit_notes": [
{
"credit_note_id": 7791123220,
"invoice_id": 5782432432914,
"order_id": 37112342347630,
"reference_code": "210102432421197",
"company_name": "ABC Pvt Ltd",
"warehouseId": 187,
"seller_gst": "24AAAC12323129M1ZH",
"forward_shipment_pickup_address": "Godown Revenue Survey/ Block No.27/A, sanatrol , sanale, Nr. S Ford woop, sanathal, Ta:Sanand,",
"forward_shipment_pickup_city": "Ahmedabad",
"forward_shipment_pickup_state": "Gujarat",
"forward_shipment_pickup_pin_code": "382210",
"forward_shipment_pickup_country": "India",
"order_type": "B2C",
"order_type_key": "retailorder",
"replacement_order": 0,
"marketplace": "Offline",
"marketplace_id": 10,
"salesmanUserId": 0,
"order_date": "2021-01-17 16:00:25",
"invoice_date": "2021-01-18 00:00:00",
"import_date": "2021-01-17 16:01:04",
"last_update_date": "2021-04-15 15:18:06",
"manifest_date": "2021-01-18 16:44:22",
"credit_note_date": "2021-04-15 00:00:00",
"manifest_no": "202101044504",
"invoice_number": "HOW6/2021/2356",
"credit_note_number": "RGJ3-2122-6",
"marketplace_invoice_num": "210102432421197",
"batch_id": 864543663,
"payment_mode": "COD",
"payment_mode_id": 2,
"buyer_gst": "NA",
"forward_shipment_customer_name": "SAMAS",
"forward_shipment_customer_contact_num": "7001245736",
"forward_shipment_customer_address_line_1": "SUJATMENT MAHATABPUR",
"forward_shipment_customer_address_line_2": "NEAR PADMABATI SWASAN",
"forward_shipment_customer_city": "Midnapore",
"forward_shipment_customer_pin_code": "721101",
"forward_shipment_customer_state": "West Bengal",
"forward_shipment_customer_country": "India",
"forward_shipment_customer_email": null,
"forward_shipment_billing_name": "SAMAS",
"forward_shipment_billing_address_1": "SUJATMENT MAHATABPUR",
"forward_shipment_billing_address_2": "NEAR PADMABATI SWASAN",
"forward_shipment_billing_city": "Midnapore",
"forward_shipment_billing_state": "West Bengal",
"forward_shipment_billing_pin_code": "721101",
"forward_shipment_billing_country": "India",
"forward_shipment_billing_mobile": "7001245736",
"order_quantity": 1,
"total_invoice_amount": 1035,
"total_invoice_tax": 157.881,
"invoice_collectable_amount": 1035,
"items": [
{
"company_product_id": 23382452,
"product_id": 14128929,
"suborder_id": 63041606,
"suborder_num": "6253208_10493093",
"return_reason": "Other",
"inventory_status": "QC Pass",
"shipment_type": "SelfShip",
"suborder_quantity": 1,
"returned_item_quantity": 1,
"tax_type": "GST",
"total_item_selling_price": null,
"credit_note_total_item_shipping_charge": null,
"credit_note_total_item_miscellaneous": 20,
"item_tax_rate": 18,
"credit_note_total_item_tax": 40.4237,
"credit_note_total_item_excluding_tax": 224.5763,
"sku": "B002",
"sku_type": "Normal",
"sub_product_count": 1,
"productName": "Mustache Growth on (8ml)",
"description": "Oils",
"category": "Oils18",
"brand": "EAD",
"model_no": "B002",
"product_tax_code": "33059019",
"ean": "89064790337",
"size": "8",
"cost": 0,
"mrp": 245,
"weight": 36,
"length": 15.5,
"width": 15,
"height": 5
}
]
}
],
"nextUrl": null
}
}
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| updated_after,updated_before |
optional filter(Need to use both updated_after and updated_before when using this filter).Format yyyy-mm-dd h:i:s |
Yes |
| order_start_date,order_end_date |
optional filter(Need to use both order_start_date and order_end_date when using this filter).Format yyyy-mm-dd h:i:s |
Yes |
| invoice_start_date,invoice_end_date |
optional filter(Need to use both invoice_start_date and invoice_end_date when using this filter).Format yyyy-mm-dd h:i:s |
Yes |
{"code":200,"message":"Successful","data":{"totalCount":876}}
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| order_id/ invoice_id |
Order Id/Invoice Id of EasyEcom |
No |
| items |
Items |
No |
| return_reason |
Return Reason |
Yes |
| images |
Image |
Yes |
| return_date |
Return Date |
Yes |
Note: Anyone of the order_id and invoice_id must be passed
{
"invoice_id":59738205,
"return_date": "2021-06-24",
"items":[
{
"sku":"abc",
"quantity":10,
"qc_pass":1,
"inventory_status":13
},
{
"sku":"abc2",
"quantity":1,
"qc_pass":1,
"inventory_status":13
},
{
"sku":"abc3",
"quantity":11,
"qc_pass":1,
"inventory_status":13
}
]
}
| Id | Status |
|-------|-----------------------------|
|1 | Available |
|2 | Repair |
|3 | Lost |
|4 | Damaged |
|5 | Gifted |
|6 | Reserved |
|7 | Sold |
|10 | Returned to Source |
|11 | Return Available |
|12 | QC Pending |
|13 | QC Pass |
|14 | QC Fail |
|15 | Transfer |
|16 | Discard |
{
"status": 200,
"data": [
{
"sku": "abc",
"quantity": "10",
"qc_pass": "1",
"inventory_status": "13",
"message": "success",
"status": 200
},
{
"sku": "abc2",
"quantity": "1",
"qc_pass": "1",
"inventory_status": "13",
"message": "success",
"status": 200
},
{
"sku": "abc3",
"quantity": "11",
"qc_pass": "1",
"inventory_status": "13",
"message": "Success",
"status": 200
}
]
}
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| invoice_id |
Invoice Id |
No |
{
"invoice_id":59738205,
"api_token": "ae13xxxx"
}
{
"status": 200,
"message": "Successfully Unassigned the Courier"
}
Returns a Json response which has the orders details.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token |
No |
| limit |
Used for pagination. Max 250 and Default is 50 |
No |
| nextUrl |
Used for pagination.When nextUrl is present in the response, use the exact url without any filters to get response of next page |
No |
| reference_code |
Optional Filter Order Number |
Yes |
| invoice_id |
Optional Filter invoice id of EasyEcom |
Yes |
| order_id |
Optional Filter order id of EasyEcom |
Yes |
| created_after |
Optional Filter should be in the format Y-m-d H:i:s(2020-09-10 13:15:59) |
Yes |
| marketplaceId |
Optional Filter marketplace ID on EasyEcom |
Yes |
{
"code": 200,
"message": "Successful",
"data": {
"pending_returns": [
{
"invoice_id": 626103,
"order_id": 41562,
"reference_code": "405-9163-34350",
"company_name": "ABC pVt ltd",
"warehouseId": 187,
"seller_gst": "19AAYCS4216XXXX",
"forward_shipment_pickup_address": "ABC pVt ltd, Warehouse 3, C/o.GKW, 97, Andul Road",
"forward_shipment_pickup_city": "Howrah",
"forward_shipment_pickup_state": "West Bengal",
"forward_shipment_pickup_pin_code": "711103",
"forward_shipment_pickup_country": "India",
"order_type": "B2C",
"order_type_key": "retailorder",
"replacement_order": 0,
"marketplace": "Amazon.in",
"marketplace_id": 8,
"salesmanUserId": 0,
"order_date": "2021-05-27 11:12:05",
"invoice_date": "2021-05-27 00:00:00",
"import_date": "2021-05-27 12:04:33",
"last_update_date": "2021-06-27 18:05:36",
"manifest_date": "2021-05-29 18:45:02",
"manifest_no": "19700529064617",
"invoice_number": "SC/ABC1/2022/2684",
"marketplace_invoice_num": null,
"batch_id": 123,
"payment_mode": "PrePaid",
"payment_mode_id": 5,
"buyer_gst": "NA",
"forward_shipment_customer_name": null,
"forward_shipment_customer_contact_num": null,
"forward_shipment_customer_address_line_1": null,
"forward_shipment_customer_address_line_2": null,
"forward_shipment_customer_city": "BENGALURU",
"forward_shipment_customer_pin_code": "560066",
"forward_shipment_customer_state": "Karnataka",
"forward_shipment_customer_country": "India",
"forward_shipment_customer_email": null,
"forward_shipment_billing_name": null,
"forward_shipment_billing_address_1": null,
"forward_shipment_billing_address_2": null,
"forward_shipment_billing_city": null,
"forward_shipment_billing_state": null,
"forward_shipment_billing_pin_code": null,
"forward_shipment_billing_country": null,
"forward_shipment_billing_mobile": null,
"order_quantity": 1,
"total_invoice_amount": 1790,
"total_invoice_tax": 245.015,
"invoice_collectable_amount": 0,
"items": [
{
"company_product_id": 4877,
"product_id": 8415,
"suborder_id": 6293,
"suborder_num": "568766507",
"return_awb_number": null,
"return_type": "Unknown",
"return_reason": "",
"pending_return_creation_date": "2021-06-30 02:15:10",
"marketplace_return_date": null,
"inventory_status": null,
"shipment_type": "SelfShip",
"suborder_quantity": 1,
"returned_item_quantity": 1,
"tax_type": "GST",
"total_item_selling_price": "1790",
"credit_note_total_item_shipping_charge": null,
"credit_note_total_item_miscellaneous": null,
"item_tax_rate": 18,
"credit_note_total_item_tax": 232.292,
"credit_note_total_item_excluding_tax": 1290.5093,
"sku": "BDPILW-S",
"productName": "Pillow",
"description": "Cuddle Pillow",
"category": "Pillow",
"brand": "Dummy",
"model_no": "BDPILW-S",
"product_tax_code": "0401",
"ean": "9404",
"size": "50x19",
"cost": 0,
"mrp": 1989,
"weight": 3000,
"length": 20,
"width": 44,
"height": 20,
"pending_return_total_item_shipping_charge": null,
"pending_return_total_item_miscellaneous": null,
"pending_return_total_item_tax": 12.7237,
"pending_return_total_item_excluding_tax": 254.4749
}
]
}
],
"nextUrl": null
}
}
End Point URL: /Maintenance/switchSyncStatus?api_token=xxxx
| Parameters |
Description |
Optional |
| api_token |
Authentication Token of the primary location |
No |
| m_id |
Id of Marketplace |
No |
| syncStatus |
1 to activate marketplace and 0 to deactivate |
No |
Update the tracking details of an AWB .
| Parameters |
Description |
Optional |
| api_token |
Authentication Token of the Company |
No |
| current_shipment_status_id |
current shipment status id. Refer below table for more info |
No |
| awb |
AWB number for which tracking details needs to be updated |
No |
| history_scans |
shipment history scans. Kindly follow the same structure given in the sample response |
Yes |
| estimated_delivery_date |
Estimated delivery date |
Yes |
| delivery_date |
delivered date |
Yes |
|
|
|
| Current Shipment Status |
current_shipment_status_id |
| Pickup Scheduled/Generated |
18 |
| Out For Pickup |
19 |
| Picked Up |
21 |
| Shipped/In Transit/Delayed/Reached at Destination/Misrouted/Picked Up |
2 |
| Out For Delivery |
20 |
| Undelivered |
16 |
| Delivered |
3 |
| Shipment Lost |
22 |
| Shipment OnHold |
23 |
| Reverse Pickup Scheduled |
26 |
| Reverse Picked Up |
7 |
| RTO In-Transit |
24 |
| RTO Undelivered |
25 |
| Shipment OnHold |
23 |
| RTO Initiated |
17 |
| RTO Delivered |
9 |
| Shipment Lost |
22 |
Sample Request Body:
{
"current_shipment_status_id": 3,
"awb": "SRTC0040326616",
"estimated_delivery_date": "2020-09-29",
"delivery_date": "2020-09-29 11:30:30",
"history_scans": [
{
"status": "Return to Origin Intransit RTO",
"time": "2020-09-20 15:34:00",
"location": "DEL/RTO, Delhi NCR, Delhi"
},
{
"status": "Return to Origin As per client (Pradeep) confirmation (Marked Shipment RTO & changed Destination HubID to 312)",
"time": "2020-07-24 08:01:00",
"location": "Pen, Pen, MAHARASHTRA"
}
]
}
{
"code": 200,
"message": "Successfully Updated the Tracking Details for AWB Number SRTC0040326616",
"data": {}
}
Function: Bulk Inventory Update With BatchCode And Expiry
End Point URL: /inventory/bulkInventoryUpdateWithBatchCodeAndExpiry?api_token=xxxx
Updates Inventory Of an sku with batch code and expiry.
| Parameters |
Description |
Optional |
| api_token |
Authentication Token of the Company |
No |
| sku |
sku of an product |
No |
| batchCode |
batch code |
No |
| expiryDate |
expiryDate |
Yes |
Sample Request Body:
{
"skus": [
{
"sku": "TulsiClassic-25Tb-Pk2",
"quantity": 5,
"batchCode":"test1",
"expiryDate":"2022-10-01"
},
{
"sku": "TulsiClassic-25Tb-Pk2",
"quantity": 10,
"batchCode":"test2",
"expiryDate":"2022-11-01"
},
{
"sku": "TulsiCleanse-25tbs-PK4",
"quantity": 5,
"batchCode":"test1",
"expiryDate":"2022-10-01"
},
{
"sku": "TulsiCleanse-25tbs-PK4",
"quantity": 10,
"batchCode":"test2",
"expiryDate":"2022-11-01"
}
]
}
{"code":200,"message":"Successfully Queued","data":{"queueId":43244239}}
