REST API Store Import V1

This source is used to store data import in Quant. Input and output format is JSON.

Use Automatic Tasks view to create and set up the import. Once created, the task list will have the ID that you pass in the request URL.

Automatic Tasks - Store Data Import
  • Settings

Before using the API, you must edit the following attributes in the Settings tab:

  • Check the Enabled attribute to enable the task.
  • In the Users with API Access Permission, select one or more users with the Robot role who will have permission to run the task.
  • In the Store Data Attribute Mapping, select the attributes to import and optionally modify their JSON keys.
  • Attributes
Specifies whether the automated task is active and can send data through it.
Custom name of the automated task.
Custom description of the automatic task function.
formatted text
long text
Emails for Notifications

One or more email addresses to which emails with error conditions will be sent.

list of strings
Users with API Access Permission
Users with the Robot role who are authorized to run the task.
list of users
Delay in Seconds before Retrying
The number of seconds the client should wait before retrying the import in case of a long request queue on the server.

Store Data Attribute Mapping
A mapping containing an entry for each attribute to be imported.

complex type

Measure Unit
Measure unit such as cm, mm etc.
Date Format
Date entry format, eg 31.12.19
Date and Time Format
Date and time entry format, eg 19.12.31 23:59:59
List Item Separator
Character separating individual items for values of the list type

  • Request


?debug added to the URL will also display warnings in the response. Without it, only errors are listed.
Accept: application/json
Content-type: application/json

Authorization: Bearer  <TOKEN>

TOKEN se získává pomocí /authenticate (see Login).


The content of the request is an array of JSON objects containing the keys defined in the Store Data Attribute Mapping setting. 

  • Response
A string describing the final state of the import.
  • SUCCESS = error-free import process
  • PARTIAL_SUCCESS = import completed but generated one or more warnings
  • FAILURE = one or more errors occurred during the import
It is optional, ie. is included only if the ?debug parameter is in the URL and the import generated at least one warning.
List of warning strings.
Optional - included only if the import generated at least one error.
List of warning strings.
Total Lines
Optional - is included only if the import did not end with the status "FAILURE"
Number of records on input.
Empty IDs
Number of records with empty Store ID value.
Stores Duplicated
Optional - is included only if the import did not end with the status "FAILURE"
The number of records that were skipped because this store was already imported in a different request.
  • Status Codes
200 OK
Import successful with "SUCCESS" or "PARTIAL_SUCCESS" status. The response may contain warnings or minor errors.
400 Bad Request
Incorrect task settings or incorrect request.
401 Unauthorized
The authorization token is invalid, or the user who is logged on with the token does not have permission to run this task.
404 Not Found
No task was found with the ID specified in the URL.
500 Internal Server Error

A critical server-side error occurred during the import.

503 Service Unavailable

The task is already running. Retry launching the task after count of seconds given in response header Retry-After.

  • Execution Log

In Quant, in addition to task settings, you can also view records of individual imports, including statistics, errors, and warnings.

Execution Log

If we select a specific record, we can display its details by clicking on the Show Items button.

Show Items 

  • Request

curl -X POST --location "https://[YOUR_COMPANY]" \

    -H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \

    -H "Accept: application/json" \

    -H "Content-Type: application/json" \

    -H "Cache-Control: no-cache" \

-d '[{ "Store ID": "100001", "Store Name": "Test Store" }]'

  • Response


  "Status": "SUCCESS", 

  "Total Lines": 1,

  "Empty IDs": 0,

  "Stores Duplicated": 0