| GET | /api/GetActiveE3Party |
|---|
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 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 InventoryAttribute:
name: Optional[str] = None
value: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SerialItem:
sas_pk: int = 0
serial: Optional[str] = None
retail: Decimal = decimal.Decimal(0)
our_price: Decimal = decimal.Decimal(0)
sale_price: Optional[Decimal] = None
a_e__sale__price: Decimal = decimal.Decimal(0)
status: Optional[str] = None
sale_info: Optional[str] = None
price_a: Decimal = decimal.Decimal(0)
price_b: Decimal = decimal.Decimal(0)
price_c: Decimal = decimal.Decimal(0)
min_price: Decimal = decimal.Decimal(0)
notes: Optional[str] = None
source: Optional[str] = None
attributes: Optional[List[InventoryAttribute]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QtyByLoc:
location: Optional[str] = None
quantity: Decimal = decimal.Decimal(0)
locator_code: Optional[str] = None
serial_items: Optional[List[SerialItem]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ActiveE3Party:
model: Optional[str] = None
sku: Optional[str] = None
web_number: Optional[str] = None
desc: Optional[str] = None
mfg: Optional[str] = None
# @ApiMember(DataType="string", Description="S is serialized, T is Title/Media, A is all other Accessories, P is packages, N is Non-Inventory", Name="Type")
type: Optional[str] = None
"""
S is serialized, T is Title/Media, A is all other Accessories, P is packages, N is Non-Inventory
"""
barcode: Optional[str] = None
barcode_list: Optional[List[str]] = None
selcode: Optional[str] = None
color: Optional[str] = None
size: Optional[str] = None
web__cat_1: Optional[str] = None
web__cat_2: Optional[str] = None
web__cat_3: Optional[str] = None
web__cat_4: Optional[str] = None
url: Optional[str] = None
image__small: Optional[str] = None
image__medium: Optional[str] = None
web__desc: Optional[str] = None
ebay_cat1: Optional[str] = None
ebay_cat2: Optional[str] = None
ebay_storecat1: Optional[str] = None
ebay_storecat2: Optional[str] = None
ebay_title: Optional[str] = None
ebay_subtitle: Optional[str] = None
ebay_desc: Optional[str] = None
ebay_template: Optional[str] = None
ebay_duration: Optional[str] = None
ebay_format: Optional[str] = None
ebay_paypreset: Optional[str] = None
ebay_shippreset: Optional[str] = None
ebay_shipdest: Optional[str] = None
ebay_image1: Optional[str] = None
ebay_image2: Optional[str] = None
ebay_image3: Optional[str] = None
ebay_image4: Optional[str] = None
ebay_image5: Optional[str] = None
ebay_image6: Optional[str] = None
ebay_image7: Optional[str] = None
ebay_image8: Optional[str] = None
ebay_image9: Optional[str] = None
ebay_image10: Optional[str] = None
ebay_image11: Optional[str] = None
ebay_image12: Optional[str] = None
ebay_image13: Optional[str] = None
ebay_image14: Optional[str] = None
ebay_image15: Optional[str] = None
ebay_image16: Optional[str] = None
ebay_image17: Optional[str] = None
ebay_image18: Optional[str] = None
ebay_image19: Optional[str] = None
ebay_image20: Optional[str] = None
ebay_image21: Optional[str] = None
ebay_image22: Optional[str] = None
ebay_image23: Optional[str] = None
ebay_image24: Optional[str] = None
product_code: Optional[str] = None
dimension: Optional[str] = None
restricted__qtys: Optional[str] = None
related__products: Optional[str] = None
upsell__products: Optional[str] = None
requires__products: Optional[str] = None
image__large: Optional[str] = None
audio__u_r_l: Optional[str] = None
mpn: Optional[str] = None
composer: Optional[str] = None
arranger: Optional[str] = None
artist: Optional[str] = None
voicing: Optional[str] = None
level: Optional[str] = None
sample__u_r_l: Optional[str] = None
toc: Optional[str] = None
s_e_desc: Optional[str] = None
s_e_keywords: Optional[str] = None
s_e_title: Optional[str] = None
notes: Optional[str] = None
invoice__notes: Optional[str] = None
po_s__reminder: Optional[str] = None
location_qtys: Optional[List[QtyByLoc]] = None
location_qtys: Optional[str] = None
webcat_child1: Optional[str] = None
webcat_child2: Optional[str] = None
webcat_child3: Optional[str] = None
webcat_child4: Optional[str] = None
qty: Decimal = decimal.Decimal(0)
qty__available: Decimal = decimal.Decimal(0)
cost: Decimal = decimal.Decimal(0)
our__price: Decimal = decimal.Decimal(0)
retail: Decimal = decimal.Decimal(0)
min__price: Decimal = decimal.Decimal(0)
price__a: Decimal = decimal.Decimal(0)
price__b: Decimal = decimal.Decimal(0)
price__c: Decimal = decimal.Decimal(0)
a_e__sale__price: Decimal = decimal.Decimal(0)
weight: Decimal = decimal.Decimal(0)
ebay_qty: Decimal = decimal.Decimal(0)
ebay_start: Decimal = decimal.Decimal(0)
ebay_reserve: Decimal = decimal.Decimal(0)
ebay_buyitnow: Decimal = decimal.Decimal(0)
w_cost: Decimal = decimal.Decimal(0)
margin__perc: Decimal = decimal.Decimal(0)
ebay_length: int = 0
ebay_width: int = 0
ebay_depth: int = 0
ebay_wtmajor: int = 0
ebay_wtminor: int = 0
ebay: bool = False
web: bool = False
published: bool = False
approval: bool = False
call__to__order: bool = False
discontinued: bool = False
sell_serials_online: bool = False
last_updated: datetime.datetime = datetime.datetime(1, 1, 1)
inventory_attributes: Optional[List[InventoryAttribute]] = None
ext_pk: int = 0
aim_categorization: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetActiveE3PartyResponse(BaseResponse):
start_offset: int = 0
record_count: int = 0
records: Optional[List[ActiveE3Party]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetActiveE3PartyRequest(BaseRequest):
"""
GetActiveE3PartyRequires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce
"""
start_offset: Optional[int] = None
record_count: Optional[int] = None
# @ApiMember(DataType="string", Description="Inventory, Packages, or NI. Defaults to Inventory.", Name="InventoryType", ParameterType="query")
inventory_type: Optional[str] = None
"""
Inventory, Packages, or NI. Defaults to Inventory.
"""
# @ApiMember(DataType="string", Description="Only Items in the sent WebCategory will be returned", Name="WebCategory", ParameterType="query")
web_category: Optional[str] = None
"""
Only Items in the sent WebCategory will be returned
"""
# @ApiMember(DataType="string", Description="If sent, only grab 3 Party Feed records updated after the date passed.", Format="date", Name="Date", ParameterType="query")
date: Optional[datetime.datetime] = None
"""
If sent, only grab 3 Party Feed records updated after the date passed.
"""
# @ApiMember(DataType="string", Description="If sent, only the SKU sent will be returned", Name="Sku", ParameterType="query")
sku: Optional[str] = None
"""
If sent, only the SKU sent will be returned
"""
include_attributes: Optional[bool] = None
Python GetActiveE3PartyRequest DTOs
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/GetActiveE3Party HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetActiveE3PartyResponse 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>
<RecordCount>0</RecordCount>
<Records xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM.BL.Core.Misc">
<d2p1:ActiveE3Party>
<d2p1:AE_Sale_Price>0</d2p1:AE_Sale_Price>
<d2p1:AIMCategorization>String</d2p1:AIMCategorization>
<d2p1:Approval>false</d2p1:Approval>
<d2p1:Arranger>String</d2p1:Arranger>
<d2p1:Artist>String</d2p1:Artist>
<d2p1:Audio_URL>String</d2p1:Audio_URL>
<d2p1:Barcode>String</d2p1:Barcode>
<d2p1:BarcodeList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:BarcodeList>
<d2p1:Call_To_Order>false</d2p1:Call_To_Order>
<d2p1:Color>String</d2p1:Color>
<d2p1:Composer>String</d2p1:Composer>
<d2p1:Cost>0</d2p1:Cost>
<d2p1:Desc>String</d2p1:Desc>
<d2p1:Dimension>String</d2p1:Dimension>
<d2p1:Discontinued>false</d2p1:Discontinued>
<d2p1:Ebay>false</d2p1:Ebay>
<d2p1:Ebay_buyitnow>0</d2p1:Ebay_buyitnow>
<d2p1:Ebay_cat1>String</d2p1:Ebay_cat1>
<d2p1:Ebay_cat2>String</d2p1:Ebay_cat2>
<d2p1:Ebay_depth>0</d2p1:Ebay_depth>
<d2p1:Ebay_desc>String</d2p1:Ebay_desc>
<d2p1:Ebay_duration>String</d2p1:Ebay_duration>
<d2p1:Ebay_format>String</d2p1:Ebay_format>
<d2p1:Ebay_image1>String</d2p1:Ebay_image1>
<d2p1:Ebay_image10>String</d2p1:Ebay_image10>
<d2p1:Ebay_image11>String</d2p1:Ebay_image11>
<d2p1:Ebay_image12>String</d2p1:Ebay_image12>
<d2p1:Ebay_image13>String</d2p1:Ebay_image13>
<d2p1:Ebay_image14>String</d2p1:Ebay_image14>
<d2p1:Ebay_image15>String</d2p1:Ebay_image15>
<d2p1:Ebay_image16>String</d2p1:Ebay_image16>
<d2p1:Ebay_image17>String</d2p1:Ebay_image17>
<d2p1:Ebay_image18>String</d2p1:Ebay_image18>
<d2p1:Ebay_image19>String</d2p1:Ebay_image19>
<d2p1:Ebay_image2>String</d2p1:Ebay_image2>
<d2p1:Ebay_image20>String</d2p1:Ebay_image20>
<d2p1:Ebay_image21>String</d2p1:Ebay_image21>
<d2p1:Ebay_image22>String</d2p1:Ebay_image22>
<d2p1:Ebay_image23>String</d2p1:Ebay_image23>
<d2p1:Ebay_image24>String</d2p1:Ebay_image24>
<d2p1:Ebay_image3>String</d2p1:Ebay_image3>
<d2p1:Ebay_image4>String</d2p1:Ebay_image4>
<d2p1:Ebay_image5>String</d2p1:Ebay_image5>
<d2p1:Ebay_image6>String</d2p1:Ebay_image6>
<d2p1:Ebay_image7>String</d2p1:Ebay_image7>
<d2p1:Ebay_image8>String</d2p1:Ebay_image8>
<d2p1:Ebay_image9>String</d2p1:Ebay_image9>
<d2p1:Ebay_length>0</d2p1:Ebay_length>
<d2p1:Ebay_paypreset>String</d2p1:Ebay_paypreset>
<d2p1:Ebay_qty>0</d2p1:Ebay_qty>
<d2p1:Ebay_reserve>0</d2p1:Ebay_reserve>
<d2p1:Ebay_shipdest>String</d2p1:Ebay_shipdest>
<d2p1:Ebay_shippreset>String</d2p1:Ebay_shippreset>
<d2p1:Ebay_start>0</d2p1:Ebay_start>
<d2p1:Ebay_storecat1>String</d2p1:Ebay_storecat1>
<d2p1:Ebay_storecat2>String</d2p1:Ebay_storecat2>
<d2p1:Ebay_subtitle>String</d2p1:Ebay_subtitle>
<d2p1:Ebay_template>String</d2p1:Ebay_template>
<d2p1:Ebay_title>String</d2p1:Ebay_title>
<d2p1:Ebay_width>0</d2p1:Ebay_width>
<d2p1:Ebay_wtmajor>0</d2p1:Ebay_wtmajor>
<d2p1:Ebay_wtminor>0</d2p1:Ebay_wtminor>
<d2p1:ExtPk>0</d2p1:ExtPk>
<d2p1:Image_Large>String</d2p1:Image_Large>
<d2p1:Image_Medium>String</d2p1:Image_Medium>
<d2p1:Image_Small>String</d2p1:Image_Small>
<d2p1:InventoryAttributes i:nil="true" />
<d2p1:Invoice_Notes>String</d2p1:Invoice_Notes>
<d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated>
<d2p1:Level>String</d2p1:Level>
<d2p1:LocationQtys i:nil="true" />
<d2p1:Location_qtys>String</d2p1:Location_qtys>
<d2p1:MPN>String</d2p1:MPN>
<d2p1:Margin_Perc>0</d2p1:Margin_Perc>
<d2p1:Mfg>String</d2p1:Mfg>
<d2p1:Min_Price>0</d2p1:Min_Price>
<d2p1:Model>String</d2p1:Model>
<d2p1:Notes>String</d2p1:Notes>
<d2p1:Our_Price>0</d2p1:Our_Price>
<d2p1:POS_Reminder>String</d2p1:POS_Reminder>
<d2p1:Price_A>0</d2p1:Price_A>
<d2p1:Price_B>0</d2p1:Price_B>
<d2p1:Price_C>0</d2p1:Price_C>
<d2p1:ProductCode>String</d2p1:ProductCode>
<d2p1:Published>false</d2p1:Published>
<d2p1:Qty>0</d2p1:Qty>
<d2p1:Qty_Available>0</d2p1:Qty_Available>
<d2p1:Related_Products>String</d2p1:Related_Products>
<d2p1:Requires_Products>String</d2p1:Requires_Products>
<d2p1:Restricted_Qtys>String</d2p1:Restricted_Qtys>
<d2p1:Retail>0</d2p1:Retail>
<d2p1:SE_desc>String</d2p1:SE_desc>
<d2p1:SE_keywords>String</d2p1:SE_keywords>
<d2p1:SE_title>String</d2p1:SE_title>
<d2p1:Sample_URL>String</d2p1:Sample_URL>
<d2p1:Selcode>String</d2p1:Selcode>
<d2p1:SellSerialsOnline>false</d2p1:SellSerialsOnline>
<d2p1:Size>String</d2p1:Size>
<d2p1:Sku>String</d2p1:Sku>
<d2p1:TOC>String</d2p1:TOC>
<d2p1:Type>String</d2p1:Type>
<d2p1:URL>String</d2p1:URL>
<d2p1:Upsell_Products>String</d2p1:Upsell_Products>
<d2p1:Voicing>String</d2p1:Voicing>
<d2p1:WCost>0</d2p1:WCost>
<d2p1:Web>false</d2p1:Web>
<d2p1:WebNumber>String</d2p1:WebNumber>
<d2p1:Web_Cat_1>String</d2p1:Web_Cat_1>
<d2p1:Web_Cat_2>String</d2p1:Web_Cat_2>
<d2p1:Web_Cat_3>String</d2p1:Web_Cat_3>
<d2p1:Web_Cat_4>String</d2p1:Web_Cat_4>
<d2p1:Web_Desc>String</d2p1:Web_Desc>
<d2p1:WebcatChild1>String</d2p1:WebcatChild1>
<d2p1:WebcatChild2>String</d2p1:WebcatChild2>
<d2p1:WebcatChild3>String</d2p1:WebcatChild3>
<d2p1:WebcatChild4>String</d2p1:WebcatChild4>
<d2p1:Weight>0</d2p1:Weight>
</d2p1:ActiveE3Party>
</Records>
<StartOffset>0</StartOffset>
</GetActiveE3PartyResponse>