| GET | /api/CustomerOrderFulfillment |
|---|
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 CustomerOrderItem:
id: int = 0
item: Optional[str] = None
description: Optional[str] = None
price: Decimal = decimal.Decimal(0)
quantity: Decimal = decimal.Decimal(0)
quantity_picked: Decimal = decimal.Decimal(0)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerWebOrder:
web_order: Optional[str] = None
customer_name: Optional[str] = None
date_time: datetime.datetime = datetime.datetime(1, 1, 1)
items: Optional[List[CustomerOrderItem]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerOrderFulfillmentResponse(BaseResponse):
web_order: Optional[str] = None
customer_name: Optional[str] = None
date_time: datetime.datetime = datetime.datetime(1, 1, 1)
items: Optional[List[CustomerOrderItem]] = None
orders: Optional[List[CustomerWebOrder]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerOrderFulfillmentRequest(BaseSecureRequest):
"""
CustomerOrderFulfillmentRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
"""
# @ApiMember(Description="Pass in if only looking for one weborder. Otherwise do not pass in.", Name="WebOrder", ParameterType="query")
web_order: Optional[str] = None
"""
Pass in if only looking for one weborder. Otherwise do not pass in.
"""
# @ApiMember(Description="Starting offset for Pagination. Defaults to 0.", Name="StartOffset", ParameterType="query")
start_offset: Optional[int] = None
"""
Starting offset for Pagination. Defaults to 0.
"""
# @ApiMember(Description="Records to be returned. Default to 100.", Name="RecordCount", ParameterType="query")
record_count: Optional[int] = None
"""
Records to be returned. Default to 100.
"""
# @ApiMember(Description="If sent, fully picked orders will not be returned.", Name="ExcludeFullyPickedOrders", ParameterType="query")
exclude_fully_picked_orders: bool = False
"""
If sent, fully picked orders will not be returned.
"""
Python CustomerOrderFulfillmentRequest 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/CustomerOrderFulfillment HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CustomerOrderFulfillmentResponse 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>
<CustomerName>String</CustomerName>
<DateTime>0001-01-01T00:00:00</DateTime>
<Items>
<CustomerOrderItem>
<Description>String</Description>
<Id>0</Id>
<Item>String</Item>
<Price>0</Price>
<Quantity>0</Quantity>
<QuantityPicked>0</QuantityPicked>
</CustomerOrderItem>
</Items>
<Orders>
<CustomerWebOrder>
<CustomerName>String</CustomerName>
<DateTime>0001-01-01T00:00:00</DateTime>
<Items>
<CustomerOrderItem>
<Description>String</Description>
<Id>0</Id>
<Item>String</Item>
<Price>0</Price>
<Quantity>0</Quantity>
<QuantityPicked>0</QuantityPicked>
</CustomerOrderItem>
</Items>
<WebOrder>String</WebOrder>
</CustomerWebOrder>
</Orders>
<WebOrder>String</WebOrder>
</CustomerOrderFulfillmentResponse>