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

export class LocalizedMessage
{
    public is?: string;
    public en?: string;

    public constructor(init?: Partial<LocalizedMessage>) { (Object as any).assign(this, init); }
}

export class WebshopPreviewLine
{
    public variantId?: number;
    public productId?: number;
    public productName?: string;
    public size?: string;
    public color?: string;
    public quantity?: number;
    public unitBeforeMinor?: number;
    public unitAfterMinor?: number;
    public lineBeforeMinor?: number;
    public lineAfterMinor?: number;
    public discounted?: boolean;

    public constructor(init?: Partial<WebshopPreviewLine>) { (Object as any).assign(this, init); }
}

export class WebshopPreviewTender
{
    public code?: string;
    public appliedMinor?: number;
    public ok?: boolean;
    public reason?: string;
    public message?: LocalizedMessage;

    public constructor(init?: Partial<WebshopPreviewTender>) { (Object as any).assign(this, init); }
}

export class DiscountSummary
{
    public type?: string;
    public value?: number;

    public constructor(init?: Partial<DiscountSummary>) { (Object as any).assign(this, init); }
}

export class WebshopOrderPreviewResult
{
    public statusCode?: number;
    public success?: boolean;
    public message?: LocalizedMessage;
    public reason?: string;
    public lines?: WebshopPreviewLine[];
    public subtotalMinor?: number;
    public deliveryFeeMinor?: number;
    public discountMinor?: number;
    public giftAppliedMinor?: number;
    public cardRemainderMinor?: number;
    public tenders?: WebshopPreviewTender[];
    public discount?: DiscountSummary;

    public constructor(init?: Partial<WebshopOrderPreviewResult>) { (Object as any).assign(this, init); }
}

export class WebshopPurchaseLine
{
    public variantId?: number;
    public quantity?: number;

    public constructor(init?: Partial<WebshopPurchaseLine>) { (Object as any).assign(this, init); }
}

export class OrderTender
{
    public kind?: string;
    public code?: string;
    public amountMinor?: number;
    public idempotencyKey?: string;
    public holdId?: number;
    public appliedMinor?: number;

    public constructor(init?: Partial<OrderTender>) { (Object as any).assign(this, init); }
}

export class WebshopOrderPreviewRequest
{
    public ownerId?: number;
    public externalId?: string;
    public lines?: WebshopPurchaseLine[];
    public deliveryType?: string;
    public discountCode?: string;
    public buyerPhone?: string;
    public tenders?: OrderTender[];

    public constructor(init?: Partial<WebshopOrderPreviewRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
	}
}