REST API Store Specific Product Data Export V1

Use this resource to export Quant product data that is specific to each store. It currently uses JSON as input and output.

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

Automatic taskTask ID

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 REST Exportable Product Store Attribute Mapping, select the attributes to export and optionally modify their JSON keys

Attribute	Description	Type
Enabled	Specifies whether the automated task is active and data can be sent through it.	yes/no
Title	Custom name of the automated task.	text
Description	Custom description of the automatic task function.	formatted text
Notes	Notes.	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 export in case of a long queue of requests to the server.	whole number
REST Exportable Product Store Attribute Mapping	A mapping containing an entry for each attribute to be exported.	complex type
Measure Unit	Measure unit such as cm, mm etc.	selection
Date Format	Date entry format, eg 31.12.19	selection
Date and Time Format	Date and time entry format, eg 19.12.31 23:59:59	selection
List Item Separator	Character for splitting the items of the list of values.	character
Product Set	Use the product set to select which products to export.	selection
Stores	You can select which stores to export.	selection

Settings

/v1/export/store-specific-product-data/{task_id}

Parameter	Value
URL	?debug added to the URL will also display warnings in the response. Without it, only errors are listed.
Header	Accept: application/json
Header	Content-type: application/json
Header	Authorization: Bearer <TOKEN> TOKEN se získává pomocí /authenticate (see Login).
Method	POST

The content of the request is a JSON object containing the following keys:

Key	Value
StoreIds	Within the request you need to specify for which store the product data is to be exported. It is always possible to select only one store. For example, if a store with an Id of "12" is not included in the automatic task settings and a request is sent for that store, only the empty value will be exported. Examples: { "StoreIds":"12"}

Key	Value
Status	A string describing the final state of the export. SUCCESS = error-free export process PARTIAL_SUCCESS = export completed but generated one or more warnings FAILURE = one or more errors occurred during the export
Warnings	It is optional, ie. is included only if the ?debug parameter is in the URL and the export generated at least one warning. List of warning strings.
Errors	Optional - included only if the export generated at least one error. List of error strings.
Total Lines	Optional - is included only if the export did not end with the status "FAILURE" Number of records on input.
Ignored Products	Optional - Included only if the export did not end with a "FAILURE" status The number of products from the input that have not been exported. Possible reasons are: Non-existent Product Ids and disabled creation of new products Product Id found among deleted products and ignoring deleted products is enabled

Status	Value
200 OK	Export 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 export.
503 Service Unavailable	The task is already running. Retry launching the task after count of seconds given in response header Retry-After.

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

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

Show Items

curl -X POST --location "https://[YOUR_COMPANY].iquant.eu/v1/export/store-specific-product-data/149?debug" \

-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \

-H "Accept: application/json" \

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

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

-d '[{ "Store ID": "12564"}]'

{

"Status": "SUCCESS", "Records": [

{"Store ID": "12564", "Primary Product ID": "100001", "Stock": "12"},

{"Store ID": "12564", "Primary Product ID": "100005", "Stock": "0"},

... ]

}