AIM Web Services

<back to all web services

GetPOSTotalsRequest

In development, not yet for public use.

The following routes are available for this service:
POST/api/GetPOSTotals
GetPOSTotalsRequest Parameters:
NameParameterData TypeRequiredDescription
Acctbodyint?No
LocIdbodylong?No
TaxIdbodylong?No
ItemsbodyList<PosLineItem>No
DiscountModequerystringNoMANUAL, BLANKET_PERCENT, BLANKET_AMOUNT, BACK_INTO_TOTAL, or BACK_INTO_TOTAL_WITH_TAX. Defaults to Manual. No line item discounts can be set unless this is MANUAL.
DiscountDetailbodydecimal?No
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
PosLineItem Parameters:
NameParameterData TypeRequiredDescription
SkuPkformlong?No
SasPkformlong?No
SkuformstringNo
SerialformstringNo
QuantityformdecimalNo
ExceptionInfoformExceptionInfoNo
Discountformdecimal?No
NicsCatformint?No
NicsSubformint?No
PriceOverrideformdecimal?No
AllowPriceOverrideToIgnoreMinPriceformboolNo
NotesformstringNo
ExceptionInfo Parameters:
NameParameterData TypeRequiredDescription
BarcodeformstringNo
DescriptionformstringNo
Base64ImageformstringNo
CategoryformintNo
SubCategoryformint?No
GetPOSTotalsResponse Parameters:
NameParameterData TypeRequiredDescription
SubTotalformdecimalNo
TaxTotalformdecimalNo
TotalformdecimalNo
ItemsformList<PosResponseItem>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
PosResponseItem Parameters:
NameParameterData TypeRequiredDescription
PriceEachformdecimalNo
PriceformdecimalNo
DiscountableformboolNo
ErrorMessageformstringNo

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 /api/GetPOSTotals HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Acct":0,"LocId":0,"TaxId":0,"Items":[{"SkuPk":0,"SasPk":0,"Sku":"String","Serial":"String","Quantity":0,"ExceptionInfo":{"Barcode":"String","Description":"String","Base64Image":"String","Category":0,"SubCategory":0},"Discount":0,"NicsCat":0,"NicsSub":0,"PriceOverride":0,"AllowPriceOverrideToIgnoreMinPrice":false,"Notes":"String"}],"DiscountMode":"String","DiscountDetail":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"SubTotal":0,"TaxTotal":0,"Total":0,"Items":[{"PriceEach":0,"Price":0,"Discountable":false,"ErrorMessage":"String","SkuPk":0,"SasPk":0,"Sku":"String","Serial":"String","Quantity":0,"ExceptionInfo":{"Barcode":"String","Description":"String","Base64Image":"String","Category":0,"SubCategory":0},"Discount":0,"NicsCat":0,"NicsSub":0,"PriceOverride":0,"AllowPriceOverrideToIgnoreMinPrice":false,"Notes":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}