POST | /api/StockCheck |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Items | body | List<StockCheckItem> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
OAuthToken | header | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SKU | form | string | No | |
LocationId | form | long? | No | |
SerialNumber | form | string | No | |
QtyRequested | form | decimal? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EverythingAvailable | form | bool | No | |
OutOfStockItems | form | List<StockCheckErrorItem> | 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 | |
LocationId | form | long? | No | |
SerialNumber | form | string | No | |
QtyRequested | form | decimal? | No | |
Message | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/StockCheck HTTP/1.1
Host: active-ewebservice.biz
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Items":[{"SKU":"String","LocationId":0,"SerialNumber":"String","QtyRequested":0}],"ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"EverythingAvailable":false,"OutOfStockItems":[{"SKU":"String","LocationId":0,"SerialNumber":"String","QtyRequested":0,"Message":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}