This repository has been archived by the owner on May 20, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 17
Operations Status Search API Endpoint
Eugene Tulika edited this page Apr 11, 2018
·
2 revisions
Source Branch: https://github.com/magento/bulk-api-ce/commits/bulk-api-rc
Description of current endpoints: https://github.com/magento/bulk-api-ce/pull/6
Currently we have developed API that allows us to receive Bulk Request Status by UUID.
In addition to this we need new endpoint that will allow us to receive all bulk operations statuses based on next filters:
- Status (1 = Complete, 2 = Retriably Failed, 3 = Not Retriably Failed, 4 = Open, 5 = Rejected)
- Time From
- Time To
All 3 parameters are not required and can be skipped.
Example:
GET http://URL/rest/V1/bulk/?searchCriteria[status]=1&searchCriteria[from]=2017-09-15%2015:47:57&searchCriteria[to]=2018-09-15%2015:47:57
This GET Request have to make a search though Bulk Operations in Magento and deliver results based on searchCriteria parameters.
Result example:
{
"operations_list": [
{
"id": 0,
"topic_name": "string",
"status": 0,
"result_serialized_data": "string",
"result_message": "string",
"error_code": 0
},
{
"id": N,
"topic_name": "string",
"status": 0,
"result_serialized_data": "string",
"result_message": "string",
"error_code": 0
}
]
}
- for result code: we don't know success messages, but we need to know failed and what reasons
- for all successful responses we want product ids back; one request to include more data
- filter by date: find failed entities for only recent imports