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
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class WebshopOrderPurchaseRequest
{
    var ownerId:Int? = null
    var externalId:String? = null
    var lines:ArrayList<WebshopPurchaseLine> = ArrayList<WebshopPurchaseLine>()
    var buyerName:String? = null
    var buyerEmail:String? = null
    var buyerPhone:String? = null
    var deliveryType:String? = null
    var droppLocationId:String? = null
    var address:String? = null
    var city:String? = null
    var zipCode:String? = null
    var country:String? = null
    var idempotencyKey:String? = null
    var discountCode:String? = null
    var tenders:ArrayList<OrderTender> = ArrayList<OrderTender>()
    var paymentMethodId:String? = null
    var paymentId:String? = null
    var cardInfo:PaymentRequestCreditCard? = null
    var borgun3DFinalInfo:Borgun3DFinalRequest? = null
    var applePayInfo:BorgunApplePayFinalInfo? = null
}

open class WebshopPurchaseLine
{
    var variantId:Int? = null
    var quantity:Int? = null
}

open class OrderTender
{
    var kind:String? = null
    var code:String? = null
    var amountMinor:Int? = null
    var idempotencyKey:String? = null
    var holdId:Int? = null
    var appliedMinor:Int? = null
}

open class PaymentRequestCreditCard
{
    var paymentMethod:PaymentMethodCreditCardInfo? = null
    var amount:BigDecimal? = null
    var currency:String? = null
    var orderId:String? = null
    var transActionDate:Date? = null
    var saveCardToToken:Boolean? = null
}

open class PaymentMethodCreditCardInfo
{
    var paymentType:String? = null
    var token:String? = null
    var pan:String? = null
    var expYear:String? = null
    var expMonth:String? = null
    var cvc:String? = null
}

open class Borgun3DFinalRequest
{
    var transactionType:String? = null
    var amount:Int? = null
    var currency:String? = null
    var transactionDate:Date? = null
    var orderId:String? = null
    var paymentMethod:Borgun3DFinalPaymentMethodInfo? = null
    var threeDSecure:Borgun3DFinal3DSecureInfo? = null
}

open class Borgun3DFinalPaymentMethodInfo
{
    var paymentType:String? = null
    var token:String? = null
    var virtualNumber:String? = null
    var expYear:String? = null
    var expMonth:String? = null
    var panLastFour:String? = null
}

open class Borgun3DFinal3DSecureInfo
{
    var dataType:String? = null
    var mpiToken:String? = null
}

open class BorgunApplePayFinalInfo
{
    var orderId:String? = null
    var threeDSecure:BorgunApplePayThreeDSecureInfo? = null
}

open class BorgunApplePayThreeDSecureInfo
{
    var dataType:String? = null
    var securityLevelInd:String? = null
    var cavv:String? = null
    var ucaf:String? = null
}

open class WebshopOrderResult
{
    var success:Boolean? = null
    var reason:String? = null
    var message:LocalizedMessage? = null
    var orderReference:String? = null
    var order:WebshopOrderSummary? = null
    var statusCode:Int? = null
}

open class LocalizedMessage
{
    @SerializedName("is") var Is:String? = null
    var en:String? = null
}

open class WebshopOrderSummary
{
    var id:Int? = null
    var orderReference:String? = null
    var ownerId:Int? = null
    var status:String? = null
    var totalMinor:Int? = null
    var deliveryFeeMinor:Int? = null
    var totalDiscountMinor:Int? = null
    var currency:String? = null
    var buyerName:String? = null
    var buyerEmail:String? = null
    var buyerPhone:String? = null
    var address:String? = null
    var city:String? = null
    var zipCode:String? = null
    var country:String? = null
    var deliveryType:String? = null
    var droppOrderId:String? = null
    var droppLocationId:String? = null
    var needsDeliveryAttention:Boolean? = null
    var paymentMethodId:String? = null
    var paymentId:String? = null
    var paymentReference:String? = null
    var discountCode:String? = null
    var giftPaidMinor:Int? = null
    var createdAt:Date? = null
    var updatedAt:Date? = null
    var lines:ArrayList<WebshopOrderLineSummary> = ArrayList<WebshopOrderLineSummary>()
}

open class WebshopOrderLineSummary
{
    var id:Int? = null
    var productId:Int? = null
    var variantId:Int? = null
    var productName:String? = null
    var size:String? = null
    var color:String? = null
    var unitPriceMinor:Int? = null
    var quantity:Int? = null
    var lineTotalMinor:Int? = null
    var status:String? = null
    var payoutInfoId:Int? = null
    var payoutTag:String? = null
}

Kotlin 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>