---
title: Get the status if batch execution
slug: mihai-tests/get-the-status-if-batch-execution
createdAt: 2025-05-09T09:41:47.059Z
---
{
"id": "V8hktzUGC8EOGG3XtPH0A",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://{domain}/app/logisticsorders/v1/api/orders/batch/{batchId}",
"servers": [
{
"url": "https://{domain}/app/logisticsorders/v1/api/orders/batch/{batchId}"
}
],
"name": "Get the status if batch execution",
"description": "Get the status of the Batch order execution",
"contentType": "application/json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "batchId",
"type": "string",
"description": ""
}
],
"headerParameters": [
{
"kind": "required",
"name": "X-COREOS-REQUEST-ID",
"type": "string",
"description": "Unique requestId"
},
{
"kind": "required",
"name": "X-COREOS-TID",
"type": "string",
"description": "Tenant id"
},
{
"kind": "required",
"name": "X-COREOS-ACCESS",
"type": "string",
"description": "core-os access token
"
},
{
"kind": "required",
"name": "X-COREOS-USERINFO",
"type": "string",
"description": "core-os user info token
"
}
],
"queryParameters": [],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Accepted",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "BatchStatusResponse",
"schema": [
{
"name": "data",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/BatchOrderStatusData",
"customType": "BatchOrderStatusData",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "Batch Id for order creation",
"example": ""
},
{
"name": "status",
"kind": "optional",
"type": "string",
"description": "Status of the Operation",
"example": ""
},
{
"name": "successCount",
"kind": "optional",
"type": "integer",
"example": 1
},
{
"name": "failureCount",
"kind": "optional",
"type": "integer",
"example": 1
},
{
"name": "totalCount",
"kind": "optional",
"type": "integer",
"example": 2
},
{
"name": "tenantId",
"kind": "optional",
"type": "string",
"example": "tenant"
},
{
"name": "successDetails",
"kind": "optional",
"type": "array",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "clientOrderId",
"kind": "optional",
"type": "string",
"description": "Client Order Id",
"example": ""
}
]
},
{
"name": "failureDetails",
"kind": "optional",
"type": "array",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "clientOrderId",
"kind": "optional",
"type": "string",
"description": "Client Order Id",
"example": ""
},
{
"name": "errors",
"kind": "optional",
"type": "array",
"description": "List of errors for the order",
"modelRef": "#/components/schemas/ErrorEntity",
"customType": "ErrorEntity[]",
"schema": [
{
"name": "MESSAGE",
"kind": "optional",
"type": "string",
"description": "Human readable error message",
"example": "returnSlot from must be greater than current timestamp in milliseconds"
},
{
"name": "LABEL",
"kind": "optional",
"type": "string",
"description": "JSON path for the attribute for which this error appears",
"example": "returnDetails.returnSlot.from"
},
{
"name": "CODE",
"kind": "optional",
"type": "string",
"description": "Error Code for the Error message.",
"example": "F-A2137-E4012"
},
{
"name": "META",
"kind": "optional",
"type": "object",
"description": "Additional metadata about the error",
"example": "",
"schema": []
}
]
}
]
}
]
},
{
"name": "request",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Request",
"customType": "Request",
"schema": [
{
"name": "uri",
"kind": "required",
"type": "string",
"description": "The API end point where the request was received",
"example": ""
},
{
"name": "method",
"kind": "optional",
"type": "string",
"description": "HTTP method requested on the API endpoint",
"example": ""
},
{
"name": "queryString",
"kind": "optional",
"type": "string",
"description": "Query string received by the server",
"example": ""
},
{
"name": "body",
"kind": "optional",
"type": "object",
"description": "Request body data received by the server",
"example": "",
"schema": []
}
]
}
],
"modelRef": "#/components/schemas/BatchStatusResponse",
"complexItems": [
{
"name": "object",
"schema": [
{
"name": "data",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/BatchOrderStatusData",
"customType": "BatchOrderStatusData",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "Batch Id for order creation",
"example": ""
},
{
"name": "status",
"kind": "optional",
"type": "string",
"description": "Status of the Operation",
"example": ""
},
{
"name": "successCount",
"kind": "optional",
"type": "integer",
"example": 1
},
{
"name": "failureCount",
"kind": "optional",
"type": "integer",
"example": 1
},
{
"name": "totalCount",
"kind": "optional",
"type": "integer",
"example": 2
},
{
"name": "tenantId",
"kind": "optional",
"type": "string",
"example": "tenant"
},
{
"name": "successDetails",
"kind": "optional",
"type": "array",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "clientOrderId",
"kind": "optional",
"type": "string",
"description": "Client Order Id",
"example": ""
}
]
},
{
"name": "failureDetails",
"kind": "optional",
"type": "array",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "clientOrderId",
"kind": "optional",
"type": "string",
"description": "Client Order Id",
"example": ""
},
{
"name": "errors",
"kind": "optional",
"type": "array",
"description": "List of errors for the order",
"modelRef": "#/components/schemas/ErrorEntity",
"customType": "ErrorEntity[]",
"schema": [
{
"name": "MESSAGE",
"kind": "optional",
"type": "string",
"description": "Human readable error message",
"example": "returnSlot from must be greater than current timestamp in milliseconds"
},
{
"name": "LABEL",
"kind": "optional",
"type": "string",
"description": "JSON path for the attribute for which this error appears",
"example": "returnDetails.returnSlot.from"
},
{
"name": "CODE",
"kind": "optional",
"type": "string",
"description": "Error Code for the Error message.",
"example": "F-A2137-E4012"
},
{
"name": "META",
"kind": "optional",
"type": "object",
"description": "Additional metadata about the error",
"example": "",
"schema": []
}
]
}
]
}
]
},
{
"name": "request",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Request",
"customType": "Request",
"schema": [
{
"name": "uri",
"kind": "required",
"type": "string",
"description": "The API end point where the request was received",
"example": ""
},
{
"name": "method",
"kind": "optional",
"type": "string",
"description": "HTTP method requested on the API endpoint",
"example": ""
},
{
"name": "queryString",
"kind": "optional",
"type": "string",
"description": "Query string received by the server",
"example": ""
},
{
"name": "body",
"kind": "optional",
"type": "object",
"description": "Request body data received by the server",
"example": "",
"schema": []
}
]
}
]
}
],
"complexType": "allOf",
"isExpanded": true
}
]
},
{
"statusCode": "400",
"description": "Error Occurred",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "error",
"kind": "required",
"type": "object",
"description": "Error Information",
"modelRef": "#/components/schemas/Error",
"customType": "Error",
"schema": [
{
"name": "code",
"kind": "optional",
"type": "string",
"description": "Error code",
"example": ""
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": "Error description",
"example": ""
},
{
"name": "additionalInfo",
"kind": "optional",
"type": "object",
"description": "Additional information related to the error",
"example": "",
"schema": []
}
]
},
{
"name": "request",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Request",
"customType": "Request",
"schema": [
{
"name": "uri",
"kind": "required",
"type": "string",
"description": "The API end point where the request was received",
"example": ""
},
{
"name": "method",
"kind": "optional",
"type": "string",
"description": "HTTP method requested on the API endpoint",
"example": ""
},
{
"name": "queryString",
"kind": "optional",
"type": "string",
"description": "Query string received by the server",
"example": ""
},
{
"name": "body",
"kind": "optional",
"type": "object",
"description": "Request body data received by the server",
"example": "",
"schema": []
}
]
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "example-0-curl",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url https://{domain}/app/logisticsorders/v1/api/orders/batch/{batchId} \\\n --header 'accept: application/json' \\\n --header 'x-coreos-request-id: string' \\\n --header 'x-coreos-tid: string' \\\n --header 'x-coreos-access: string' \\\n --header 'x-coreos-userinfo: string'"
},
{
"id": "example-1-javascript",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-coreos-request-id\", \"string\");\nmyHeaders.append(\"x-coreos-tid\", \"string\");\nmyHeaders.append(\"x-coreos-access\", \"string\");\nmyHeaders.append(\"x-coreos-userinfo\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://{domain}/app/logisticsorders/v1/api/orders/batch/{batchId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "example-2-ruby",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://{domain}/app/logisticsorders/v1/api/orders/batch/{batchId}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-coreos-request-id\"] = \"string\"\nrequest[\"x-coreos-tid\"] = \"string\"\nrequest[\"x-coreos-access\"] = \"string\"\nrequest[\"x-coreos-userinfo\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "example-3-python",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://{domain}/app/logisticsorders/v1/api/orders/batch/{batchId}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-coreos-request-id': 'string',\n 'x-coreos-tid': 'string',\n 'x-coreos-access': 'string',\n 'x-coreos-userinfo': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "example-0-curl"
},
"results": {
"languages": [
{
"id": "response-0-200",
"language": "200",
"code": "// Accepted\n{\n \"data\": {\n \"id\": \"\",\n \"status\": \"\",\n \"successCount\": 1,\n \"failureCount\": 1,\n \"totalCount\": 2,\n \"tenantId\": \"tenant\",\n \"successDetails\": [\n {\n \"clientOrderId\": \"\"\n }\n ],\n \"failureDetails\": [\n {\n \"clientOrderId\": \"\",\n \"errors\": [\n {\n \"MESSAGE\": \"returnSlot from must be greater than current timestamp in milliseconds\",\n \"LABEL\": \"returnDetails.returnSlot.from\",\n \"CODE\": \"F-A2137-E4012\",\n \"META\": {}\n }\n ]\n }\n ]\n },\n \"request\": {\n \"uri\": \"\",\n \"method\": \"\",\n \"queryString\": \"\",\n \"body\": {}\n }\n}"
},
{
"id": "response-1-400",
"language": "400",
"code": "// Error Occurred\n{\n \"error\": {\n \"code\": \"\",\n \"description\": \"\",\n \"additionalInfo\": {}\n },\n \"request\": {\n \"uri\": \"\",\n \"method\": \"\",\n \"queryString\": \"\",\n \"body\": {}\n }\n}"
}
],
"selectedLanguageId": "response-0-200"
}
},
"children": [
{
"id": "QYTqjJh5R41_Pq3d8DM3C",
"type": "paragraph",
"children": [
{
"text": "Get the status of the Batch order execution"
}
]
}
]
}