REST API Orders Import
This source is used to import order data in Quant. The 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 Order Data Attribute Mapping , select the attributes to import and optionally modify their JSON keys
Attributes
Attribute | Description | Type |
Enabled | Specifies whether the user can access this resource. | 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 import in case of a long queue of requests to the server. | whole number |
Order Data Attribute Mapping | A mapping containing an entry for the product ID, QID and Approved Volume. | complex type |
Measure Unit | Unit of measure such as cm, mm, etc. | selection |
Date Format | Date entry format, eg 31.12.19 | selection |
Date and Time Format | Date and time format, e.g. 31.12.19 23:59:59 | selection |
List Item Separator | Character for splitting the items of the list of values. | character |
- Request
/v1/import/order-data/{task_id}
Parameter | Value |
URL | ?debug added to the URL will also display a warning in the response. Without it, only errors are listed. |
Header | Accept: application/json |
Header | Content-type: application/json |
Header | Authorization: Bearer <TOKEN> TOKEN is obtained via /authenticate (see Login). |
Method | POST |
The content of the request is an array of JSON objects containing the keys defined in the Order Data Attribute Mapping setting, specifically order QID, Primary Product ID and Approved Volume.
Response
Key | Value |
Status | A string describing the final state of the import.
|
Warnings | Optional - 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. |
Based on the request, Quant sets the approved volume for all products sent within the order. For products that were part of the order but we did not receive information about the approved volume, Quant sets the approved volume to 0. At the same time, it changes the order state to Ordered. Even after changing the order state, it is possible to add an approved volume of another product to the order via the REST API Orders Import.
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/order-data/54?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d '[{"QID":"932554","Primary Product Id":"100034","Approved Volume":150}]'
Response
{
"Status": "SUCCESS",
}