REST API Product Packages Import V1
This source is used to product package import in Quant. Input and output format is JSON.
Use the Automatic Tasks section to create and set up an import. Once created, the task list will have the ID that you pass in the request URL.
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 Product Package Attribute Mapping, select the attributes to import and optionally modify their JSON keys
Attributes
Attribute | Description | Type |
Enabled | Specifies whether the automated task is active and can send data 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 |
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 |
Matching Attribute | A product attribute in Quant that will be used to match import items with products in Quant. | selection |
Create New Products | If enabled, the import will create new products for non-existent product IDs. | yes/no |
Set New Products for Planogramming | If enabled, newly created products will be designed to create planograms. This option is active only when Create New Products is enabled. | yes/no |
Ignore Deleted Products | By default, if the import does not find a live product for a given ID, it searches among the deleted products. If it finds a deleted one, it will revive it. Enabling this option ignores deleted products instead of recovering them. | yes/no |
Do Not Overwrite Non-zero Measurements | If enabled, dimensions from imported records (e.g. height, width) will only be imported if the existing package has zero dimensions. | yes/no |
Remove Not Updated Packages | When activated, deletes packages that have not been updated by any record. Applies only to products included in this import. | yes/no |
Remove Only Empty Packages | When activated, deletes only empty packages that have not been updated, i.e. packages with empty name and zero dimensions. | yes/no |
Product Package Attribute Mapping | A mapping containing an entry for each attribute to be imported. | complex type |
Request
/v1/import/product-packages/{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 an array of JSON objects containing the keys defined in the Product Package Attribute Mapping setting.
Response
Key | Value |
Status | A string describing the final state of the import.
|
Warnings | 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. |
Errors | Optional - included only if the import generated at least one error. List of error strings. |
Total Lines | Optional - is included only if the import did not end with the status "FAILURE" Number of records on input. |
Duplicated Packages | Optional - is included only if the import did not end with the status "FAILURE" The number of records that were skipped because this package was already imported in the same request. |
Ignored Products | Optional - Included only if the import did not end with a status of "FAILURE" Number of input products for which product packages were not imported. Possible reasons are:
|
Status Codes
Status | Value |
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.
If we select a specific record, we can display its details by clicking the Show Items button.
Request
curl -X POST --location "https://[YOUR_COMPANY].iquant.eu/v1/import/product-packages/28?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d '[{ "Primary Product ID": "100001", "Packaging": "Test Package", "Width": 10.5, "Height": 3, "Depth": 0.4 }]'
Response
{
"Status": "SUCCESS",
"Total Lines": 1,
"Duplicated Products": 0,
"Ignored Products": 0
}