AIM Web Services

<back to all web services

SerialDetailRequest

SerialDetail
Requires active-e Inventory Service

The following routes are available for this service:
POST, GET/api/SerialDetail
SerialDetailRequest Parameters:
NameParameterData TypeRequiredDescription
PkqueryintegerNoThe PK being used for lookup. Do not use if Serial is passed in.
SerialquerystringNoThe Serial# being used for lookup. Do not use if Pk is passed in.
SkipImagesbodyboolNo
CustomerAcctqueryintegerNoIf sent, the Customer Acct will be used for customer specific pricing.
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNoThe Login Token return by the Security API. Required for secured calls.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyHeaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenHeaderstringYesThe OAuthToken token return by AeServices30
DeviceIdHeaderstringNoThe Device ID of the Mobile Device. Not used for non-mobile devices.
AppIdHeaderstringYesAn identifier for your integration
SerialDetailResponse Parameters:
NameParameterData TypeRequiredDescription
SasPkformlongNo
SerialformstringNo
SaqPkformlongNo
LocPkformlongNo
LocationformstringNo
SkuPkformlongNo
SKUformstringNo
SadPkformlongNo
ModelformstringNo
DetailsformInventoryDetailBySerialNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
InventoryDetailBySerial Parameters:
NameParameterData TypeRequiredDescription
SasPkformlongNo
SerialformstringNo
RetailformdecimalNo
OurPriceformdecimalNo
SalePriceformdecimal?No
StatusformstringNo
SaleInfoformstringNo
PriceAformdecimalNo
PriceBformdecimalNo
PriceCformdecimalNo
MinPriceformdecimalNo
ActiveEPriceformdecimalNo
AllowPriceChangeformboolNo
Costformdecimal?No
WeightedCostformdecimal?No
NotesformstringNo
AttributesformList<InventoryDetailAttribute>No
ImagesformList<ImageInfo>No
HasImagesformboolNo
IsActiveeHoldbackformboolNo
CustomerAcctformint?No
AvailableForSTRformboolNo
InventoryDetailAttribute Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
PriorityformintNo
WebTypequeryintNo1 is 'Don't Send to Web', 2 is 'Send To Web'
ImageInfo Parameters:
NameParameterData TypeRequiredDescription
UrlformstringNo
ImageStreamformstringNo
ImageSizeformstringNo
ErrorMessageformstringNo
UriPkformlong?No

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 /api/SerialDetail HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Pk":0,"Serial":"String","SkipImages":false,"CustomerAcct":0,"Token":"String","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"SasPk":0,"Serial":"String","SaqPk":0,"LocPk":0,"Location":"String","SkuPk":0,"SKU":"String","SadPk":0,"Model":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}