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.*;

public class dtos
{

    public static class WebshopCatalogRequest
    {
        public Integer ownerId = null;
        public String externalId = null;
        
        public Integer getOwnerId() { return ownerId; }
        public WebshopCatalogRequest setOwnerId(Integer value) { this.ownerId = value; return this; }
        public String getExternalId() { return externalId; }
        public WebshopCatalogRequest setExternalId(String value) { this.externalId = value; return this; }
    }

    public static class WebshopCatalogResult
    {
        public Integer ownerId = null;
        public ArrayList<WebshopProductSummary> products = null;
        public WebshopDeliveryOptions delivery = null;
        public Integer statusCode = null;
        public String message = null;
        
        public Integer getOwnerId() { return ownerId; }
        public WebshopCatalogResult setOwnerId(Integer value) { this.ownerId = value; return this; }
        public ArrayList<WebshopProductSummary> getProducts() { return products; }
        public WebshopCatalogResult setProducts(ArrayList<WebshopProductSummary> value) { this.products = value; return this; }
        public WebshopDeliveryOptions getDelivery() { return delivery; }
        public WebshopCatalogResult setDelivery(WebshopDeliveryOptions value) { this.delivery = value; return this; }
        public Integer getStatusCode() { return statusCode; }
        public WebshopCatalogResult setStatusCode(Integer value) { this.statusCode = value; return this; }
        public String getMessage() { return message; }
        public WebshopCatalogResult setMessage(String value) { this.message = value; return this; }
    }

    public static class WebshopProductSummary
    {
        public Integer id = null;
        public Integer ownerId = null;
        public String name = null;
        public String description = null;
        public String category = null;
        public String subCategory = null;
        public Integer defaultPriceMinor = null;
        public String imageUrl = null;
        public Integer viewOrder = null;
        public String status = null;
        public Integer payoutInfoId = null;
        public Integer legacyItemId = null;
        public ArrayList<WebshopVariantSummary> variants = null;
        
        public Integer getId() { return id; }
        public WebshopProductSummary setId(Integer value) { this.id = value; return this; }
        public Integer getOwnerId() { return ownerId; }
        public WebshopProductSummary setOwnerId(Integer value) { this.ownerId = value; return this; }
        public String getName() { return name; }
        public WebshopProductSummary setName(String value) { this.name = value; return this; }
        public String getDescription() { return description; }
        public WebshopProductSummary setDescription(String value) { this.description = value; return this; }
        public String getCategory() { return category; }
        public WebshopProductSummary setCategory(String value) { this.category = value; return this; }
        public String getSubCategory() { return subCategory; }
        public WebshopProductSummary setSubCategory(String value) { this.subCategory = value; return this; }
        public Integer getDefaultPriceMinor() { return defaultPriceMinor; }
        public WebshopProductSummary setDefaultPriceMinor(Integer value) { this.defaultPriceMinor = value; return this; }
        public String getImageUrl() { return imageUrl; }
        public WebshopProductSummary setImageUrl(String value) { this.imageUrl = value; return this; }
        public Integer getViewOrder() { return viewOrder; }
        public WebshopProductSummary setViewOrder(Integer value) { this.viewOrder = value; return this; }
        public String getStatus() { return status; }
        public WebshopProductSummary setStatus(String value) { this.status = value; return this; }
        public Integer getPayoutInfoId() { return payoutInfoId; }
        public WebshopProductSummary setPayoutInfoId(Integer value) { this.payoutInfoId = value; return this; }
        public Integer getLegacyItemId() { return legacyItemId; }
        public WebshopProductSummary setLegacyItemId(Integer value) { this.legacyItemId = value; return this; }
        public ArrayList<WebshopVariantSummary> getVariants() { return variants; }
        public WebshopProductSummary setVariants(ArrayList<WebshopVariantSummary> value) { this.variants = value; return this; }
    }

    public static class WebshopVariantSummary
    {
        public Integer id = null;
        public Integer productId = null;
        public String size = null;
        public String color = null;
        public Integer stockOnHand = null;
        public Integer quantitySold = null;
        public Integer availableQuantity = null;
        public String status = null;
        
        public Integer getId() { return id; }
        public WebshopVariantSummary setId(Integer value) { this.id = value; return this; }
        public Integer getProductId() { return productId; }
        public WebshopVariantSummary setProductId(Integer value) { this.productId = value; return this; }
        public String getSize() { return size; }
        public WebshopVariantSummary setSize(String value) { this.size = value; return this; }
        public String getColor() { return color; }
        public WebshopVariantSummary setColor(String value) { this.color = value; return this; }
        public Integer getStockOnHand() { return stockOnHand; }
        public WebshopVariantSummary setStockOnHand(Integer value) { this.stockOnHand = value; return this; }
        public Integer getQuantitySold() { return quantitySold; }
        public WebshopVariantSummary setQuantitySold(Integer value) { this.quantitySold = value; return this; }
        public Integer getAvailableQuantity() { return availableQuantity; }
        public WebshopVariantSummary setAvailableQuantity(Integer value) { this.availableQuantity = value; return this; }
        public String getStatus() { return status; }
        public WebshopVariantSummary setStatus(String value) { this.status = value; return this; }
    }

    public static class WebshopDeliveryOptions
    {
        public Boolean pickupAllowed = null;
        public Boolean droppAllowed = null;
        public Boolean shippedAllowed = null;
        public String pickupAddress = null;
        public String pickupDescription = null;
        public Integer droppFeeMinor = null;
        public Integer shippedFeeMinor = null;
        public String orderEmail = null;
        
        public Boolean isPickupAllowed() { return pickupAllowed; }
        public WebshopDeliveryOptions setPickupAllowed(Boolean value) { this.pickupAllowed = value; return this; }
        public Boolean isDroppAllowed() { return droppAllowed; }
        public WebshopDeliveryOptions setDroppAllowed(Boolean value) { this.droppAllowed = value; return this; }
        public Boolean isShippedAllowed() { return shippedAllowed; }
        public WebshopDeliveryOptions setShippedAllowed(Boolean value) { this.shippedAllowed = value; return this; }
        public String getPickupAddress() { return pickupAddress; }
        public WebshopDeliveryOptions setPickupAddress(String value) { this.pickupAddress = value; return this; }
        public String getPickupDescription() { return pickupDescription; }
        public WebshopDeliveryOptions setPickupDescription(String value) { this.pickupDescription = value; return this; }
        public Integer getDroppFeeMinor() { return droppFeeMinor; }
        public WebshopDeliveryOptions setDroppFeeMinor(Integer value) { this.droppFeeMinor = value; return this; }
        public Integer getShippedFeeMinor() { return shippedFeeMinor; }
        public WebshopDeliveryOptions setShippedFeeMinor(Integer value) { this.shippedFeeMinor = value; return this; }
        public String getOrderEmail() { return orderEmail; }
        public WebshopDeliveryOptions setOrderEmail(String value) { this.orderEmail = value; return this; }
    }

}

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