| POST | /api/CustomerOrders |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Orders | body | List<ThirdPartyOrder> | 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 |
|---|---|---|---|---|
| OrderNumber | form | string | No | |
| OrderDate | form | DateTime | No | |
| TransactionState | form | string | No | |
| PaymentMethod | form | string | No | |
| OrderNotes | form | string | No | |
| AuthorizationCode | form | string | No | |
| ShippingMethod | form | string | No | |
| Total | form | decimal | No | |
| SubTotal | form | decimal | No | |
| TaxTotal | form | decimal | No | |
| ShippingTotal | form | decimal | No | |
| CardType | form | string | No | |
| CardToken | form | string | No | |
| CardSpan | form | string | No | |
| CardExpirationMonth | form | string | No | |
| CardExpirationYear | form | string | No | |
| CustomerAcct | form | int | No | |
| form | string | No | ||
| PO | form | string | No | |
| EmployeeUsername | form | string | No | |
| AeOnApprovalOrderSubtotal | form | decimal | No | |
| AeOnApprovalOrderShipping | form | decimal | No | |
| ShippingAttn | form | string | No | |
| ShippingName | form | string | No | |
| ShippingFirstName | form | string | No | |
| ShippingLastName | form | string | No | |
| ShippingCompany | form | string | No | |
| ShippingAddr1 | form | string | No | |
| ShippingAddr2 | form | string | No | |
| ShippingCity | form | string | No | |
| ShippingSt | form | string | No | |
| ShippingZip | form | string | No | |
| ShippingCountry | form | string | No | |
| ShippingPhone | form | string | No | |
| BillingAttn | form | string | No | |
| BillingName | form | string | No | |
| BillingFirstName | form | string | No | |
| BillingLastName | form | string | No | |
| BillingCompany | form | string | No | |
| BillingAddr1 | form | string | No | |
| BillingAddr2 | form | string | No | |
| BillingCity | form | string | No | |
| BillingSt | form | string | No | |
| BillingZip | form | string | No | |
| BillingCountry | form | string | No | |
| BillingPhone | form | string | No | |
| OrderSource | form | string | No | |
| CardName | form | string | No | |
| PnRef | form | string | No | |
| LineItems | form | List<ThirdPartyOrderItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProductName | form | string | No | |
| Sku | form | string | No | |
| SerialNumber | form | string | No | |
| WebNumber | form | string | No | |
| Location | form | string | No | |
| Qty | form | decimal | No | |
| QtyPicked | form | decimal | No | |
| UseQtyPicked | form | bool | No | |
| Price | form | decimal | No | |
| OnApproval | form | bool | No | |
| IsECard | form | bool | No | |
| NiCat | form | int? | No | |
| NiSub | form | int? | No | |
| ExtPk | form | long? | 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 |
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/CustomerOrders HTTP/1.1
Host: active-ewebservice.biz
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Orders":[{"OrderNumber":"String","TransactionState":"String","PaymentMethod":"String","OrderNotes":"String","AuthorizationCode":"String","ShippingMethod":"String","Total":0,"SubTotal":0,"TaxTotal":0,"ShippingTotal":0,"CardType":"String","CardToken":"String","CardSpan":"String","CardExpirationMonth":"String","CardExpirationYear":"String","CustomerAcct":0,"Email":"String","PO":"String","EmployeeUsername":"String","AeOnApprovalOrderSubtotal":0,"AeOnApprovalOrderShipping":0,"ShippingAttn":"String","ShippingName":"String","ShippingFirstName":"String","ShippingLastName":"String","ShippingCompany":"String","ShippingAddr1":"String","ShippingAddr2":"String","ShippingCity":"String","ShippingSt":"String","ShippingZip":"String","ShippingCountry":"String","ShippingPhone":"String","BillingAttn":"String","BillingName":"String","BillingFirstName":"String","BillingLastName":"String","BillingCompany":"String","BillingAddr1":"String","BillingAddr2":"String","BillingCity":"String","BillingSt":"String","BillingZip":"String","BillingCountry":"String","BillingPhone":"String","OrderSource":"String","CardName":"String","PnRef":"String","LineItems":[{"ProductName":"String","Sku":"String","SerialNumber":"String","WebNumber":"String","Location":"String","Qty":0,"QtyPicked":0,"UseQtyPicked":false,"Price":0,"OnApproval":false,"IsECard":false,"NiCat":0,"NiSub":0,"ExtPk":0}]}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}