TicketUserServices

<back to all web services

WebshopOrderLedgerRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequires the permission:ReadData
The following routes are available for this service:
GET/Webshop/Order/Ledger/{OrderId}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports TicketUserServices.ServiceModel
Imports TicketUserServices.ServiceModel.Types

Namespace Global

    Namespace TicketUserServices.ServiceModel

        Public Partial Class WebshopOrderLedgerRequest
            Public Overridable Property OrderId As Integer
            Public Overridable Property OwnerId As Nullable(Of Integer)
        End Class

        Public Partial Class WebshopOrderLedgerResult
            Public Sub New()
                Transactions = New List(Of WebshopOrderTransaction)
            End Sub

            Public Overridable Property Order As WebshopOrderSummary
            Public Overridable Property Transactions As List(Of WebshopOrderTransaction)
            Public Overridable Property StatusCode As Integer
            Public Overridable Property Message As String
        End Class

        Public Partial Class WebshopOrderLineSummary
            Public Overridable Property ID As Integer
            Public Overridable Property ProductId As Integer
            Public Overridable Property VariantId As Integer
            Public Overridable Property ProductName As String
            Public Overridable Property Size As String
            Public Overridable Property Color As String
            Public Overridable Property UnitPriceMinor As Integer
            Public Overridable Property Quantity As Integer
            Public Overridable Property LineTotalMinor As Integer
            Public Overridable Property Status As String
            Public Overridable Property PayoutInfoId As Nullable(Of Integer)
            Public Overridable Property PayoutTag As String
        End Class

        Public Partial Class WebshopOrderSummary
            Public Sub New()
                Lines = New List(Of WebshopOrderLineSummary)
            End Sub

            Public Overridable Property ID As Integer
            Public Overridable Property OrderReference As String
            Public Overridable Property OwnerId As Integer
            Public Overridable Property Status As String
            Public Overridable Property TotalMinor As Integer
            Public Overridable Property DeliveryFeeMinor As Integer
            Public Overridable Property TotalDiscountMinor As Integer
            Public Overridable Property Currency As String
            Public Overridable Property BuyerName As String
            Public Overridable Property BuyerEmail As String
            Public Overridable Property BuyerPhone As String
            Public Overridable Property Address As String
            Public Overridable Property City As String
            Public Overridable Property ZipCode As String
            Public Overridable Property Country As String
            Public Overridable Property DeliveryType As String
            Public Overridable Property DroppOrderId As String
            Public Overridable Property DroppLocationId As String
            Public Overridable Property NeedsDeliveryAttention As Boolean
            Public Overridable Property PaymentMethodId As String
            Public Overridable Property PaymentId As String
            Public Overridable Property PaymentReference As String
            Public Overridable Property DiscountCode As String
            Public Overridable Property GiftPaidMinor As Integer
            Public Overridable Property CreatedAt As Date
            Public Overridable Property UpdatedAt As Date
            Public Overridable Property Lines As List(Of WebshopOrderLineSummary)
        End Class
    End Namespace

    Namespace TicketUserServices.ServiceModel.Types

        Public Partial Class WebshopOrderTransaction
            Public Overridable Property ID As Integer
            Public Overridable Property OrderId As Integer
            <StringLength(20)>
            Public Overridable Property Kind As String

            Public Overridable Property AmountMinor As Integer
            <StringLength(50)>
            Public Overridable Property PaymentReference As String

            <StringLength(300)>
            Public Overridable Property Note As String

            <StringLength(100)>
            Public Overridable Property IdempotencyKey As String

            Public Overridable Property CreatedAt As Date
            <StringLength(100)>
            Public Overridable Property CreatedBy As String
        End Class
    End Namespace
End Namespace

VB.NET WebshopOrderLedgerRequest 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.

GET /Webshop/Order/Ledger/{OrderId} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	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
			}
		]
	},
	transactions: 
	[
		{
			id: 0,
			orderId: 0,
			kind: String,
			amountMinor: 0,
			paymentReference: String,
			note: String,
			idempotencyKey: String,
			createdAt: 0001-01-01,
			createdBy: String
		}
	],
	statusCode: 0,
	message: String
}