TicketUserServices

<back to all web services

WebshopOrderPurchaseRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequired permission:Tickets.Add
The following routes are available for this service:
POST/Webshop/Order/Purchase

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

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

export class WebshopOrderLineSummary
{
    public id?: number;
    public productId?: number;
    public variantId?: number;
    public productName?: string;
    public size?: string;
    public color?: string;
    public unitPriceMinor?: number;
    public quantity?: number;
    public lineTotalMinor?: number;
    public status?: string;
    public payoutInfoId?: number;
    public payoutTag?: string;

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

export class WebshopOrderSummary
{
    public id?: number;
    public orderReference?: string;
    public ownerId?: number;
    public status?: string;
    public totalMinor?: number;
    public deliveryFeeMinor?: number;
    public totalDiscountMinor?: number;
    public currency?: string;
    public buyerName?: string;
    public buyerEmail?: string;
    public buyerPhone?: string;
    public address?: string;
    public city?: string;
    public zipCode?: string;
    public country?: string;
    public deliveryType?: string;
    public droppOrderId?: string;
    public droppLocationId?: string;
    public needsDeliveryAttention?: boolean;
    public paymentMethodId?: string;
    public paymentId?: string;
    public paymentReference?: string;
    public discountCode?: string;
    public giftPaidMinor?: number;
    public createdAt?: string;
    public updatedAt?: string;
    public lines?: WebshopOrderLineSummary[];

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

export class WebshopOrderResult
{
    public success?: boolean;
    public reason?: string;
    public message?: LocalizedMessage;
    public orderReference?: string;
    public order?: WebshopOrderSummary;
    public statusCode?: number;

