Zakeke uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.   

API Reference

CSV API

The CSV API allows you to imports into Zakeke DataBase, a list of customizable products (or models) by a CSV file.
For CSV product data specification go to how to importing CSV products.

Endpoint

POSThttps://api.zakeke.com/v2/csv/import

Authentication

CSV endpoint must be called in S2S (server to server) mode.
For further information see how to get a S2S OAuth token.

Input parameter

This method uploads a multipart ZIP archive file that contains CSV files and starts the related task.
So, it does not accept parameter and the Content-Type header must be setted to multipart/form-data.

Sample cURL request
curl -X POST https://api.zakeke.com/v2/csv/import \
     -H Accept: "application/json" \
     -H Authorization: "Bearer <Access-Token>" \
     -H Content-Type: "multipart/form-data" \
     -F data="&c:/user/data/CSV.zip"

Output

Json object with task result. LastError be empty if no errors will be occurred after creating task

{
  "TaskID": 0,
  "LastError": string
}

The properties are described below:

Property Data type Description
TaskID integer Task Identifier required for retrieving related results by importingresult endpoint. (Explained below)
LastError string Description of error occurred while creating task

HTTP Response codes

Code Description
200 CSV importing successfully completed. See response body if there are errors.
415 Unable to import CSV (e.g. ZIP archive is not valid)

Endpoint

GEThttps://api.zakeke.com/v2/csv/importingresult/{taskid}

Authentication

CSV endpoint must be called in S2S (server to server) mode.
For further information see how to get a S2S OAuth token.

Input parameter

This method get task results about CSV importing task.
So, it accept the taskid parameter, unique identifier of CSV Task.

Output

Json object with error importing CSV summary. Errors list will be empty if no errors will be occurred after importing

{
  "errorOccurred": true,
  "errors": [
    {
      "row": 0,
      "description": "string",
      "sourceFile": "string"
    }
    ,...,
    {
      "row": 0,
      "description": "string",
      "sourceFile": "string"
    }
  ]
}

The properties are described below:

Property Data type Description
errorOccurred boolean true if errors occurred otherwise false
row integer CSV row number where error occurred
description string Error description
sourceFile string Full name of CSV file with errors
Sample response
{
"errorOccurred": false,
"errors": []
}

HTTP Response codes

Code Description
200 CSV importing successfully completed. See response body if there are errors.
204 Task results is not available.
404 Unable to get CSV Task results: taskid was not found or is not valid.

API reference

For API technical reference go to https://api.zakeke.com/docs/index