Antel API

<back to all web services

FinishOrderAssignment

Requires Authentication
The following routes are available for this service:
POST/stock/order/assignment/finish
FinishOrderAssignment Parameters:
NameParameterData TypeRequiredDescription
OrderIdbodyintNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
FinishOrderAssignmentResponse Parameters:
NameParameterData TypeRequiredDescription
OrderIdformintNo
EstimatedSealsformintNo
OperationSummaryformStockOperationSummaryNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusNo
StockOperationSummary Parameters:
NameParameterData TypeRequiredDescription
ScannedSealsformList<StockOperationSealItem>No
MissingSealsformList<StockOperationSealItem>No
UnknownUpliftSealsformList<StockOperationSealItem>No
PausedSealsformList<StockOperationSealItem>No
WeightDifferenceSealsformList<StockOperationSealItem>No
HasScannedSealsformboolNo
HasMissingSealsformboolNo
HasWeightDifferenceSealsformboolNo
HasUnknownUpliftSealsformboolNo
HasPausedSealsformboolNo
HasExceptionformboolNo
TotalSealsCountformintNo
TotalSealsWeightformdoubleNo
StockOperationSealItem Parameters:
NameParameterData TypeRequiredDescription
UpliftNumberformstringNo
SealNumberformstringNo
PrincipalNameformstringNo
CurrentWeightformdoubleNo
WeightDifferenceformdoubleNo
OperatorNameformstringNo
OutletNameformstringNo
UpliftDateformstringNo
PausedAwaitingAuthformboolNo
UpliftPdfLinkformstringNo

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/order/assignment/finish HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

{"orderId":0,"estimatedSeals":0,"operationSummary":{"scannedSeals":[{"upliftNumber":"String","sealNumber":"String","principalName":"String","currentWeight":0,"weightDifference":0,"operatorName":"String","outletName":"String","upliftDate":"String","pausedAwaitingAuth":false,"upliftPdfLink":"String"}],"missingSeals":[{"upliftNumber":"String","sealNumber":"String","principalName":"String","currentWeight":0,"weightDifference":0,"operatorName":"String","outletName":"String","upliftDate":"String","pausedAwaitingAuth":false,"upliftPdfLink":"String"}],"unknownUpliftSeals":[{"upliftNumber":"String","sealNumber":"String","principalName":"String","currentWeight":0,"weightDifference":0,"operatorName":"String","outletName":"String","upliftDate":"String","pausedAwaitingAuth":false,"upliftPdfLink":"String"}],"pausedSeals":[{"upliftNumber":"String","sealNumber":"String","principalName":"String","currentWeight":0,"weightDifference":0,"operatorName":"String","outletName":"String","upliftDate":"String","pausedAwaitingAuth":false,"upliftPdfLink":"String"}],"weightDifferenceSeals":[{"upliftNumber":"String","sealNumber":"String","principalName":"String","currentWeight":0,"weightDifference":0,"operatorName":"String","outletName":"String","upliftDate":"String","pausedAwaitingAuth":false,"upliftPdfLink":"String"}],"hasScannedSeals":true,"hasMissingSeals":true,"hasWeightDifferenceSeals":true,"hasUnknownUpliftSeals":true,"hasPausedSeals":true,"hasException":true,"totalSealsCount":4,"totalSealsWeight":0},"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"}}}