| POST | /api/ScanForImport |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | body | string | No | |
| Items | body | List<ScanItem> | No | |
| ReceiveInventoryMode | body | bool? | No | |
| AppendMode | body | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | |
| DeviceId | Header | string | No | |
| AppId | Header | string | Yes |
| 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 |
|---|---|---|---|---|
| SkuPk | form | long? | No | |
| SasPk | form | long? | No | |
| Sku | form | string | No | |
| Serial | form | string | No | |
| Quantity | form | decimal | No | |
| ExceptionInfo | form | ExceptionInfo | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Barcode | form | string | No | |
| Description | form | string | No | |
| Base64Image | form | string | No | |
| Category | form | int | No | |
| SubCategory | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ErrorItems | form | List<ScanErrorItem> | 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 |
|---|---|---|---|---|
| SkuPk | form | long? | No | |
| SasPk | form | long? | No | |
| Sku | form | string | No | |
| Serial | form | string | No | |
| Quantity | form | decimal | No | |
| ExceptionInfo | form | ExceptionInfo | No | |
| ErrorMessage | form | string | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/ScanForImport HTTP/1.1
Host: active-ewebservice.biz
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Description":"String","Items":[{"SkuPk":0,"SasPk":0,"Sku":"String","Serial":"String","Quantity":0,"ExceptionInfo":{"Barcode":"String","Description":"String","Base64Image":"String","Category":0,"SubCategory":0}}],"ReceiveInventoryMode":false,"AppendMode":false,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ErrorItems":[{"SkuPk":0,"SasPk":0,"Sku":"String","Serial":"String","Quantity":0,"ExceptionInfo":{"Barcode":"String","Description":"String","Base64Image":"String","Category":0,"SubCategory":0},"ErrorMessage":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}