Get Order Details
1 min
GET
https://{domain}/app/logisticsorders/v1/api/orders/{orderId}
Path Parameters
- orderIdstringrequiredDescription
Header Parameters
- X-COREOS-REQUEST-IDstringrequiredDescription
- X-COREOS-TIDstringrequiredDescription
- X-COREOS-ACCESSstringrequiredDescription
- X-COREOS-USERINFOstringrequiredDescription
Responses
200
- OrderGetResponse
- objectErrorResponse
- errorErrorrequiredDescription
- codestringDescription
- descriptionstringDescription
- additionalInfoobjectDescription
- requestRequestrequired
- uristringrequiredDescription
- methodstring<POST | GET | PUT>Description
- queryStringstringDescription
- bodyobjectDescription
- object
- dataOrderResponse
- OrderEntity
- dropDetailsDropDetailsrequired
- DropDetailsUpdateRequest
- contactContact
- UniqueId
- ContactDetails
- namestringrequiredDescription
- phonePhoneDescription
- Max depth limit reached
- emailMultipleEmail
- Email
- Max depth limit reached
- AdditionalEmail
- Max depth limit reached
- additionalPhonePhone[]Description
- Max depth limit reached
- additionalEmailAdditionalEmail[]
- Max depth limit reached
- locationLocation
- UniqueId
- LocationDetails
- locationInfoobject
- addressAddressrequiredDescription
- Max depth limit reached
- geolocationGeoCodeExample
{ "lat": "30.3752° N", "long": "76.7821° E" }- Max depth limit reached
- orderSummaryOrderSummary
- invoiceNumberstringDescription
- orderDescriptionstringDescription
- totalWeightTotalOrderWeightDescription
- valuenumberrequired
- totalVolumeTotalOrderVolumeDescription
- valuenumberrequired
- totalItemsnumberDescription
- totalOrderCostTotalOrderCostDescription
- costnumberrequiredDescription
- currencyCodestringDescription
- minorUnitnumberDescription
- totalInvoiceInvoiceDescription
- valueintegerDescription
- currencyCodestringDescription
- minorUnitintegerDescription
- clientDetailsClientDetailsrequiredDescription
- clientNamestring
- clientIdUniqueIdDescription
- clientOrderIdUniqueIdrequiredDescription
- mpsMps
- MpsUpdateRequest
- groupIdstringDescription
- groupSizenumberDescription
- isEnabledbooleanDescription
- isPartialbooleanDescription
- eWaybillAttributeseWaybillAttributes
- eWaybillAttributesRequest
- is_valid_ewaybillbooleanDescription
- ewaybillsstring[]Description
- productTypeProductTyperequiredDescription
- planningModePlanningModeDescription
- modeOfTransportModeOfTransportDescription
- speedOfTransportSpeedOfTransportDescription
- shipmentFlowShipmentFlowrequiredDescription
- pickupDetailsPickupDetailsrequired
- PickupDetailsUpdateRequest
- contactContact
- UniqueId
- ContactDetails
- namestringrequiredDescription
- phonePhoneDescription
- Max depth limit reached
- emailMultipleEmail
- Email
- Max depth limit reached
- AdditionalEmail
- Max depth limit reached
- additionalPhonePhone[]Description
- Max depth limit reached
- additionalEmailAdditionalEmail[]
- Max depth limit reached
- locationLocation
- UniqueId
- LocationDetails
- locationInfoobject
- addressAddressrequiredDescription
- Max depth limit reached
- geolocationGeoCodeExample
{ "lat": "30.3752° N", "long": "76.7821° E" }- Max depth limit reached
- pickupSlotTimeSlotDescription
- frominteger<int64>
- tointeger<int64>
- serviceTimeintegerDescription
- instructionstringDescription
- paymentInformationPaymentInformationDescription
- paymentTypePaymentTypeDescription
- paymentOptionPaymentOptionDescription
- deliveryDetailsDeliveryDetailsDescription
- promisedDeliveryDatestring
- deliverySlotTimeSlotDescription
- frominteger<int64>
- tointeger<int64>
- serviceTimeintegerDescription
- instructionstringDescription
- actionsDoorstepActionsDescription
- qcValidationActionRequired
- isRequiredbooleanrequired
- requiredAtstring<PICKUP | DROP | BOTH>
- qcValidationChecklistobjectDescription
- kycVerificationActionRequired
- isRequiredbooleanrequired
- requiredAtstring<PICKUP | DROP | BOTH>
- otpVerificationActionRequired
- isRequiredbooleanrequired
- requiredAtstring<PICKUP | DROP | BOTH>
- signatureCollectionActionRequired
- isRequiredbooleanrequired
- requiredAtstring<PICKUP | DROP | BOTH>
- notificationDetailsNotificationDetailsDescription
- notificationTypeNotificationTypeDescription
- notificationModeNotificationModeDescription
- returnDetailsReturnDetailsDescription
- contactContact
- UniqueId
- ContactDetails
- namestringrequiredDescription
- phonePhoneDescription
- countryCodestringrequiredDescription
- numberstringrequiredDescription
- isMobilebooleanrequiredDescription
- areaCodestringDescription
- muteNotifbooleanDescriptionDefaultfalse
- emailMultipleEmail
- Email
- Max depth limit reached
- AdditionalEmail
- Max depth limit reached
- additionalPhonePhone[]Description
- countryCodestringrequiredDescription
- numberstringrequiredDescription
- isMobilebooleanrequiredDescription
- areaCodestringDescription
- muteNotifbooleanDescriptionDefaultfalse
- additionalEmailAdditionalEmail[]
- idstringDescription
- muteNotifbooleanDescriptionDefaultfalse
- locationLocation
- UniqueId
- LocationDetails
- locationInfoobject
- addressAddressrequiredDescription
- buildingNumberstringDescription
- addressLine1stringrequiredDescription
- addressLine2stringDescription
- addressLine3stringDescription
- apartmentNumberstringDescription
- floorstringDescription
- countystringDescription
- citystringrequiredDescription
- statestringrequiredDescription
- zipCodestringrequiredDescription
- countryCountryrequiredDescription
- Max depth limit reached
- geolocationGeoCodeExample
{ "lat": "30.3752° N", "long": "76.7821° E" }- longstringrequiredDescription
- latstringrequiredDescription
- returnSlotTimeSlotDescription
- frominteger<int64>
- tointeger<int64>
- serviceTimeintegerDescription
- prioritynumberDescription
- maxAttemptsnumberDescriptionDefault3
- teamIdstringrequiredDescription
- seqNonumberDescription
- routeTagstringDescription
- vehicleModelstringDescription
- readyToProcessbooleanDescriptionDefaulttrue
- containersContainerDetails[]Description
- containerTypestringrequiredDescriptionDefaultShipment
- scannableIdstringrequiredDescription
- trackingDetailsTrackingDetailsDescription
- operatorstringrequiredDescription
- trackingIdstringrequiredDescription
- isPrimarybooleanDescription
- attributesmap<string, string>
- dimensionsDimensionsDescription
- weightnumberDescription
- volumenumberDescription
- object
- idUniqueIdDescription
- offeringCategoryOfferingCategoryDescription
400
- GetErrorResponse
- objectErrorResponse
- errorErrorrequiredDescription
- codestringDescription
- descriptionstringDescription
- additionalInfoobjectDescription
- requestRequestrequired
- uristringrequiredDescription
- methodstring<POST | GET | PUT>Description
- queryStringstringDescription
- bodyobjectDescription
- object
- dataobject
- idUniqueIdDescription
401
- GetErrorResponse
- objectErrorResponse
- errorErrorrequiredDescription
- codestringDescription
- descriptionstringDescription
- additionalInfoobjectDescription
- requestRequestrequired
- uristringrequiredDescription
- methodstring<POST | GET | PUT>Description
- queryStringstringDescription
- bodyobjectDescription
- object
- dataobject
- idUniqueIdDescription
curl
curl --request GET \
--url https://{domain}/app/logisticsorders/v1/api/orders/{orderId} \
--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: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://{domain}/app/logisticsorders/v1/api/orders/{orderId}", 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/{orderId}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.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/{orderId}"
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("GET", url, headers=headers, data=payload)
print(response.text)
200
// Entity event mapped response
{
"error": {
"code": "",
"description": "",
"additionalInfo": {}
},
"request": {
"uri": "",
"method": "",
"queryString": "",
"body": {}
},
"data": {}
}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": ""
}
}Get Order Details