AIM Web Services

SaleInfoRequest

SaleInfo
Requires active-e Inventory Service

The following routes are available for this service:
GET	/api/SaleInfo

**SaleInfoRequest** Parameters:
Name	Parameter	Data Type	Required	Description
LocationId	query	long?	No
DateTime	query	DateTime?	No	If sent, only sales that are active during the sent Date/Time are returned. Otherwise, the current Date/Time is used

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required
Token	Header	string	No
DeviceId	Header	string	No
AppId	Header	string	Yes

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	header	string	No

**SaleInfoResponse** Parameters:
Name	Parameter	Data Type	Required	Description
SaleRecords	form	List<SaleRecord>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
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

**SaleRecord** Parameters:
Name	Parameter	Data Type	Required
SadPk	form	long	No
SkuPk	form	long	No
SaqPk	form	long	No
Model	form	string	No
SKU	form	string	No
LocationId	form	long	No
StartDate	form	DateTime	No
EndDate	form	DateTime	No
CustomerAccount	form	int?	No
CustomerDefaultId	form	long?	No
Condition	form	string	No
DiscountFromPriceLevel	form	DiscountFromPriceLevel	No
DiscountByPriceLevel	form	string	No
DiscountBySetPrice	form	decimal?	No
DiscountByAmount	form	decimal?	No
RecurringSale	form	RecurringSaleInfo	No

**DiscountFromPriceLevel** Parameters:
Name	Parameter	Data Type	Required	Description
BasePriceLevel	form	string	No
DisountPercentage	form	decimal	No

**RecurringSaleInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Days	form	List<RecurringSaleDay>	No

**RecurringSaleDay** Parameters:
Name	Parameter	Data Type	Required
Weekday	form	string	No
BeginHour	form	int	No
BeginMinute	form	int	No
EndHour	form	int	No
EndMinute	form	int	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/SaleInfo HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SaleInfoResponse 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>
  <SaleRecords>
    <SaleRecord>
      <Condition>String</Condition>
      <CustomerAccount>0</CustomerAccount>
      <CustomerDefaultId>0</CustomerDefaultId>
      <DiscountByAmount>0</DiscountByAmount>
      <DiscountByPriceLevel>String</DiscountByPriceLevel>
      <DiscountBySetPrice>0</DiscountBySetPrice>
      <DiscountFromPriceLevel>
        <BasePriceLevel>String</BasePriceLevel>
        <DisountPercentage>0</DisountPercentage>
      </DiscountFromPriceLevel>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <LocationId>0</LocationId>
      <Model>String</Model>
      <RecurringSale>
        <Days>
          <RecurringSaleDay>
            <BeginHour>0</BeginHour>
            <BeginMinute>0</BeginMinute>
            <EndHour>0</EndHour>
            <EndMinute>0</EndMinute>
            <Weekday>String</Weekday>
          </RecurringSaleDay>
        </Days>
      </RecurringSale>
      <SKU>String</SKU>
      <SadPk>0</SadPk>
      <SaqPk>0</SaqPk>
      <SkuPk>0</SkuPk>
      <StartDate>0001-01-01T00:00:00</StartDate>
    </SaleRecord>
  </SaleRecords>
</SaleInfoResponse>

AIM Web Services

SaleInfoRequest

SaleInfo Requires active-e Inventory Service

HTTP + XML

SaleInfo
Requires active-e Inventory Service