REST API Export Placed Products V1
This source is used to export products placed in planograms in Quant. Input and output format is JSON.
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.
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 Placed Product Attribute Mapping , select the attributes to export and optionally modify their JSON keys
Attributes
Attribute | Description | Type |
Enables | 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 | Unit of measure such as cm, mm etc. | selection |
Date Format | Date entry format, eg. 31.12.19 | selection |
Date and Time Format | Date entry format and time, eg. 31.12.19 23:59:59 | selection |
Placed Product Attribute Mapping | A mapping containing an entry for each attribute of the placed product to be exported. | complex type |
Stores | A filter that determines which stores are included in the export. | complex type |
Cumulation Level | Cumulation selection by level Block / Shelf / Fixture / Store / Status. | selection |
Placed Products | Products placed in planograms will be included in the export. | yes/no |
Not Placed Products | The export will include products placed in the planogram template, but not in the planogram (crossed out in the template). | yes/no |
Not Placed Backstock Products | The export will include unplaced products that are also set on the block to be in the temporary warehouse. | yes/no |
Space Type | Select whether you want to see spatial data such as m, m2 or m3. | selection |
Level of Normalized Category | The level of categories within the hierarchy that you want to display in the export. | number |
Request
/v1/export/placed-products/{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 (optional) | Accept-Encoding: gzip, deflate, br |
Header | Authorization: Bearer <TOKEN> TOKEN is obtained using /authenticate (see Login). |
Method | POST |
The content of the request is a JSON object containing the following keys:
Key | Value |
PlanogramStates | A separate string or array of strings specifying which planogram states will be processed by the export. Possible values: PREPARED / WAITING / IMPLEMENTED Examples: { "PlanogramStates": "PREPARED" } { "PlanogramStates": [ "PREPARED", "WAITING" ] } |
StoreIds | An optional string field specifying which stores will be processed by the export. The Store ID must always be specified as a string, even if it is only one store. If only an empty value is provided, all stores specified in the automatic task settings will be exported. 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" ] } { "StoreIds": [ "12", "135", "209" ] } |
Response
Key | Value |
Status | A string describing the final state of 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. |
Records | Optional - is included only if the export did not end with the status "FAILURE". List of exported objects. Each object contains keys defined by mapping in the job settings. |
Status Codes
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. |
Execution Log
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.
Request
curl -X POST --location "http://localhost:4150/v1/export/placed-products/10?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d '{ "PlanogramStates": ["PREPARED", "WAITING"] , "StoreIds": [ "12" ] }'
Response
{
"Status": "SUCCESS", "Records": [
{"Planogram ID": "166882", "Primary Product ID": "100001", "Fixture ID": "1231"},
{"Planogram ID": "166850", "Primary Product ID": "100005", "Fixture ID": "1232"},
... ]
}