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 Foundation
import ServiceStack

public class WebshopOrderPurchaseRequest : Codable
{
    public var ownerId:Int?
    public var externalId:String?
    public var lines:[WebshopPurchaseLine] = []
    public var buyerName:String?
    public var buyerEmail:String?
    public var buyerPhone:String?
    public var deliveryType:String?
    public var droppLocationId:String?
    public var address:String?
    public var city:String?
    public var zipCode:String?
    public var country:String?
    public var idempotencyKey:String?
    public var discountCode:String?
    public var tenders:[OrderTender] = []
    public var paymentMethodId:String?
    public var paymentId:String?
    public var cardInfo:PaymentRequestCreditCard?
    public var borgun3DFinalInfo:Borgun3DFinalRequest?
    public var applePayInfo:BorgunApplePayFinalInfo?

    required public init(){}
}

public class WebshopPurchaseLine : Codable
{
    public var variantId:Int?
    public var quantity:Int?

    required public init(){}
}

public class OrderTender : Codable
{
    public var kind:String?
    public var code:String?
    public var amountMinor:Int?
    public var idempotencyKey:String?
    public var holdId:Int?
    public var appliedMinor:Int?

    required public init(){}
}

public class PaymentRequestCreditCard : Codable
{
    public var paymentMethod:PaymentMethodCreditCardInfo?
    public var amount:Double?
    public var currency:String?
    public var orderId:String?
    public var transActionDate:Date?
    public var saveCardToToken:Bool?

    required public init(){}
}

public class PaymentMethodCreditCardInfo : Codable
{
    public var paymentType:String?
    public var token:String?
    public var pan:String?
    public var expYear:String?
    public var expMonth:String?
    public var cvc:String?

    required public init(){}
}

public class Borgun3DFinalRequest : Codable
{
    public var transactionType:String?
    public var amount:Int?
    public var currency:String?
    public var transactionDate:Date?
    public var orderId:String?
    public var paymentMethod:Borgun3DFinalPaymentMethodInfo?
    public var threeDSecure:Borgun3DFinal3DSecureInfo?

    required public init(){}
}

public class Borgun3DFinalPaymentMethodInfo : Codable
{
    public var paymentType:String?
    public var token:String?
    public var virtualNumber:String?
    public var expYear:String?
    public var expMonth:String?
    public var panLastFour:String?

    required public init(){}
}

public class Borgun3DFinal3DSecureInfo : Codable
{
    public var dataType:String?
    public var mpiToken:String?

    required public init(){}
}

public class BorgunApplePayFinalInfo : Codable
{
    public var orderId:String?
    public var threeDSecure:BorgunApplePayThreeDSecureInfo?

    required public init(){}
}

public class BorgunApplePayThreeDSecureInfo : Codable
{
    public var dataType:String?
    public var securityLevelInd:String?
    public var cavv:String?
    public var ucaf:String?

    required public init(){}
}

public class WebshopOrderResult : Codable
{
    public var success:Bool?
    public var reason:String?
    public var message:LocalizedMessage?
    public var orderReference:String?
    public var order:WebshopOrderSummary?
    public var statusCode:Int?

    required public init(){}
}

public class LocalizedMessage : Codable
{
    public var `is`:String?
    public var en:String?

    required public init(){}
}

public class WebshopOrderSummary : Codable
{
    public var id:Int?
    public var orderReference:String?
    public var ownerId:Int?
    public var status:String?
    public var totalMinor:Int?
    public var deliveryFeeMinor:Int?
    public var totalDiscountMinor:Int?
    public var currency:String?
    public var buyerName:String?
    public var buyerEmail:String?
    public var buyerPhone:String?
    public var address:String?
    public var city:String?
    public var zipCode:String?
    public var country:String?
    public var deliveryType:String?
    public var droppOrderId:String?
    public var droppLocationId:String?
    public var needsDeliveryAttention:Bool?
    public var paymentMethodId:String?
    public var paymentId:String?
    public var paymentReference:String?
    public var discountCode:String?
    public var giftPaidMinor:Int?
    public var createdAt:Date?
    public var updatedAt:Date?
    public var lines:[WebshopOrderLineSummary] = []

    required public init(){}
}

public class WebshopOrderLineSummary : Codable
{
    public var id:Int?
    public var productId:Int?
    public var variantId:Int?
    public var productName:String?
    public var size:String?
    public var color:String?
    public var unitPriceMinor:Int?
    public var quantity:Int?
    public var lineTotalMinor:Int?
    public var status:String?
    public var payoutInfoId:Int?
    public var payoutTag:String?

    required public init(){}
}

Swift WebshopOrderPurchaseRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv
Content-Type: text/jsv
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-01,
		saveCardToToken: False
	},
	borgun3DFinalInfo: 
	{
		transactionType: String,
		amount: 0,
		currency: String,
		transactionDate: 0001-01-01,
		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/jsv
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-01,
		updatedAt: 0001-01-01,
		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
}