TicketUserServices

<back to all web services

WebshopCatalogRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequires the permission:ReadData
The following routes are available for this service:
GET/Webshop/Catalog/{OwnerId}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports TicketUserServices.ServiceModel

Namespace Global

    Namespace TicketUserServices.ServiceModel

        Public Partial Class WebshopCatalogRequest
            Public Overridable Property OwnerId As Integer
            Public Overridable Property ExternalId As String
        End Class

        Public Partial Class WebshopCatalogResult
            Public Sub New()
                Products = New List(Of WebshopProductSummary)
            End Sub

            Public Overridable Property OwnerId As Integer
            Public Overridable Property Products As List(Of WebshopProductSummary)
            Public Overridable Property Delivery As WebshopDeliveryOptions
            Public Overridable Property StatusCode As Integer
            Public Overridable Property Message As String
        End Class

        Public Partial Class WebshopDeliveryOptions
            Public Overridable Property PickupAllowed As Boolean
            Public Overridable Property DroppAllowed As Boolean
            Public Overridable Property ShippedAllowed As Boolean
            Public Overridable Property PickupAddress As String
            Public Overridable Property PickupDescription As String
            Public Overridable Property DroppFeeMinor As Integer
            Public Overridable Property ShippedFeeMinor As Integer
            Public Overridable Property OrderEmail As String
        End Class

        Public Partial Class WebshopProductSummary
            Public Sub New()
                Variants = New List(Of WebshopVariantSummary)
            End Sub

            Public Overridable Property ID As Integer
            Public Overridable Property OwnerId As Integer
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property Category As String
            Public Overridable Property SubCategory As String
            Public Overridable Property DefaultPriceMinor As Integer
            Public Overridable Property ImageUrl As String
            Public Overridable Property ViewOrder As Integer
            Public Overridable Property Status As String
            Public Overridable Property PayoutInfoId As Nullable(Of Integer)
            Public Overridable Property LegacyItemId As Nullable(Of Integer)
            Public Overridable Property Variants As List(Of WebshopVariantSummary)
        End Class

        Public Partial Class WebshopVariantSummary
            Public Overridable Property ID As Integer
            Public Overridable Property ProductId As Integer
            Public Overridable Property Size As String
            Public Overridable Property Color As String
            Public Overridable Property StockOnHand As Integer
            Public Overridable Property QuantitySold As Integer
            Public Overridable Property AvailableQuantity As Integer
            Public Overridable Property Status As String
        End Class
    End Namespace
End Namespace

VB.NET WebshopCatalogRequest 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/Catalog/{OwnerId} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ownerId: 0,
	products: 
	[
		{
			id: 0,
			ownerId: 0,
			name: String,
			description: String,
			category: String,
			subCategory: String,
			defaultPriceMinor: 0,
			imageUrl: String,
			viewOrder: 0,
			status: String,
			payoutInfoId: 0,
			legacyItemId: 0,
			variants: 
			[
				{
					id: 0,
					productId: 0,
					size: String,
					color: String,
					stockOnHand: 0,
					quantitySold: 0,
					availableQuantity: 0,
					status: String
				}
			]
		}
	],
	delivery: 
	{
		pickupAllowed: False,
		droppAllowed: False,
		shippedAllowed: False,
		pickupAddress: String,
		pickupDescription: String,
		droppFeeMinor: 0,
		shippedFeeMinor: 0,
		orderEmail: String
	},
	statusCode: 0,
	message: String
}