Onboard Order
1 min
POST
https://{domain}/app/logisticsorders/v1/api/orders/onboard
Header Parameters
- X-COREOS-REQUEST-IDstringrequiredDescription
- X-COREOS-TIDstringrequiredDescription
- X-COREOS-ACCESSstringrequiredDescription
- X-COREOS-USERINFOstringrequiredDescription
Body Parameters
- bodyOnboardRequestBody
- callbackUrlstring
Responses
202
- RequestProcessedSuccessResponse
- objectErrorResponse
- errorErrorrequiredDescription
- codestringDescription
- descriptionstringDescription
- additionalInfoobjectDescription
- requestRequestrequired
- uristringrequiredDescription
- methodstring<POST | GET | PUT>Description
- queryStringstringDescription
- bodyobjectDescription
- object
- dataobject
- idstringrequiredDescription
400
- PutErrorResponse
- objectErrorResponse
- errorErrorrequiredDescription
- codestringDescription
- descriptionstringDescription
- additionalInfoobjectDescription
- requestRequestrequired
- uristringrequiredDescription
- methodstring<POST | GET | PUT>Description
- queryStringstringDescription
- bodyobjectDescription
- object
- dataobject
- idUniqueIdDescription
401
- PutErrorResponse
- objectErrorResponse
- errorErrorrequiredDescription
- codestringDescription
- descriptionstringDescription
- additionalInfoobjectDescription
- requestRequestrequired
- uristringrequiredDescription
- methodstring<POST | GET | PUT>Description
- queryStringstringDescription
- bodyobjectDescription
- object
- dataobject
- idUniqueIdDescription
404
- PutErrorResponse
- objectErrorResponse
- errorErrorrequiredDescription
- codestringDescription
- descriptionstringDescription
- additionalInfoobjectDescription
- requestRequestrequired
- uristringrequiredDescription
- methodstring<POST | GET | PUT>Description
- queryStringstringDescription
- bodyobjectDescription
- object
- dataobject
- idUniqueIdDescription
curl
curl --request POST \
--url https://{domain}/app/logisticsorders/v1/api/orders/onboard \
--header 'accept: application/json' \
--header 'x-coreos-request-id: string' \
--header 'x-coreos-tid: string' \
--header 'x-coreos-access: string' \
--header 'x-coreos-userinfo: string'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-coreos-request-id", "string");
myHeaders.append("x-coreos-tid", "string");
myHeaders.append("x-coreos-access", "string");
myHeaders.append("x-coreos-userinfo", "string");
var requestOptions = {
method: 'POST',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://{domain}/app/logisticsorders/v1/api/orders/onboard", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://{domain}/app/logisticsorders/v1/api/orders/onboard")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-coreos-request-id"] = "string"
request["x-coreos-tid"] = "string"
request["x-coreos-access"] = "string"
request["x-coreos-userinfo"] = "string"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://{domain}/app/logisticsorders/v1/api/orders/onboard"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json',
'x-coreos-request-id': 'string',
'x-coreos-tid': 'string',
'x-coreos-access': 'string',
'x-coreos-userinfo': 'string'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
202
// Accepted
{
"error": {
"code": "",
"description": "",
"additionalInfo": {}
},
"request": {
"uri": "",
"method": "",
"queryString": "",
"body": {}
},
"data": {
"id": ""
}
}400
// Error Occurred
{
"error": {
"code": "",
"description": "",
"additionalInfo": {}
},
"request": {
"uri": "",
"method": "",
"queryString": "",
"body": {}
},
"data": {
"id": ""
}
}401
// Error Occurred
{
"error": {
"code": "",
"description": "",
"additionalInfo": {}
},
"request": {
"uri": "",
"method": "",
"queryString": "",
"body": {}
},
"data": {
"id": ""
}
}404
// Error Occurred
{
"error": {
"code": "",
"description": "",
"additionalInfo": {}
},
"request": {
"uri": "",
"method": "",
"queryString": "",
"body": {}
},
"data": {
"id": ""
}
}Onboard Order