    public constructor(init?: Partial<WebshopOrderResult>) { (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 PaymentMethodCreditCardInfo
{
    public paymentType?: string;
    public token?: string;
    public pan?: string;
    public expYear?: string;
    public expMonth?: string;
    public cvc?: string;

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

export class PaymentRequestCreditCard
{
    public paymentMethod?: PaymentMethodCreditCardInfo;
    public amount?: number;
    public currency?: string;
    public orderId?: string;
    public transActionDate?: string;
    public saveCardToToken?: boolean;

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

export class Borgun3DFinalPaymentMethodInfo
{
    public paymentType?: string;
    public token?: string;
    public virtualNumber?: string;
    public expYear?: string;
    public expMonth?: string;
    public panLastFour?: string;

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

export class Borgun3DFinal3DSecureInfo
{
    public dataType?: string;
    public mpiToken?: string;

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

export class Borgun3DFinalRequest
{
    public transactionType?: string;
    public amount?: number;
    public currency?: string;
    public transactionDate?: string;
    public orderId?: string;
    public paymentMethod?: Borgun3DFinalPaymentMethodInfo;
    public threeDSecure?: Borgun3DFinal3DSecureInfo;

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

export class BorgunApplePayThreeDSecureInfo
{
    public dataType?: string;
    public securityLevelInd?: string;
    public cavv?: string;
    public ucaf?: string;

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

export class BorgunApplePayFinalInfo
{
    public orderId?: string;
    public threeDSecure?: BorgunApplePayThreeDSecureInfo;

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

export class WebshopOrderPurchaseRequest
{
    public ownerId?: number;
    public externalId?: string;
    public lines?: WebshopPurchaseLine[];
    public buyerName?: string;
    public buyerEmail?: string;
    public buyerPhone?: string;
    public deliveryType?: string;
    public droppLocationId?: string;
    public address?: string;
    public city?: string;
    public zipCode?: string;
    public country?: string;
    public idempotencyKey?: string;
    public discountCode?: string;
    public tenders?: OrderTender[];
    public paymentMethodId?: string;
    public paymentId?: string;
    public cardInfo?: PaymentRequestCreditCard;
    public borgun3DFinalInfo?: Borgun3DFinalRequest;
    public applePayInfo?: BorgunApplePayFinalInfo;

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

TypeScript WebshopOrderPurchaseRequest 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/Purchase HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<WebshopOrderPurchaseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Address>String</Address>
  <ApplePayInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BorgunRPGData">
    <d2p1:OrderId>String</d2p1:OrderId>
    <d2p1:ThreeDSecure>
      <d2p1:CAVV>String</d2p1:CAVV>
      <d2p1:DataType>String</d2p1:DataType>
      <d2p1:SecurityLevelInd>String</d2p1:SecurityLevelInd>
      <d2p1:UCAF>String</d2p1:UCAF>
    </d2p1:ThreeDSecure>
  </ApplePayInfo>
  <Borgun3DFinalInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BorgunRPGData">
    <d2p1:Amount>0</d2p1:Amount>
    <d2p1:Currency>String</d2p1:Currency>
    <d2p1:OrderId>String</d2p1:OrderId>
    <d2p1:PaymentMethod>
      <d2p1:ExpMonth>String</d2p1:ExpMonth>
      <d2p1:ExpYear>String</d2p1:ExpYear>
      <d2p1:PanLastFour>String</d2p1:PanLastFour>
      <d2p1:PaymentType>String</d2p1:PaymentType>
      <d2p1:Token>String</d2p1:Token>
      <d2p1:VirtualNumber>String</d2p1:VirtualNumber>
    </d2p1:PaymentMethod>
    <d2p1:ThreeDSecure>
      <d2p1:DataType>String</d2p1:DataType>
      <d2p1:MpiToken>String</d2p1:MpiToken>
    </d2p1:ThreeDSecure>
    <d2p1:TransactionDate>0001-01-01T00:00:00</d2p1:TransactionDate>
    <d2p1:TransactionType>String</d2p1:TransactionType>
  </Borgun3DFinalInfo>
  <BuyerEmail>String</BuyerEmail>
  <BuyerName>String</BuyerName>
  <BuyerPhone>String</BuyerPhone>
  <CardInfo>
    <Amount>0</Amount>
    <Currency>String</Currency>
    <OrderId>String</OrderId>
    <PaymentMethod>
      <CVC>String</CVC>
      <ExpMonth>String</ExpMonth>
      <ExpYear>String</ExpYear>
      <PAN>String</PAN>
      <PaymentType>String</PaymentType>
      <Token>String</Token>
    </PaymentMethod>
    <SaveCardToToken>false</SaveCardToToken>
    <TransActionDate>0001-01-01T00:00:00</TransActionDate>
  </CardInfo>
  <City>String</City>
  <Country>String</Country>
  <DeliveryType>String</DeliveryType>
  <DiscountCode>String</DiscountCode>
  <DroppLocationId>String</DroppLocationId>
  <ExternalId>String</ExternalId>
  <IdempotencyKey>String</IdempotencyKey>
  <Lines>
    <WebshopPurchaseLine>
      <Quantity>0</Quantity>
      <VariantId>0</VariantId>
    </WebshopPurchaseLine>
  </Lines>
  <OwnerId>0</OwnerId>
  <PaymentId>String</PaymentId>
  <PaymentMethodId>String</PaymentMethodId>
  <Tenders>
    <OrderTender>
      <AmountMinor>0</AmountMinor>
      <AppliedMinor>0</AppliedMinor>
      <Code>String</Code>
      <HoldId>0</HoldId>
      <IdempotencyKey>String</IdempotencyKey>
      <Kind>String</Kind>
    </OrderTender>
  </Tenders>
  <ZipCode>String</ZipCode>
</WebshopOrderPurchaseRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WebshopOrderResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Message>
    <En>String</En>
    <Is>String</Is>
  </Message>
  <Order>
    <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>
  </Order>
  <OrderReference>String</OrderReference>
  <Reason>String</Reason>
  <StatusCode>0</StatusCode>
  <Success>false</Success>
</WebshopOrderResult>