Get the status if batch execution
1 min
GET
https://{domain}/app/logisticsorders/v1/api/orders/batch/{batchId}
Path Parameters
- batchIdstringrequired
Header Parameters
- X-COREOS-REQUEST-IDstringrequiredDescription
- X-COREOS-TIDstringrequiredDescription
- X-COREOS-ACCESSstringrequiredDescription
- X-COREOS-USERINFOstringrequiredDescription
Responses
200
- BatchStatusResponse
- object
- dataBatchOrderStatusData
- idstringDescription
- statusstring<Partial Success | Failed | Success | In Progress>Description
- successCountintegerExample
- failureCountintegerExample
- totalCountintegerExample
- tenantIdstringExample
- successDetailsobject[]
- clientOrderIdstringDescription
- failureDetailsobject[]
- clientOrderIdstringDescription
- errorsErrorEntity[]Description
- MESSAGEstringExampleDescription
- LABELstringExampleDescription
- CODEstringExampleDescription
- METAobjectDescription
- requestRequest
- uristringrequiredDescription
- methodstring<POST | GET | PUT>Description
- queryStringstringDescription
- bodyobjectDescription
400
- ErrorResponse
- errorErrorrequiredDescription
- codestringDescription
- descriptionstringDescription
- additionalInfoobjectDescription
- requestRequestrequired
- uristringrequiredDescription
- methodstring<POST | GET | PUT>Description
- queryStringstringDescription
- bodyobjectDescription
curl
curl --request GET \
--url https://{domain}/app/logisticsorders/v1/api/orders/batch/{batchId} \
--header 'accept: application/json' \
--header 'x-coreos-request-id: string' \
--header 'x-coreos-tid: string' \
--header 'x-coreos-access: string' \
--header 'x-coreos-userinfo: string'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-coreos-request-id", "string");
myHeaders.append("x-coreos-tid", "string");
myHeaders.append("x-coreos-access", "string");
myHeaders.append("x-coreos-userinfo", "string");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://{domain}/app/logisticsorders/v1/api/orders/batch/{batchId}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://{domain}/app/logisticsorders/v1/api/orders/batch/{batchId}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-coreos-request-id"] = "string"
request["x-coreos-tid"] = "string"
request["x-coreos-access"] = "string"
request["x-coreos-userinfo"] = "string"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://{domain}/app/logisticsorders/v1/api/orders/batch/{batchId}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json',
'x-coreos-request-id': 'string',
'x-coreos-tid': 'string',
'x-coreos-access': 'string',
'x-coreos-userinfo': 'string'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Accepted
{
"data": {
"id": "",
"status": "",
"successCount": 1,
"failureCount": 1,
"totalCount": 2,
"tenantId": "tenant",
"successDetails": [
{
"clientOrderId": ""
}
],
"failureDetails": [
{
"clientOrderId": "",
"errors": [
{
"MESSAGE": "returnSlot from must be greater than current timestamp in milliseconds",
"LABEL": "returnDetails.returnSlot.from",
"CODE": "F-A2137-E4012",
"META": {}
}
]
}
]
},
"request": {
"uri": "",
"method": "",
"queryString": "",
"body": {}
}
}400
// Error Occurred
{
"error": {
"code": "",
"description": "",
"additionalInfo": {}
},
"request": {
"uri": "",
"method": "",
"queryString": "",
"body": {}
}
}Get the status of the Batch order execution