Antel API

<back to all web services

FinaliseUplift

Requires Authentication
The following routes are available for this service:
POST/uplift/finalise
FinaliseUplift Parameters:
NameParameterData TypeRequiredDescription
UpliftIdbodyintNo
IncompleteUpliftIdbodyGuidNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
SaveUpliftResponse Parameters:
NameParameterData TypeRequiredDescription
UpliftIdformintNo
UpliftAuthRequestIdformGuidNo
SealsformList<UpliftSealData>No
UnbaggedItemsformUpliftSealDataNo
ClaimsformList<UpliftClaimData>No
DeleteFromDeviceformboolNo
ImageIdsformList<string>No
InvalidAntelSealformboolNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusNo
UpliftSealData Parameters:
NameParameterData TypeRequiredDescription
UnbaggedformboolNo
SealNumberformstringNo
AntelSealNumberformstringNo
ProductsformList<UpliftProductData>No
TotalPriceformdoubleNo
TotalQuantityformdoubleNo
NetWeightformdoubleNo
GrossWeightformdoubleNo
BillableSealformboolNo
InvalidAntelSealNumberformboolNo
UpliftProductData Parameters:
NameParameterData TypeRequiredDescription
UpliftProductIdformintNo
UpliftIdformintNo
ProductIdformintNo
UnitPriceformdecimalNo
NameformstringNo
CategoryformstringNo
UnitBarcodeformstringNo
UnitSizeformstringNo
UnitWeightformdecimalNo
CodeformstringNo
UpliftImagesformList<Object>No
QuantityformdoubleNo
ValueformdecimalNo
PriceOverMaxformboolNo
QuantityOverMaxformboolNo
QuantityOverRequirementformboolNo
SerialNumberformstringNo
BatchCodeformstringNo
StockStatusIdformintNo
LotNumberformstringNo
ExpiryDateformstringNo
ManufactureDateformstringNo
UpliftClaimData Parameters:
NameParameterData TypeRequiredDescription
UpliftClaimIdformintNo
ClaimUnitsformintNo
ClaimNumberformstringNo
ClaimValueformdecimalNo
ClaimDocumentImagesformList<Object>No
ReturnOrderNumberformstringNo
LineCountformintNo

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

HTTP + OTHER

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

POST /uplift/finalise HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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

{"upliftId":0,"seals":[{"unbagged":false,"sealNumber":"String","antelSealNumber":"String","products":[{"upliftProductId":0,"upliftId":0,"productId":0,"unitPrice":0,"name":"String","category":"String","unitBarcode":"String","unitSize":"String","unitWeight":0,"code":"String","upliftImages":[{}],"quantity":0,"value":0,"priceOverMax":false,"quantityOverMax":false,"quantityOverRequirement":false,"serialNumber":"String","batchCode":"String","stockStatusId":0,"lotNumber":"String","expiryDate":"String","manufactureDate":"String"}],"totalPrice":0,"totalQuantity":0,"netWeight":0,"grossWeight":0,"billableSeal":false,"invalidAntelSealNumber":false}],"unbaggedItems":{"unbagged":false,"sealNumber":"String","antelSealNumber":"String","products":[{"upliftProductId":0,"upliftId":0,"productId":0,"unitPrice":0,"name":"String","category":"String","unitBarcode":"String","unitSize":"String","unitWeight":0,"code":"String","upliftImages":[{}],"quantity":0,"value":0,"priceOverMax":false,"quantityOverMax":false,"quantityOverRequirement":false,"serialNumber":"String","batchCode":"String","stockStatusId":0,"lotNumber":"String","expiryDate":"String","manufactureDate":"String"}],"totalPrice":0,"totalQuantity":0,"netWeight":0,"grossWeight":0,"billableSeal":false,"invalidAntelSealNumber":false},"claims":[{"upliftClaimId":0,"claimUnits":0,"claimNumber":"String","claimValue":0,"claimDocumentImages":[{}],"returnOrderNumber":"String","lineCount":0}],"deleteFromDevice":false,"imageIds":["String"],"invalidAntelSeal":false,"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"}}}