| POST, GET | /api/InventoryQty |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Pk | body | long? | No | |
| Model | body | string | No | |
| AeId | body | string | No | |
| SkuPk | body | long? | No | |
| Sku | body | string | No | |
| SendVendorQtyAsSeperateLocation | body | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | Header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | Header | string | Yes | The OAuthToken token return by AeServices30 |
| DeviceId | Header | string | No | The Device ID of the Mobile Device. Not used for non-mobile devices. |
| AppId | Header | string | Yes | An identifier for your integration |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Variants | form | List<InventoryQtyByVariant> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | body | BaseResponseResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCode | body | string | No | |
| Login | body | string | No | |
| ErrorCode | body | string | No | |
| ErrorDisplayText | body | string | No | |
| ErrorMessage | body | string | No | |
| DomainName | body | string | No | |
| IpAddress | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Sku | form | string | No | |
| AeVariantName | form | string | No | |
| Locations | form | List<InventoryQtyByLocation> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LocationInfo | form | LocationInfo | No | |
| QtyAvail | form | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Desc | form | string | No | |
| ShortDesc | form | string | No | |
| Region | form | string | No | |
| Latitude | form | decimal | No | |
| Longitude | form | decimal | No | |
| InStorePickup | form | string | No | |
| Active | form | bool | No | |
| CashSaleAcct | form | int? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/InventoryQty HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<InventoryQtyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<AppId>String</AppId>
<DeviceId>String</DeviceId>
<OAuthToken>String</OAuthToken>
<AeId>String</AeId>
<Model>String</Model>
<Pk>0</Pk>
<SendVendorQtyAsSeperateLocation>false</SendVendorQtyAsSeperateLocation>
<Sku>String</Sku>
<SkuPk>0</SkuPk>
</InventoryQtyRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<InventoryQtyResponse 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>
<Variants>
<InventoryQtyResponse.InventoryQtyByVariant i:nil="true" />
</Variants>
</InventoryQtyResponse>