Antel API

<back to all web services

DepotOrderListRequest

Requires Authentication
The following routes are available for this service:
GET/stock/depot/order/list
DepotOrderListRequest Parameters:
NameParameterData TypeRequiredDescription
SearchQueryquerystringNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
DepotOrderListResponse Parameters:
NameParameterData TypeRequiredDescription
DepotOrdersformList<DepotOrderItem>No
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusNo
DepotOrderItem Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
OrderNumberformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /stock/depot/order/list HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"depotOrders":[{"id":0,"orderNumber":"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"}}}