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 .xml suffix or ?format=xml

HTTP + 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>