Skip to product menu
Skip to main content

Step 1: Upload Import File

HTTP Request

POST https://commerce.zoho.com/store/api/v1/import/uploadfile 

 

OAuthScope

ZohoCommerce.import.CREATE

 

Body Parameters

ParameterDescription
importfile*file: Give file that needs to be imported.
entity*string: Give entity type of the import. Only possible value is "itemgroup".
duplicate_handling*string: Give value that defines how to handle duplicate records. Only possible valuse is "overwrite".
charencoding*string: Give character encoding used in the file. Possible values are UTF-8, UTF-16.
delimiter* string: Give delimiter that used in the file. Possible values are "," and ";".

 

Sample Request

Copiedcurl -X POST \
https://commerce.zoho.com/store/api/v1/import/uploadfile \
-H 'Authorization: Zoho-oauthtoken ***' \
-H 'Cache-Control: no-cache' \
-H 'X-com-zoho-store-organizationid: 711022734' \
-H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
-F importfile=@.../sample_importfile.csv \
-F entity=itemgroup \
-F duplicate_handling=overwrite \
-F charencoding=UTF-8 \
-F 'delimiter=,'

Success Response

Copied{
"code": 0,
"message": "success",
"data": {
"csv_columns": [
"AttributeName1",
"AttributeName2",
"AttributeName3",
"AttributeOption1",
"AttributeOption2",
"AttributeOption3",
"AttributeOptionData1",
"AttributeOptionData2",
"AttributeOptionData3",
"AttributeType1",
"AttributeType2",
"AttributeType3",
"Avalara Tax Code",
"Brand",
"Category URL",
"EAN",
"Handle",
"ISBN",
"Item Type",
"Label Price",
"Long Description",
"On Sale",
"Opening Stock",
"Package Height",
"Package Length",
"Package Weight",
"Package Width",
"Part Number",
"Product Name",
"Qualifies For Returns ",
"Reorder Level",
"Selling Price",
"SEO Description",
"SEO Keyword",
"SEO Title",
"Show In Store",
"SKU",
"Store Description",
"Tags",
"UPC"
],
"accountid": "",
"is_async_import": false,
"entity_columns": [
{
"csv_column": "",
"entity_column": "Product ID",
"is_mandatory": false,
"entity_column_label": "Product ID",
"field_helptext": ""
},
{
"csv_column": "Product Name",
"entity_column": "Product Name",
"is_mandatory": true,
"entity_column_label": "Product Name",
"field_helptext": ""
},
{
"csv_column": "Store Description",
"entity_column": "Store Description",
"is_mandatory": false,
"entity_column_label": "Store Description",
"field_helptext": ""
},
{
"csv_column": "Long Description",
"entity_column": "Long Description",
"is_mandatory": false,
"entity_column_label": "Long Description",
"field_helptext": ""
},
{
"csv_column": "Brand",
"entity_column": "Brand",
"is_mandatory": false,
"entity_column_label": "Brand",
"field_helptext": ""
},
{
"csv_column": "On Sale",
"entity_column": "On Sale",
"is_mandatory": false,
"entity_column_label": "On Sale",
"field_helptext": ""
},
...
],
"import_id": "2212135000000182095"
}
}

Show full

Show less

This API is used to upload the import file and to get the mapping fields.