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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"ownerId":0,"externalId":"String","lines":[{"variantId":0,"quantity":0}],"buyerName":"String","buyerEmail":"String","buyerPhone":"String","deliveryType":"String","droppLocationId":"String","address":"String","city":"String","zipCode":"String","country":"String","idempotencyKey":"String","discountCode":"String","tenders":[{"kind":"String","code":"String","amountMinor":0,"idempotencyKey":"String","holdId":0,"appliedMinor":0}],"paymentMethodId":"String","paymentId":"String","cardInfo":{"paymentMethod":{"paymentType":"String","token":"String","pan":"String","expYear":"String","expMonth":"String","cvc":"String"},"amount":0,"currency":"String","orderId":"String","transActionDate":"0001-01-01T00:00:00.0000000","saveCardToToken":false},"borgun3DFinalInfo":{"transactionType":"String","amount":0,"currency":"String","transactionDate":"0001-01-01T00:00:00.0000000","orderId":"String","paymentMethod":{"paymentType":"String","token":"String","virtualNumber":"String","expYear":"String","expMonth":"String","panLastFour":"String"},"threeDSecure":{"dataType":"String","mpiToken":"String"}},"applePayInfo":{"orderId":"String","threeDSecure":{"dataType":"String","securityLevelInd":"String","cavv":"String","ucaf":"String"}}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"success":false,"reason":"String","message":{"is":"String","en":"String"},"orderReference":"String","order":{"id":0,"orderReference":"String","ownerId":0,"status":"String","totalMinor":0,"deliveryFeeMinor":0,"totalDiscountMinor":0,"currency":"String","buyerName":"String","buyerEmail":"String","buyerPhone":"String","address":"String","city":"String","zipCode":"String","country":"String","deliveryType":"String","droppOrderId":"String","droppLocationId":"String","needsDeliveryAttention":false,"paymentMethodId":"String","paymentId":"String","paymentReference":"String","discountCode":"String","giftPaidMinor":0,"createdAt":"0001-01-01T00:00:00.0000000","updatedAt":"0001-01-01T00:00:00.0000000","lines":[{"id":0,"productId":0,"variantId":0,"productName":"String","size":"String","color":"String","unitPriceMinor":0,"quantity":0,"lineTotalMinor":0,"status":"String","payoutInfoId":0,"payoutTag":"String"}]},"statusCode":0}