| 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 | The Login Token return by the Security API. Required for secured calls. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | Header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | Header | string | Yes | The OAuthToken token return by AeServices30 |
| DeviceId | Header | string | No | The Device ID of the Mobile Device. Not used for non-mobile devices. |
| AppId | Header | string | Yes | An identifier for your integration |
| 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 .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/CustomerOrderFulfillment HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CustomerOrderFulfillmentResponse 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>
<CustomerName>String</CustomerName>
<DateTime>0001-01-01T00:00:00</DateTime>
<Items>
<CustomerOrderItem>
<Description>String</Description>
<Id>0</Id>
<Item>String</Item>
<Price>0</Price>
<Quantity>0</Quantity>
<QuantityPicked>0</QuantityPicked>
</CustomerOrderItem>
</Items>
<Orders>
<CustomerWebOrder>
<CustomerName>String</CustomerName>
<DateTime>0001-01-01T00:00:00</DateTime>
<Items>
<CustomerOrderItem>
<Description>String</Description>
<Id>0</Id>
<Item>String</Item>
<Price>0</Price>
<Quantity>0</Quantity>
<QuantityPicked>0</QuantityPicked>
</CustomerOrderItem>
</Items>
<WebOrder>String</WebOrder>
</CustomerWebOrder>
</Orders>
<WebOrder>String</WebOrder>
</CustomerOrderFulfillmentResponse>