AIM Web Services

<back to all web services

SaleInfoRequest

SaleInfo
Requires active-e Inventory Service

"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class DiscountFromPriceLevel {
    /** @param {{BasePriceLevel?:string,DisountPercentage?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    BasePriceLevel;
    /** @type {number} */
    DisountPercentage;
}
export class RecurringSaleDay {
    /** @param {{Weekday?:string,BeginHour?:number,BeginMinute?:number,EndHour?:number,EndMinute?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Weekday;
    /** @type {number} */
    BeginHour;
    /** @type {number} */
    BeginMinute;
    /** @type {number} */
    EndHour;
    /** @type {number} */
    EndMinute;
}
export class RecurringSaleInfo {
    /** @param {{Days?:RecurringSaleDay[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {RecurringSaleDay[]} */
    Days;
}
export class SaleRecord {
    /** @param {{SadPk?:number,SkuPk?:number,SaqPk?:number,Model?:string,SKU?:string,LocationId?:number,StartDate?:string,EndDate?:string,CustomerAccount?:number,CustomerDefaultId?:number,Condition?:string,DiscountFromPriceLevel?:DiscountFromPriceLevel,DiscountByPriceLevel?:string,DiscountBySetPrice?:number,DiscountByAmount?:number,RecurringSale?:RecurringSaleInfo}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SadPk;
    /** @type {number} */
    SkuPk;
    /** @type {number} */
    SaqPk;
    /** @type {string} */
    Model;
    /** @type {string} */
    SKU;
    /** @type {number} */
    LocationId;
    /** @type {string} */
    StartDate;
    /** @type {string} */
    EndDate;
    /** @type {?number} */
    CustomerAccount;
    /** @type {?number} */
    CustomerDefaultId;
    /** @type {string} */
    Condition;
    /** @type {DiscountFromPriceLevel} */
    DiscountFromPriceLevel;
    /** @type {string} */
    DiscountByPriceLevel;
    /** @type {?number} */
    DiscountBySetPrice;
    /** @type {?number} */
    DiscountByAmount;
    /** @type {RecurringSaleInfo} */
    RecurringSale;
}
export class SaleInfoResponse extends BaseResponse {
    /** @param {{SaleRecords?:SaleRecord[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {SaleRecord[]} */
    SaleRecords;
}
export class SaleInfoRequest extends BaseSecureRequest {
    /** @param {{LocationId?:number,DateTime?:string,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    LocationId;
    /**
     * @type {?string}
     * @description If sent, only sales that are active during the sent Date/Time are returned. Otherwise, the current Date/Time is used */
    DateTime;
}

JavaScript SaleInfoRequest DTOs

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>