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}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class WebshopCatalogRequest
{
    var ownerId:Int? = null
    var externalId:String? = null
}

open class WebshopCatalogResult
{
    var ownerId:Int? = null
    var products:ArrayList<WebshopProductSummary> = ArrayList<WebshopProductSummary>()
    var delivery:WebshopDeliveryOptions? = null
    var statusCode:Int? = null
    var message:String? = null
}

open class WebshopProductSummary
{
    var id:Int? = null
    var ownerId:Int? = null
    var name:String? = null
    var description:String? = null
    var category:String? = null
    var subCategory:String? = null
    var defaultPriceMinor:Int? = null
    var imageUrl:String? = null
    var viewOrder:Int? = null
    var status:String? = null
    var payoutInfoId:Int? = null
    var legacyItemId:Int? = null
    var variants:ArrayList<WebshopVariantSummary> = ArrayList<WebshopVariantSummary>()
}

open class WebshopVariantSummary
{
    var id:Int? = null
    var productId:Int? = null
    var size:String? = null
    var color:String? = null
    var stockOnHand:Int? = null
    var quantitySold:Int? = null
    var availableQuantity:Int? = null
    var status:String? = null
}

open class WebshopDeliveryOptions
{
    var pickupAllowed:Boolean? = null
    var droppAllowed:Boolean? = null
    var shippedAllowed:Boolean? = null
    var pickupAddress:String? = null
    var pickupDescription:String? = null
    var droppFeeMinor:Int? = null
    var shippedFeeMinor:Int? = null
    var orderEmail:String? = null
}

Kotlin WebshopCatalogRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}