Create orders in batch

1min
POST
Create orders in batch
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-CALLBACK-SECRET
string
Query Parameters
allOrNone
boolean
Body Parameters
body
CreateBatchOrderEntityRequest
*
payload
CreateOrderRequest[]
*
callback
Callback
onRequest
CustomCallRequestObject
onError
CustomCallErrorObject
Responses
202
Accepted
RequestProcessedBatchSuccessResponse
error
Error
*
request
Request
*
data
object
400
Error Occurred
PostErrorResponse
error
Error
*
request
Request
*
data
object
401
Error Occurred
PostErrorResponse
error
Error
*
request
Request
*
data
object
404
Error Occurred
PostErrorResponse
error
Error
*
request
Request
*
data
object
Curl
JS
Ruby
Python
curl --location --globoff 'https://{base_url}/core/api/v1/orders/batch' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "payload": [
    {
      "shipmentFlow": "",
      "workOrderFlowType": "",
      "dropDetails": {
        "contact": {},
        "location": {}
      },
      "clientDetails": {
        "clientId": "",
        "clientOrderId": ""
      },
      "orderSummary": {
        "orderDescription": ""
      },
      "workOrders": [
        {
          "serviceTemplateId": "",
          "serviceTemplateName": "",
          "pickupDetails": {
            "contact": {},
            "location": {}
          },
          "type": ""
        }
      ]
    }
  ],
  "onRequest": {
    "url": "",
    "requestHeader": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  },
  "onError": {
    "url": "",
    "requestHeader": {},
    "method": "",
    "onResponse": {}
  }
}'
curl --location --globoff 'https://{base_url}/core/api/v1/orders/batch' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "payload": [
    {
      "shipmentFlow": "",
      "workOrderFlowType": "",
      "dropDetails": {
        "contact": {},
        "location": {}
      },
      "clientDetails": {
        "clientId": "",
        "clientOrderId": ""
      },
      "orderSummary": {
        "orderDescription": ""
      },
      "workOrders": [
        {
          "serviceTemplateId": "",
          "serviceTemplateName": "",
          "pickupDetails": {
            "contact": {},
            "location": {}
          },
          "type": ""
        }
      ]
    }
  ],
  "onRequest": {
    "url": "",
    "requestHeader": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  },
  "onError": {
    "url": "",
    "requestHeader": {},
    "method": "",
    "onResponse": {}
  }
}'
Responses
202
400
401
404
// Accepted 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "batchId": "",
    "orders": [
      {
        "id": ""
      }
    ]
  }
}
// Accepted 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "batchId": "",
    "orders": [
      {
        "id": ""
      }
    ]
  }
}
﻿
﻿
Updated 03 Aug 2023
Did this page help you?
Add workOrder to the order