AIM Web Services

<back to all web services

EditInventoryRequest

EditInventory
Requires active-e Inventory Service

The following routes are available for this service:
POST/api/EditInventory
EditInventoryRequest Parameters:
NameParameterData TypeRequiredDescription
SaqPkbodylong?No
SasPkbodylong?No
DescriptionbodystringNo
OurPricebodydecimal?No
RetailPricebodydecimal?No
PriceAbodydecimal?No
PriceBbodydecimal?No
PriceCbodydecimal?No
MinPricebodydecimal?No
LocatorbodystringNo
UpdateAllLocationsbodyboolNo
BarcodesbodyList<string>NoList of Barcodes. If barcodes are sent, they will overwrite existing barcodes.
NewComputerQuantitybodydecimal?No
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo

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

HTTP + XML

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

POST /api/EditInventory HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EditInventoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <Barcodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Barcodes>
  <Description>String</Description>
  <Locator>String</Locator>
  <MinPrice>0</MinPrice>
  <NewComputerQuantity>0</NewComputerQuantity>
  <OurPrice>0</OurPrice>
  <PriceA>0</PriceA>
  <PriceB>0</PriceB>
  <PriceC>0</PriceC>
  <RetailPrice>0</RetailPrice>
  <SaqPk>0</SaqPk>
  <SasPk>0</SasPk>
  <UpdateAllLocations>false</UpdateAllLocations>
</EditInventoryRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EditInventoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
</EditInventoryResponse>