| GET | /api/ECommerceOrderStatus |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderNumber | query | string | No | |
| OrderType | query | string | No | 3 is 3rd Party, C is AIMStoreFront, E is Ebay, A is Amazon, B is Excel Import, R is Reverb, G is Gunbroker, M is Ammoready. Defaults to 3 |
| 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 |
|---|---|---|---|---|
| OrderStatus | form | string | No | |
| OrderStatusDescription | form | string | No | |
| LineItems | form | List<ECommerceOrderLineItem> | No | |
| ShippingInfo | form | List<ECommerceOrderShippingInfo> | 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 | |
| Quantity | form | decimal | No | |
| ItemStatus | form | string | No | |
| ShipmentId | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ShipmentId | form | int | No | |
| ShipVia | form | string | No | |
| TrackingNumbers | form | List<string> | 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.
GET /api/ECommerceOrderStatus HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ECommerceOrderStatusResponse 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>
<LineItems>
<ECommerceOrderLineItem>
<ItemStatus>String</ItemStatus>
<Quantity>0</Quantity>
<ShipmentId>0</ShipmentId>
<Sku>String</Sku>
</ECommerceOrderLineItem>
</LineItems>
<OrderStatus>String</OrderStatus>
<OrderStatusDescription>String</OrderStatusDescription>
<ShippingInfo>
<ECommerceOrderShippingInfo>
<ShipVia>String</ShipVia>
<ShipmentId>0</ShipmentId>
<TrackingNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</TrackingNumbers>
</ECommerceOrderShippingInfo>
</ShippingInfo>
</ECommerceOrderStatusResponse>