TicketUserServices

<back to all web services

WebshopProductSearchRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequires the permission:ReadData
The following routes are available for this service:
POST/Webshop/Product/Search
WebshopProductSearchRequest Parameters:
NameParameterData TypeRequiredDescription
OwnerIdbodyint?No
StatusbodystringNo
CategorybodystringNo
TextbodystringNo
Skipbodyint?No
Takebodyint?No
WebshopProductSearchResult Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<WebshopProductSummary>No
TotalCountformintNo
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

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.

POST /Webshop/Product/Search HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<WebshopProductSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Category>String</Category>
  <OwnerId>0</OwnerId>
  <Skip>0</Skip>
  <Status>String</Status>
  <Take>0</Take>
  <Text>String</Text>
</WebshopProductSearchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WebshopProductSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Items>
    <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>
  </Items>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
  <TotalCount>0</TotalCount>
</WebshopProductSearchResult>