| Requires any of the roles: | Admin, TeamAdmin, MobileApp | Requires the permission: | ReadData |
| POST | /Webshop/Order/Preview |
|---|
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 LocalizedMessage:
is_: Optional[str] = field(metadata=config(field_name='is'), default=None)
en: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopPreviewLine:
variant_id: Optional[int] = None
product_id: Optional[int] = None
product_name: Optional[str] = None
size: Optional[str] = None
color: Optional[str] = None
quantity: Optional[int] = None
unit_before_minor: Optional[int] = None
unit_after_minor: Optional[int] = None
line_before_minor: Optional[int] = None
line_after_minor: Optional[int] = None
discounted: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopPreviewTender:
code: Optional[str] = None
applied_minor: Optional[int] = None
ok: Optional[bool] = None
reason: Optional[str] = None
message: Optional[LocalizedMessage] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DiscountSummary:
type: Optional[str] = None
value: Optional[Decimal] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopOrderPreviewResult:
status_code: Optional[int] = None
success: Optional[bool] = None
message: Optional[LocalizedMessage] = None
reason: Optional[str] = None
lines: Optional[List[WebshopPreviewLine]] = None
subtotal_minor: Optional[int] = None
delivery_fee_minor: Optional[int] = None
discount_minor: Optional[int] = None
gift_applied_minor: Optional[int] = None
card_remainder_minor: Optional[int] = None
tenders: Optional[List[WebshopPreviewTender]] = None
discount: Optional[DiscountSummary] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopPurchaseLine:
variant_id: Optional[int] = None
quantity: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrderTender:
kind: Optional[str] = None
code: Optional[str] = None
amount_minor: Optional[int] = None
idempotency_key: Optional[str] = None
hold_id: Optional[int] = None
applied_minor: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopOrderPreviewRequest:
owner_id: Optional[int] = None
external_id: Optional[str] = None
lines: Optional[List[WebshopPurchaseLine]] = None
delivery_type: Optional[str] = None
discount_code: Optional[str] = None
buyer_phone: Optional[str] = None
tenders: Optional[List[OrderTender]] = None
Python WebshopOrderPreviewRequest 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/Preview HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<WebshopOrderPreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
<BuyerPhone>String</BuyerPhone>
<DeliveryType>String</DeliveryType>
<DiscountCode>String</DiscountCode>
<ExternalId>String</ExternalId>
<Lines>
<WebshopPurchaseLine>
<Quantity>0</Quantity>
<VariantId>0</VariantId>
</WebshopPurchaseLine>
</Lines>
<OwnerId>0</OwnerId>
<Tenders>
<OrderTender>
<AmountMinor>0</AmountMinor>
<AppliedMinor>0</AppliedMinor>
<Code>String</Code>
<HoldId>0</HoldId>
<IdempotencyKey>String</IdempotencyKey>
<Kind>String</Kind>
</OrderTender>
</Tenders>
</WebshopOrderPreviewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<WebshopOrderPreviewResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
<CardRemainderMinor>0</CardRemainderMinor>
<DeliveryFeeMinor>0</DeliveryFeeMinor>
<Discount>
<Type>String</Type>
<Value>0</Value>
</Discount>
<DiscountMinor>0</DiscountMinor>
<GiftAppliedMinor>0</GiftAppliedMinor>
<Lines>
<WebshopPreviewLine>
<Color>String</Color>
<Discounted>false</Discounted>
<LineAfterMinor>0</LineAfterMinor>
<LineBeforeMinor>0</LineBeforeMinor>
<ProductId>0</ProductId>
<ProductName>String</ProductName>
<Quantity>0</Quantity>
<Size>String</Size>
<UnitAfterMinor>0</UnitAfterMinor>
<UnitBeforeMinor>0</UnitBeforeMinor>
<VariantId>0</VariantId>
</WebshopPreviewLine>
</Lines>
<Message>
<En>String</En>
<Is>String</Is>
</Message>
<Reason>String</Reason>
<StatusCode>0</StatusCode>
<SubtotalMinor>0</SubtotalMinor>
<Success>false</Success>
<Tenders>
<WebshopPreviewTender>
<AppliedMinor>0</AppliedMinor>
<Code>String</Code>
<Message>
<En>String</En>
<Is>String</Is>
</Message>
<Ok>false</Ok>
<Reason>String</Reason>
</WebshopPreviewTender>
</Tenders>
</WebshopOrderPreviewResult>