TicketUserServices

<back to all web services

WebshopOrderPreviewRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequires the permission:ReadData
The following routes are available for this service:
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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ownerId: 0,
	externalId: String,
	lines: 
	[
		{
			variantId: 0,
			quantity: 0
		}
	],
	deliveryType: String,
	discountCode: String,
	buyerPhone: String,
	tenders: 
	[
		{
			kind: String,
			code: String,
			amountMinor: 0,
			idempotencyKey: String,
			holdId: 0,
			appliedMinor: 0
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	statusCode: 0,
	success: False,
	message: 
	{
		is: String,
		en: String
	},
	reason: String,
	lines: 
	[
		{
			variantId: 0,
			productId: 0,
			productName: String,
			size: String,
			color: String,
			quantity: 0,
			unitBeforeMinor: 0,
			unitAfterMinor: 0,
			lineBeforeMinor: 0,
			lineAfterMinor: 0,
			discounted: False
		}
	],
	subtotalMinor: 0,
	deliveryFeeMinor: 0,
	discountMinor: 0,
	giftAppliedMinor: 0,
	cardRemainderMinor: 0,
	tenders: 
	[
		{
			code: String,
			appliedMinor: 0,
			ok: False,
			reason: String,
			message: 
			{
				is: String,
				en: String
			}
		}
	],
	discount: 
	{
		type: String,
		value: 0
	}
}