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}
WebshopCatalogRequest Parameters:
NameParameterData TypeRequiredDescription
OwnerIdpathintNo
ExternalIdquerystringNo
WebshopCatalogResult Parameters:
NameParameterData TypeRequiredDescription
OwnerIdformintNo
ProductsformList<WebshopProductSummary>No
DeliveryformWebshopDeliveryOptionsNo
StatusCodeformintNo
MessageformstringNo
WebshopProductSummary Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
OwnerIdformintNo
NameformstringNo
DescriptionformstringNo
CategoryformstringNo
SubCategoryformstringNo
DefaultPriceMinorformintNo
ImageUrlformstringNo
ViewOrderformintNo
StatusformstringNo
PayoutInfoIdformint?No
LegacyItemIdformint?No
VariantsformList<WebshopVariantSummary>No
WebshopVariantSummary Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
ProductIdformintNo
SizeformstringNo
ColorformstringNo
StockOnHandformintNo
QuantitySoldformintNo
AvailableQuantityformintNo
StatusformstringNo
WebshopDeliveryOptions Parameters:
NameParameterData TypeRequiredDescription
PickupAllowedformboolNo
DroppAllowedformboolNo
ShippedAllowedformboolNo
PickupAddressformstringNo
PickupDescriptionformstringNo
DroppFeeMinorformintNo
ShippedFeeMinorformintNo
OrderEmailformstringNo

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>