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}
namespace TicketUserServices.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type WebshopVariantSummary() = 
        member val ID:Int32 = new Int32() with get,set
        member val ProductId:Int32 = new Int32() with get,set
        member val Size:String = null with get,set
        member val Color:String = null with get,set
        member val StockOnHand:Int32 = new Int32() with get,set
        member val QuantitySold:Int32 = new Int32() with get,set
        member val AvailableQuantity:Int32 = new Int32() with get,set
        member val Status:String = null with get,set

    [<AllowNullLiteral>]
    type WebshopProductSummary() = 
        member val ID:Int32 = new Int32() with get,set
        member val OwnerId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val Category:String = null with get,set
        member val SubCategory:String = null with get,set
        member val DefaultPriceMinor:Int32 = new Int32() with get,set
        member val ImageUrl:String = null with get,set
        member val ViewOrder:Int32 = new Int32() with get,set
        member val Status:String = null with get,set
        member val PayoutInfoId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LegacyItemId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Variants:ResizeArray<WebshopVariantSummary> = new ResizeArray<WebshopVariantSummary>() with get,set

    [<AllowNullLiteral>]
    type WebshopDeliveryOptions() = 
        member val PickupAllowed:Boolean = new Boolean() with get,set
        member val DroppAllowed:Boolean = new Boolean() with get,set
        member val ShippedAllowed:Boolean = new Boolean() with get,set
        member val PickupAddress:String = null with get,set
        member val PickupDescription:String = null with get,set
        member val DroppFeeMinor:Int32 = new Int32() with get,set
        member val ShippedFeeMinor:Int32 = new Int32() with get,set
        member val OrderEmail:String = null with get,set

    [<AllowNullLiteral>]
    type WebshopCatalogResult() = 
        member val OwnerId:Int32 = new Int32() with get,set
        member val Products:ResizeArray<WebshopProductSummary> = new ResizeArray<WebshopProductSummary>() with get,set
        member val Delivery:WebshopDeliveryOptions = null with get,set
        member val StatusCode:Int32 = new Int32() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type WebshopCatalogRequest() = 
        member val OwnerId:Int32 = new Int32() with get,set
        member val ExternalId:String = null with get,set

F# 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
}