Create a new order

1min
POST
Create a new order
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-CALLBACK-SECRET
string
Body Parameters
body
CreateOrderEntityRequest
*
shipmentFlow
OfferingCategoryType
*
workOrderFlowType
WorkOrderFlowType
*
dropDetails
DropDetails
*
readyToProcess
boolean
clientDetails
ClientDetails
*
orderSummary
OrderSummary
workOrders
WorkOrderCreateRequest[]
*
attributes
object
callback
Callback
onRequest
CustomCallRequestObject
onError
CustomCallErrorObject
Responses
202
Accepted
RequestProcessedSuccessResponse
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
Curl
JS
Ruby
Python
curl --location --globoff 'https://{base_url}/core/api/v1/orders/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "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/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "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
// Accepted 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
// Accepted 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
﻿
﻿
Updated 03 Aug 2023
Did this page help you?
Transition the current state of a work-order using client-details
Updates the order attributes