Antel Merchandiser App API

<back to all web services

UpliftRequestAuthRequest

Requires Authentication
The following routes are available for this service:
POST/upliftrequest/auth
UpliftRequestAuthRequest Parameters:
NameParameterData TypeRequiredDescription
UpliftRequestOnDeviceIdbodyGuidNo
OutletIdbodyintNo
PrincipalIdbodyintNo
TotalValuebodydecimalNo
TotalUnitsbodydoubleNo
RegionbodystringYes
ChannelbodystringYes
ProductsbodyList<UpliftRequestProductData>Yes
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
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
UpliftRequestAuthRequestResponse Parameters:
NameParameterData TypeRequiredDescription
UpliftRequestAuthRequestIdformGuidNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusYes

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.

POST /upliftrequest/auth HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"OutletId":0,"PrincipalId":0,"TotalValue":0,"TotalUnits":0,"Region":"String","Channel":"String","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}],"ApiKey":"String","Latitude":0,"Longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"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"}}}