| POST | /api/CustomerOrders |
|---|
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 CustomerOrdersResponse(BaseResponse):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ThirdPartyOrderItem:
product_name: Optional[str] = None
sku: Optional[str] = None
serial_number: Optional[str] = None
web_number: Optional[str] = None
location: Optional[str] = None
qty: Decimal = decimal.Decimal(0)
qty_picked: Decimal = decimal.Decimal(0)
use_qty_picked: bool = False
price: Decimal = decimal.Decimal(0)
on_approval: bool = False
is_e_card: bool = False
ni_cat: Optional[int] = None
ni_sub: Optional[int] = None
ext_pk: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ThirdPartyOrder:
order_number: Optional[str] = None
order_date: datetime.datetime = datetime.datetime(1, 1, 1)
transaction_state: Optional[str] = None
payment_method: Optional[str] = None
order_notes: Optional[str] = None
authorization_code: Optional[str] = None
shipping_method: Optional[str] = None
total: Decimal = decimal.Decimal(0)
sub_total: Decimal = decimal.Decimal(0)
tax_total: Decimal = decimal.Decimal(0)
shipping_total: Decimal = decimal.Decimal(0)
card_type: Optional[str] = None
card_token: Optional[str] = None
card_span: Optional[str] = None
card_expiration_month: Optional[str] = None
card_expiration_year: Optional[str] = None
customer_acct: int = 0
email: Optional[str] = None
po: Optional[str] = None
employee_username: Optional[str] = None
ae_on_approval_order_subtotal: Decimal = decimal.Decimal(0)
ae_on_approval_order_shipping: Decimal = decimal.Decimal(0)
shipping_attn: Optional[str] = None
shipping_name: Optional[str] = None
shipping_first_name: Optional[str] = None
shipping_last_name: Optional[str] = None
shipping_company: Optional[str] = None
shipping_addr1: Optional[str] = None
shipping_addr2: Optional[str] = None
shipping_city: Optional[str] = None
shipping_st: Optional[str] = None
shipping_zip: Optional[str] = None
shipping_country: Optional[str] = None
shipping_phone: Optional[str] = None
billing_attn: Optional[str] = None
billing_name: Optional[str] = None
billing_first_name: Optional[str] = None
billing_last_name: Optional[str] = None
billing_company: Optional[str] = None
billing_addr1: Optional[str] = None
billing_addr2: Optional[str] = None
billing_city: Optional[str] = None
billing_st: Optional[str] = None
billing_zip: Optional[str] = None
billing_country: Optional[str] = None
billing_phone: Optional[str] = None
order_source: Optional[str] = None
card_name: Optional[str] = None
pn_ref: Optional[str] = None
line_items: Optional[List[ThirdPartyOrderItem]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerOrdersRequest(BaseSecureRequest):
"""
CustomerOrdersRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
"""
orders: Optional[List[ThirdPartyOrder]] = None
Python CustomerOrdersRequest 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.
POST /api/CustomerOrders HTTP/1.1
Host: active-ewebservice.biz
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Orders":[{"OrderNumber":"String","TransactionState":"String","PaymentMethod":"String","OrderNotes":"String","AuthorizationCode":"String","ShippingMethod":"String","Total":0,"SubTotal":0,"TaxTotal":0,"ShippingTotal":0,"CardType":"String","CardToken":"String","CardSpan":"String","CardExpirationMonth":"String","CardExpirationYear":"String","CustomerAcct":0,"Email":"String","PO":"String","EmployeeUsername":"String","AeOnApprovalOrderSubtotal":0,"AeOnApprovalOrderShipping":0,"ShippingAttn":"String","ShippingName":"String","ShippingFirstName":"String","ShippingLastName":"String","ShippingCompany":"String","ShippingAddr1":"String","ShippingAddr2":"String","ShippingCity":"String","ShippingSt":"String","ShippingZip":"String","ShippingCountry":"String","ShippingPhone":"String","BillingAttn":"String","BillingName":"String","BillingFirstName":"String","BillingLastName":"String","BillingCompany":"String","BillingAddr1":"String","BillingAddr2":"String","BillingCity":"String","BillingSt":"String","BillingZip":"String","BillingCountry":"String","BillingPhone":"String","OrderSource":"String","CardName":"String","PnRef":"String","LineItems":[{"ProductName":"String","Sku":"String","SerialNumber":"String","WebNumber":"String","Location":"String","Qty":0,"QtyPicked":0,"UseQtyPicked":false,"Price":0,"OnApproval":false,"IsECard":false,"NiCat":0,"NiSub":0,"ExtPk":0}]}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}