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 Foundation
import ServiceStack

public class WebshopCatalogRequest : Codable
{
    public var ownerId:Int?
    public var externalId:String?

    required public init(){}
}

public class WebshopCatalogResult : Codable
{
    public var ownerId:Int?
    public var products:[WebshopProductSummary] = []
    public var delivery:WebshopDeliveryOptions?
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}

public class WebshopProductSummary : Codable
{
    public var id:Int?
    public var ownerId:Int?
    public var name:String?
    public var Description:String?
    public var category:String?
    public var subCategory:String?
    public var defaultPriceMinor:Int?
    public var imageUrl:String?
    public var viewOrder:Int?
    public var status:String?
    public var payoutInfoId:Int?
    public var legacyItemId:Int?
    public var variants:[WebshopVariantSummary] = []

    required public init(){}
}

public class WebshopVariantSummary : Codable
{
    public var id:Int?
    public var productId:Int?
    public var size:String?
    public var color:String?
    public var stockOnHand:Int?
    public var quantitySold:Int?
    public var availableQuantity:Int?
    public var status:String?

    required public init(){}
}

public class WebshopDeliveryOptions : Codable
{
    public var pickupAllowed:Bool?
    public var droppAllowed:Bool?
    public var shippedAllowed:Bool?
    public var pickupAddress:String?
    public var pickupDescription:String?
    public var droppFeeMinor:Int?
    public var shippedFeeMinor:Int?
    public var orderEmail:String?

    required public init(){}
}


Swift 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>