AIM Web Services

<back to all web services

InventoryAutoPriceRequest

InventoryAutoPrice
Requires active-e Inventory Service

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

// @DataContract
export class BaseRequest
{
    /** @description This is your AIM API Key provided by Tri-Tech */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")
    public ApiKey: string;

    /** @description The OAuthToken token return by AeServices30 */
    // @DataMember
    // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    public OAuthToken: string;

    /** @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

    /** @description An identifier for your integration */
    // @DataMember
    // @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description The Login Token return by the Security API. Required for secured calls. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    public Token: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AutoPriceRecord
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Description: string;

    // @DataMember
    public Category?: number;

    // @DataMember
    public CategoryDescription: string;

    // @DataMember
    public SubCategory?: number;

    // @DataMember
    public SubCategoryDescription: string;

    // @DataMember
    public Vendor?: number;

    // @DataMember
    public VendorName: string;

    public constructor(init?: Partial<AutoPriceRecord>) { (Object as any).assign(this, init); }
}

// @DataContract
export class InventoryAutoPriceResponse extends BaseResponse
{
    // @DataMember
    public AutoPriceRecords: AutoPriceRecord[];

    // @DataMember
    public MinimumPrice?: number;

    // @DataMember
    public PriceA?: number;

    // @DataMember
    public PriceB?: number;

    // @DataMember
    public PriceC?: number;

    // @DataMember
    public OurPrice?: number;

    public constructor(init?: Partial<InventoryAutoPriceResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description InventoryAutoPriceRequires active-e Inventory Service */
// @DataContract
export class InventoryAutoPriceRequest extends BaseSecureRequest
{
    // @DataMember
    public Category?: number;

    // @DataMember
    public SubCategory?: number;

    // @DataMember
    public Vendor?: number;

    // @DataMember
    public AutoPriceId?: number;

    // @DataMember
    public MinimumPrice: number;

    // @DataMember
    public PriceA: number;

    // @DataMember
    public PriceB: number;

    // @DataMember
    public PriceC: number;

    // @DataMember
    public OurPrice: number;

    // @DataMember
    public RetailPrice: number;

    // @DataMember
    public Cost: number;

    // @DataMember
    public WeightedCost: number;

    // @DataMember
    public VendorNormalCost: number;

    public constructor(init?: Partial<InventoryAutoPriceRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript InventoryAutoPriceRequest DTOs

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/InventoryAutoPrice HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<InventoryAutoPriceResponse 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>
  <AutoPriceRecords>
    <AutoPriceRecord>
      <Category>0</Category>
      <CategoryDescription>String</CategoryDescription>
      <Description>String</Description>
      <Id>0</Id>
      <SubCategory>0</SubCategory>
      <SubCategoryDescription>String</SubCategoryDescription>
      <Vendor>0</Vendor>
      <VendorName>String</VendorName>
    </AutoPriceRecord>
  </AutoPriceRecords>
  <MinimumPrice>0</MinimumPrice>
  <OurPrice>0</OurPrice>
  <PriceA>0</PriceA>
  <PriceB>0</PriceB>
  <PriceC>0</PriceC>
</InventoryAutoPriceResponse>