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
namespace TicketUserServices.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type LocalizedMessage() = 
        member val Is:String = null with get,set
        member val En:String = null with get,set

    [<AllowNullLiteral>]
    type WebshopOrderLineSummary() = 
        member val ID:Int32 = new Int32() with get,set
        member val ProductId:Int32 = new Int32() with get,set
        member val VariantId:Int32 = new Int32() with get,set
        member val ProductName:String = null with get,set
        member val Size:String = null with get,set
        member val Color:String = null with get,set
        member val UnitPriceMinor:Int32 = new Int32() with get,set
        member val Quantity:Int32 = new Int32() with get,set
        member val LineTotalMinor:Int32 = new Int32() with get,set
        member val Status:String = null with get,set
        member val PayoutInfoId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PayoutTag:String = null with get,set

    [<AllowNullLiteral>]
    type WebshopOrderSummary() = 
        member val ID:Int32 = new Int32() with get,set
        member val OrderReference:String = null with get,set
        member val OwnerId:Int32 = new Int32() with get,set
        member val Status:String = null with get,set
        member val TotalMinor:Int32 = new Int32() with get,set
        member val DeliveryFeeMinor:Int32 = new Int32() with get,set
        member val TotalDiscountMinor:Int32 = new Int32() with get,set
        member val Currency:String = null with get,set
        member val BuyerName:String = null with get,set
        member val BuyerEmail:String = null with get,set
        member val BuyerPhone:String = null with get,set
        member val Address:String = null with get,set
        member val City:String = null with get,set
        member val ZipCode:String = null with get,set
        member val Country:String = null with get,set
        member val DeliveryType:String = null with get,set
        member val DroppOrderId:String = null with get,set
        member val DroppLocationId:String = null with get,set
        member val NeedsDeliveryAttention:Boolean = new Boolean() with get,set
        member val PaymentMethodId:String = null with get,set
        member val PaymentId:String = null with get,set
        member val PaymentReference:String = null with get,set
        member val DiscountCode:String = null with get,set
        member val GiftPaidMinor:Int32 = new Int32() with get,set
        member val CreatedAt:DateTime = new DateTime() with get,set
        member val UpdatedAt:DateTime = new DateTime() with get,set
        member val Lines:ResizeArray<WebshopOrderLineSummary> = new ResizeArray<WebshopOrderLineSummary>() with get,set

    [<AllowNullLiteral>]
    type WebshopOrderResult() = 
        member val Success:Boolean = new Boolean() with get,set
        member val Reason:String = null with get,set
        member val Message:LocalizedMessage = null with get,set
        member val OrderReference:String = null with get,set
        member val Order:WebshopOrderSummary = null with get,set
        member val StatusCode:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type WebshopPurchaseLine() = 
        member val VariantId:Int32 = new Int32() with get,set
        member val Quantity:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type OrderTender() = 
        member val Kind:String = null with get,set
        member val Code:String = null with get,set
        member val AmountMinor:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IdempotencyKey:String = null with get,set
        member val HoldId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AppliedMinor:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type PaymentMethodCreditCardInfo() = 
        member val PaymentType:String = null with get,set
        member val Token:String = null with get,set
        member val PAN:String = null with get,set
        member val ExpYear:String = null with get,set
        member val ExpMonth:String = null with get,set
        member val CVC:String = null with get,set

    [<AllowNullLiteral>]
    type PaymentRequestCreditCard() = 
        member val PaymentMethod:PaymentMethodCreditCardInfo = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val Currency:String = null with get,set
        member val OrderId:String = null with get,set
        member val TransActionDate:DateTime = new DateTime() with get,set
        member val SaveCardToToken:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type Borgun3DFinalPaymentMethodInfo() = 
        member val PaymentType:String = null with get,set
        member val Token:String = null with get,set
        member val VirtualNumber:String = null with get,set
        member val ExpYear:String = null with get,set
        member val ExpMonth:String = null with get,set
        member val PanLastFour:String = null with get,set

    [<AllowNullLiteral>]
    type Borgun3DFinal3DSecureInfo() = 
        member val DataType:String = null with get,set
        member val MpiToken:String = null with get,set

    [<AllowNullLiteral>]
    type Borgun3DFinalRequest() = 
        member val TransactionType:String = null with get,set
        member val Amount:Int32 = new Int32() with get,set
        member val Currency:String = null with get,set
        member val TransactionDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val OrderId:String = null with get,set
        member val PaymentMethod:Borgun3DFinalPaymentMethodInfo = null with get,set
        member val ThreeDSecure:Borgun3DFinal3DSecureInfo = null with get,set

    [<AllowNullLiteral>]
    type BorgunApplePayThreeDSecureInfo() = 
        member val DataType:String = null with get,set
        member val SecurityLevelInd:String = null with get,set
        member val CAVV:String = null with get,set
        member val UCAF:String = null with get,set

    [<AllowNullLiteral>]
    type BorgunApplePayFinalInfo() = 
        member val OrderId:String = null with get,set
        member val ThreeDSecure:BorgunApplePayThreeDSecureInfo = null with get,set

    [<AllowNullLiteral>]
    type WebshopOrderPurchaseRequest() = 
        member val OwnerId:Int32 = new Int32() with get,set
        member val ExternalId:String = null with get,set
        member val Lines:ResizeArray<WebshopPurchaseLine> = new ResizeArray<WebshopPurchaseLine>() with get,set
        member val BuyerName:String = null with get,set
        member val BuyerEmail:String = null with get,set
        member val BuyerPhone:String = null with get,set
        member val DeliveryType:String = null with get,set
        member val DroppLocationId:String = null with get,set
        member val Address:String = null with get,set
        member val City:String = null with get,set
        member val ZipCode:String = null with get,set
        member val Country:String = null with get,set
        member val IdempotencyKey:String = null with get,set
        member val DiscountCode:String = null with get,set
        member val Tenders:ResizeArray<OrderTender> = new ResizeArray<OrderTender>() with get,set
        member val PaymentMethodId:String = null with get,set
        member val PaymentId:String = null with get,set
        member val CardInfo:PaymentRequestCreditCard = null with get,set
        member val Borgun3DFinalInfo:Borgun3DFinalRequest = null with get,set
        member val ApplePayInfo:BorgunApplePayFinalInfo = null with get,set

F# 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>