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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseRequest:
    # @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    api_key: Optional[str] = None
    """
    This is your AIM API Key provided by Tri-Tech
    """


    # @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    o_auth_token: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseSecureRequest(BaseRequest):
    # @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    token: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    device_id: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    app_id: Optional[str] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponseResult:
    # @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    status_code: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    login: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    error_code: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    error_display_text: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    error_message: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    domain_name: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    ip_address: Optional[str] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse:
    # @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    status: Optional[BaseResponseResult] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AutoPriceRecord:
    id: int = 0
    description: Optional[str] = None
    category: Optional[int] = None
    category_description: Optional[str] = None
    sub_category: Optional[int] = None
    sub_category_description: Optional[str] = None
    vendor: Optional[int] = None
    vendor_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InventoryAutoPriceResponse(BaseResponse):
    auto_price_records: Optional[List[AutoPriceRecord]] = None
    minimum_price: Optional[Decimal] = None
    price_a: Optional[Decimal] = None
    price_b: Optional[Decimal] = None
    price_c: Optional[Decimal] = None
    our_price: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InventoryAutoPriceRequest(BaseSecureRequest):
    """
    InventoryAutoPriceRequires active-e Inventory Service
    """

    category: Optional[int] = None
    sub_category: Optional[int] = None
    vendor: Optional[int] = None
    auto_price_id: Optional[int] = None
    minimum_price: Decimal = decimal.Decimal(0)
    price_a: Decimal = decimal.Decimal(0)
    price_b: Decimal = decimal.Decimal(0)
    price_c: Decimal = decimal.Decimal(0)
    our_price: Decimal = decimal.Decimal(0)
    retail_price: Decimal = decimal.Decimal(0)
    cost: Decimal = decimal.Decimal(0)
    weighted_cost: Decimal = decimal.Decimal(0)
    vendor_normal_cost: Decimal = decimal.Decimal(0)

Python InventoryAutoPriceRequest DTOs

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

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"AutoPriceRecords":[{"Id":0,"Description":"String","Category":0,"CategoryDescription":"String","SubCategory":0,"SubCategoryDescription":"String","Vendor":0,"VendorName":"String"}],"MinimumPrice":0,"PriceA":0,"PriceB":0,"PriceC":0,"OurPrice":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}