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
WebshopOrderPurchaseRequest Parameters:
NameParameterData TypeRequiredDescription
OwnerIdbodyintNo
ExternalIdbodystringNo
LinesbodyList<WebshopPurchaseLine>No
BuyerNamebodystringNo
BuyerEmailbodystringNo
BuyerPhonebodystringNo
DeliveryTypebodystringNo
DroppLocationIdbodystringNo
AddressbodystringNo
CitybodystringNo
ZipCodebodystringNo
CountrybodystringNo
IdempotencyKeybodystringNo
DiscountCodebodystringNo
TendersbodyList<OrderTender>No
PaymentMethodIdbodystringNo
PaymentIdbodystringNo
CardInfobodyPaymentRequestCreditCardNo
Borgun3DFinalInfobodyBorgun3DFinalRequestNo
ApplePayInfobodyBorgunApplePayFinalInfoNo
WebshopPurchaseLine Parameters:
NameParameterData TypeRequiredDescription
VariantIdformintNo
QuantityformintNo
OrderTender Parameters:
NameParameterData TypeRequiredDescription
KindformstringNo
CodeformstringNo
AmountMinorformint?No
IdempotencyKeyformstringNo
HoldIdformint?No
AppliedMinorformint?No
PaymentRequestCreditCard Parameters:
NameParameterData TypeRequiredDescription
PaymentMethodformPaymentMethodCreditCardInfoNo
AmountformdecimalNo
CurrencyformstringNo
OrderIdformstringNo
TransActionDateformDateTimeNo
SaveCardToTokenformboolNo
PaymentMethodCreditCardInfo Parameters:
NameParameterData TypeRequiredDescription
PaymentTypeformstringNo
TokenformstringNo
PANformstringNo
ExpYearformstringNo
ExpMonthformstringNo
CVCformstringNo
Borgun3DFinalRequest Parameters:
NameParameterData TypeRequiredDescription
TransactionTypeformstringNo
AmountformintNo
CurrencyformstringNo
TransactionDateformDateTime?No
OrderIdformstringNo
PaymentMethodformBorgun3DFinalPaymentMethodInfoNo
ThreeDSecureformBorgun3DFinal3DSecureInfoNo
Borgun3DFinalPaymentMethodInfo Parameters:
NameParameterData TypeRequiredDescription
PaymentTypeformstringNo
TokenformstringNo
VirtualNumberformstringNo
ExpYearformstringNo
ExpMonthformstringNo
PanLastFourformstringNo
Borgun3DFinal3DSecureInfo Parameters:
NameParameterData TypeRequiredDescription
DataTypeformstringNo
MpiTokenformstringNo
BorgunApplePayFinalInfo Parameters:
NameParameterData TypeRequiredDescription
OrderIdformstringNo
ThreeDSecureformBorgunApplePayThreeDSecureInfoNo
BorgunApplePayThreeDSecureInfo Parameters:
NameParameterData TypeRequiredDescription
DataTypeformstringNo
SecurityLevelIndformstringNo
CAVVformstringNo
UCAFformstringNo
WebshopOrderResult Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
ReasonformstringNo
MessageformLocalizedMessageNo
OrderReferenceformstringNo
OrderformWebshopOrderSummaryNo
StatusCodeformintNo
LocalizedMessage Parameters:
NameParameterData TypeRequiredDescription
IsformstringNo
EnformstringNo
WebshopOrderSummary Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
OrderReferenceformstringNo
OwnerIdformintNo
StatusformstringNo
TotalMinorformintNo
DeliveryFeeMinorformintNo
TotalDiscountMinorformintNo
CurrencyformstringNo
BuyerNameformstringNo
BuyerEmailformstringNo
BuyerPhoneformstringNo
AddressformstringNo
CityformstringNo
ZipCodeformstringNo
CountryformstringNo
DeliveryTypeformstringNo
DroppOrderIdformstringNo
DroppLocationIdformstringNo
NeedsDeliveryAttentionformboolNo
PaymentMethodIdformstringNo
PaymentIdformstringNo
PaymentReferenceformstringNo
DiscountCodeformstringNo
GiftPaidMinorformintNo
CreatedAtformDateTimeNo
UpdatedAtformDateTimeNo
LinesformList<WebshopOrderLineSummary>No
WebshopOrderLineSummary Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
ProductIdformintNo
VariantIdformintNo
ProductNameformstringNo
SizeformstringNo
ColorformstringNo
UnitPriceMinorformintNo
QuantityformintNo
LineTotalMinorformintNo
StatusformstringNo
PayoutInfoIdformint?No
PayoutTagformstringNo

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>