| GET | /api/CustomerOrderFulfillment |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| WebOrder | query | string | No | Pass in if only looking for one weborder. Otherwise do not pass in. |
| StartOffset | query | long? | No | Starting offset for Pagination. Defaults to 0. |
| RecordCount | query | long? | No | Records to be returned. Default to 100. |
| ExcludeFullyPickedOrders | query | bool | No | If sent, fully picked orders will not be returned. |
| 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 |
|---|---|---|---|---|
| WebOrder | form | string | No | |
| CustomerName | form | string | No | |
| DateTime | form | DateTime | No | |
| Items | form | List<CustomerOrderItem> | No | |
| Orders | form | List<CustomerWebOrder> | 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 |
|---|---|---|---|---|
| Id | form | long | No | |
| Item | form | string | No | |
| Description | form | string | No | |
| Price | form | decimal | No | |
| Quantity | form | decimal | No | |
| QuantityPicked | form | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| WebOrder | form | string | No | |
| CustomerName | form | string | No | |
| DateTime | form | DateTime | No | |
| Items | form | List<CustomerOrderItem> | 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.
GET /api/CustomerOrderFulfillment HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"WebOrder":"String","CustomerName":"String","Items":[{"Id":0,"Item":"String","Description":"String","Price":0,"Quantity":0,"QuantityPicked":0}],"Orders":[{"WebOrder":"String","CustomerName":"String","Items":[{"Id":0,"Item":"String","Description":"String","Price":0,"Quantity":0,"QuantityPicked":0}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}