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 .xml suffix or ?format=xml

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WebshopCatalogResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Delivery>
    <DroppAllowed>false</DroppAllowed>
    <DroppFeeMinor>0</DroppFeeMinor>
    <OrderEmail>String</OrderEmail>
    <PickupAddress>String</PickupAddress>
    <PickupAllowed>false</PickupAllowed>
    <PickupDescription>String</PickupDescription>
    <ShippedAllowed>false</ShippedAllowed>
    <ShippedFeeMinor>0</ShippedFeeMinor>
  </Delivery>
  <Message>String</Message>
  <OwnerId>0</OwnerId>
  <Products>
    <WebshopProductSummary>
      <Category>String</Category>
      <DefaultPriceMinor>0</DefaultPriceMinor>
      <Description>String</Description>
      <ID>0</ID>
      <ImageUrl>String</ImageUrl>
      <LegacyItemId>0</LegacyItemId>
      <Name>String</Name>
      <OwnerId>0</OwnerId>
      <PayoutInfoId>0</PayoutInfoId>
      <Status>String</Status>
      <SubCategory>String</SubCategory>
      <Variants>
        <WebshopVariantSummary>
          <AvailableQuantity>0</AvailableQuantity>
          <Color>String</Color>
          <ID>0</ID>
          <ProductId>0</ProductId>
          <QuantitySold>0</QuantitySold>
          <Size>String</Size>
          <Status>String</Status>
          <StockOnHand>0</StockOnHand>
        </WebshopVariantSummary>
      </Variants>
      <ViewOrder>0</ViewOrder>
    </WebshopProductSummary>
  </Products>
  <StatusCode>0</StatusCode>
</WebshopCatalogResult>