| 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
type: Optional[str] = None
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
@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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"StartOffset":0,"RecordCount":0,"Records":[{"Model":"String","Sku":"String","WebNumber":"String","Desc":"String","Mfg":"String","Type":"String","Barcode":"String","BarcodeList":["String"],"Selcode":"String","Color":"String","Size":"String","Web_Cat_1":"String","Web_Cat_2":"String","Web_Cat_3":"String","Web_Cat_4":"String","URL":"String","Image_Small":"String","Image_Medium":"String","Web_Desc":"String","Ebay_cat1":"String","Ebay_cat2":"String","Ebay_storecat1":"String","Ebay_storecat2":"String","Ebay_title":"String","Ebay_subtitle":"String","Ebay_desc":"String","Ebay_template":"String","Ebay_duration":"String","Ebay_format":"String","Ebay_paypreset":"String","Ebay_shippreset":"String","Ebay_shipdest":"String","Ebay_image1":"String","Ebay_image2":"String","Ebay_image3":"String","Ebay_image4":"String","Ebay_image5":"String","Ebay_image6":"String","Ebay_image7":"String","Ebay_image8":"String","Ebay_image9":"String","Ebay_image10":"String","Ebay_image11":"String","Ebay_image12":"String","Ebay_image13":"String","Ebay_image14":"String","Ebay_image15":"String","Ebay_image16":"String","Ebay_image17":"String","Ebay_image18":"String","Ebay_image19":"String","Ebay_image20":"String","Ebay_image21":"String","Ebay_image22":"String","Ebay_image23":"String","Ebay_image24":"String","ProductCode":"String","Dimension":"String","Restricted_Qtys":"String","Related_Products":"String","Upsell_Products":"String","Requires_Products":"String","Image_Large":"String","Audio_URL":"String","MPN":"String","Composer":"String","Arranger":"String","Artist":"String","Voicing":"String","Level":"String","Sample_URL":"String","TOC":"String","SE_desc":"String","SE_keywords":"String","SE_title":"String","Notes":"String","Invoice_Notes":"String","POS_Reminder":"String","Location_qtys":"String","WebcatChild1":"String","WebcatChild2":"String","WebcatChild3":"String","WebcatChild4":"String","Qty":0,"Qty_Available":0,"Cost":0,"Our_Price":0,"Retail":0,"Min_Price":0,"Price_A":0,"Price_B":0,"Price_C":0,"AE_Sale_Price":0,"Weight":0,"Ebay_qty":0,"Ebay_start":0,"Ebay_reserve":0,"Ebay_buyitnow":0,"WCost":0,"Margin_Perc":0,"Ebay_length":0,"Ebay_width":0,"Ebay_depth":0,"Ebay_wtmajor":0,"Ebay_wtminor":0,"Ebay":false,"Web":false,"Published":false,"Approval":false,"Call_To_Order":false,"Discontinued":false,"SellSerialsOnline":false,"ExtPk":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}