Antel Merchandiser App API

<back to all web services

IncompleteUpliftRequestFromServer

The following routes are available for this service:
GET/sync/incompleteupliftrequest
IncompleteUpliftRequestFromServer Parameters:
NameParameterData TypeRequiredDescription
IncompleteUpliftRequestIdqueryGuidNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
IncompleteUpliftRequestFromServerResponse Parameters:
NameParameterData TypeRequiredDescription
UpliftRequestDataformUpliftRequestDataYes
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusYes
UpliftRequestData Parameters:
NameParameterData TypeRequiredDescription
UpliftRequestIdformintNo
IdformGuidNo
OutletIdformintNo
ProductsformList<UpliftRequestProductData>Yes
OutletEmailAddressformstringYes
OutletContactNameformstringYes
OutletChannelformstringYes
OutletRegionformstringYes
AdditionalNotesformstringYes
MerchandiserSignatureImageformObjectYes
StartTimeformstringYes
StartLatitudeformdoubleNo
StartLongitudeformdoubleNo
EndTimeformstringYes
EndLatitudeformdoubleNo
EndLongitudeformdoubleNo
LastUpdatedformDateTimeNo
LastSyncedformDateTimeNo
IncompleteUpliftRequestIdformstringYes
AuthRequestIdformGuidNo
AuthorisedformboolNo
PrincipalIdformintNo
SealsformList<SealData>Yes
ConfirmedformboolNo
CancelledformboolNo
ImagesformList<Object>Yes
SubmitImmediatelyformboolNo
UpliftRequestProductData Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
UpliftRequestProductIdformintNo
ProductIdformintNo
PrincipalIdformintNo
UnitPriceformdecimalNo
NameformstringYes
CategoryformstringYes
UnitBarcodeformstringYes
UnitSizeformstringYes
UnitWeightformdecimalNo
CodeformstringYes
ImagesformList<Object>Yes
QuantityformdoubleNo
ValueformdecimalNo
ProductionDateformstringYes
ExpiryDateformstringYes
BatchCodeformstringYes
SealformSealDataYes
SerialNumberformstringYes
StockStatusIdformintNo
PrincipalLogoUrlformstringYes
PrincipalNameformstringYes
StockStatusNameformstringYes
StockStatusColorformstringYes
UnitOfMeasureIdformintNo
Seal Parameters:
NameParameterData TypeRequiredDescription
NumberformstringNo
WeightformdoubleNo

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.

GET /sync/incompleteupliftrequest HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"UpliftRequestData":{"UpliftRequestId":0,"OutletId":0,"Products":[{"UpliftRequestProductId":0,"ProductId":0,"PrincipalId":0,"UnitPrice":0,"Name":"String","Category":"String","UnitBarcode":"String","UnitSize":"String","UnitWeight":0,"Code":"String","Images":[{}],"Quantity":0,"Value":0,"ProductionDate":"String","ExpiryDate":"String","BatchCode":"String","Seal":{"Number":"String","Weight":0},"SerialNumber":"String","StockStatusId":0,"PrincipalLogoUrl":"String","PrincipalName":"String","StockStatusName":"String","StockStatusColor":"String","UnitOfMeasureId":0}],"OutletEmailAddress":"String","OutletContactName":"String","OutletChannel":"String","OutletRegion":"String","AdditionalNotes":"String","MerchandiserSignatureImage":{},"StartTime":"String","StartLatitude":0,"StartLongitude":0,"EndTime":"String","EndLatitude":0,"EndLongitude":0,"LastUpdated":"0001-01-01T00:00:00.0000000","LastSynced":"0001-01-01T00:00:00.0000000","IncompleteUpliftRequestId":"String","Authorised":false,"PrincipalId":0,"Seals":[{"Number":"String","Weight":0}],"Confirmed":false,"Cancelled":false,"Images":[{}],"SubmitImmediately":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"}}}