Antel API

<back to all web services

OrderDetail

Requires Authentication
The following routes are available for this service:
POST/stock/orderDetail
OrderDetail Parameters:
NameParameterData TypeRequiredDescription
OrderNumberbodystringNo
ForOperatorbodyboolNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
OrderDetailResponse Parameters:
NameParameterData TypeRequiredDescription
OrderIdformintNo
OperatorNameformstringNo
DriverNameformstringNo
CompanyNameformstringNo
LicensePlateformstringNo
OrderNumberformstringNo
DestinationDepotformstringNo
CanCloseformboolNo
CanScanformboolNo
EstimatedSealsformintNo
ScannedSealsformlongNo
StatusformstringNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /stock/orderDetail HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"orderNumber":"String","forOperator":false,"apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"orderId":0,"operatorName":"String","driverName":"String","companyName":"String","licensePlate":"String","orderNumber":"String","destinationDepot":"String","canClose":false,"canScan":false,"estimatedSeals":0,"scannedSeals":0,"status":"String","description":"String","heading":"String","wasSuccessful":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}