Get status of batch order execution

1min
GET
https://{domain}/app/logisticsorders/v1/api/orders/batch/{batchId}
Get the status of the Batch order execution
Path Parameters
batchId
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
*
Responses
200
Accepted
BatchStatusResponse
All Of
object  +
data
BatchOrderStatusData
request
Request
400
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/app/logisticsorders/v1/api/orders/batch/{batchId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{domain}/app/logisticsorders/v1/api/orders/batch/{batchId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
// 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": {}
  }
}
// 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": {}
  }
}
﻿
﻿
Updated 31 Aug 2024
Did this page help you?
Create orders in batch
Callback to update teamid and ref of shipment