Create a new order

1min
POST
https://{domain}/app/logisticsorders/v1/api/orders/
Create a new order
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
*
Body Parameters
body
CreateOrderEntityRequest
*
All Of
OrderEntity  +
dropDetails
DropDetails
*
All Of
DropDetailsUpdateRequest  +
orderSummary
OrderSummary
clientDetails
ClientDetails
*
productType
ProductType
*
shipmentFlow
ShipmentFlow
*
pickupDetails
PickupDetails
*
All Of
PickupDetailsUpdateRequest  +
paymentInformation
PaymentInformation
deliveryDetails
DeliveryDetails
returnDetails
ReturnDetails
priority
number
maxAttempts
number
teamId
string
*
seqNo
number
routeTag
string
readyToProcess
boolean
containers
ContainerDetails[]
callback
Callback
Responses
202
Accepted
RequestProcessedSuccessResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
data
object
400
Error Occurred
PostErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
data
object
401
Error Occurred
PostErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
data
object
404
Error Occurred
PostErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
data
object
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/app/logisticsorders/v1/api/orders/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "dropDetails": {},
  "clientDetails": {
    "clientOrderId": ""
  },
  "productType": "",
  "shipmentFlow": "",
  "pickupDetails": {},
  "teamId": "",
  "containers": [
    {
      "containerType": "Shipment",
      "scannableId": "",
      "trackingDetails": {
        "operator": "",
        "trackingId": ""
      }
    }
  ],
  "callback": {
    "url": ""
  }
}'
curl --location --globoff 'https://{domain}/app/logisticsorders/v1/api/orders/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "dropDetails": {},
  "clientDetails": {
    "clientOrderId": ""
  },
  "productType": "",
  "shipmentFlow": "",
  "pickupDetails": {},
  "teamId": "",
  "containers": [
    {
      "containerType": "Shipment",
      "scannableId": "",
      "trackingDetails": {
        "operator": "",
        "trackingId": ""
      }
    }
  ],
  "callback": {
    "url": ""
  }
}'
Responses
202
400
401
404
// 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 08 Oct 2024
Did this page help you?
Update state of Vehicle by id or external ref
Get Order Details