| Requires any of the roles: | Admin, TeamAdmin | Requires the permission: | ReadData |
| POST | /Webshop/Order/Search |
|---|
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 WebshopOrderLineSummary:
id: Optional[int] = None
product_id: Optional[int] = None
variant_id: Optional[int] = None
product_name: Optional[str] = None
size: Optional[str] = None
color: Optional[str] = None
unit_price_minor: Optional[int] = None
quantity: Optional[int] = None
line_total_minor: Optional[int] = None
status: Optional[str] = None
payout_info_id: Optional[int] = None
payout_tag: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopOrderSummary:
id: Optional[int] = None
order_reference: Optional[str] = None
owner_id: Optional[int] = None
status: Optional[str] = None
total_minor: Optional[int] = None
delivery_fee_minor: Optional[int] = None
total_discount_minor: Optional[int] = None
currency: Optional[str] = None
buyer_name: Optional[str] = None
buyer_email: Optional[str] = None
buyer_phone: Optional[str] = None
address: Optional[str] = None
city: Optional[str] = None
zip_code: Optional[str] = None
country: Optional[str] = None
delivery_type: Optional[str] = None
dropp_order_id: Optional[str] = None
dropp_location_id: Optional[str] = None
needs_delivery_attention: Optional[bool] = None
payment_method_id: Optional[str] = None
payment_id: Optional[str] = None
payment_reference: Optional[str] = None
discount_code: Optional[str] = None
gift_paid_minor: Optional[int] = None
created_at: Optional[datetime.datetime] = None
updated_at: Optional[datetime.datetime] = None
lines: Optional[List[WebshopOrderLineSummary]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopOrderSearchResult:
items: Optional[List[WebshopOrderSummary]] = None
total_count: Optional[int] = None
status_code: Optional[int] = None
message: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopOrderSearchRequest:
owner_id: Optional[int] = None
status: Optional[str] = None
from_: Optional[datetime.datetime] = field(metadata=config(field_name='from'), default=None)
to: Optional[datetime.datetime] = None
skip: Optional[int] = None
take: Optional[int] = None
Python WebshopOrderSearchRequest 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.
POST /Webshop/Order/Search HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<WebshopOrderSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
<From>0001-01-01T00:00:00</From>
<OwnerId>0</OwnerId>
<Skip>0</Skip>
<Status>String</Status>
<Take>0</Take>
<To>0001-01-01T00:00:00</To>
</WebshopOrderSearchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<WebshopOrderSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
<Items>
<WebshopOrderSummary>
<Address>String</Address>
<BuyerEmail>String</BuyerEmail>
<BuyerName>String</BuyerName>
<BuyerPhone>String</BuyerPhone>
<City>String</City>
<Country>String</Country>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<Currency>String</Currency>
<DeliveryFeeMinor>0</DeliveryFeeMinor>
<DeliveryType>String</DeliveryType>
<DiscountCode>String</DiscountCode>
<DroppLocationId>String</DroppLocationId>
<DroppOrderId>String</DroppOrderId>
<GiftPaidMinor>0</GiftPaidMinor>
<ID>0</ID>
<Lines>
<WebshopOrderLineSummary>
<Color>String</Color>
<ID>0</ID>
<LineTotalMinor>0</LineTotalMinor>
<PayoutInfoId>0</PayoutInfoId>
<PayoutTag>String</PayoutTag>
<ProductId>0</ProductId>
<ProductName>String</ProductName>
<Quantity>0</Quantity>
<Size>String</Size>
<Status>String</Status>
<UnitPriceMinor>0</UnitPriceMinor>
<VariantId>0</VariantId>
</WebshopOrderLineSummary>
</Lines>
<NeedsDeliveryAttention>false</NeedsDeliveryAttention>
<OrderReference>String</OrderReference>
<OwnerId>0</OwnerId>
<PaymentId>String</PaymentId>
<PaymentMethodId>String</PaymentMethodId>
<PaymentReference>String</PaymentReference>
<Status>String</Status>
<TotalDiscountMinor>0</TotalDiscountMinor>
<TotalMinor>0</TotalMinor>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
<ZipCode>String</ZipCode>
</WebshopOrderSummary>
</Items>
<Message>String</Message>
<StatusCode>0</StatusCode>
<TotalCount>0</TotalCount>
</WebshopOrderSearchResult>