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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopVariantSummary:
    id: Optional[int] = None
    product_id: Optional[int] = None
    size: Optional[str] = None
    color: Optional[str] = None
    stock_on_hand: Optional[int] = None
    quantity_sold: Optional[int] = None
    available_quantity: Optional[int] = None
    status: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopProductSummary:
    id: Optional[int] = None
    owner_id: Optional[int] = None
    name: Optional[str] = None
    description: Optional[str] = None
    category: Optional[str] = None
    sub_category: Optional[str] = None
    default_price_minor: Optional[int] = None
    image_url: Optional[str] = None
    view_order: Optional[int] = None
    status: Optional[str] = None
    payout_info_id: Optional[int] = None
    legacy_item_id: Optional[int] = None
    variants: Optional[List[WebshopVariantSummary]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopProductSearchResult:
    items: Optional[List[WebshopProductSummary]] = None
    total_count: Optional[int] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopProductSearchRequest:
    owner_id: Optional[int] = None
    status: Optional[str] = None
    category: Optional[str] = None
    text: Optional[str] = None
    skip: Optional[int] = None
    take: Optional[int] = None

Python WebshopProductSearchRequest 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.

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>