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 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 WebshopDeliveryOptions:
    pickup_allowed: Optional[bool] = None
    dropp_allowed: Optional[bool] = None
    shipped_allowed: Optional[bool] = None
    pickup_address: Optional[str] = None
    pickup_description: Optional[str] = None
    dropp_fee_minor: Optional[int] = None
    shipped_fee_minor: Optional[int] = None
    order_email: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopCatalogResult:
    owner_id: Optional[int] = None
    products: Optional[List[WebshopProductSummary]] = None
    delivery: Optional[WebshopDeliveryOptions] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopCatalogRequest:
    owner_id: Optional[int] = None
    external_id: Optional[str] = None

Python WebshopCatalogRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ownerId":0,"products":[{"id":0,"ownerId":0,"name":"String","description":"String","category":"String","subCategory":"String","defaultPriceMinor":0,"imageUrl":"String","viewOrder":0,"status":"String","payoutInfoId":0,"legacyItemId":0,"variants":[{"id":0,"productId":0,"size":"String","color":"String","stockOnHand":0,"quantitySold":0,"availableQuantity":0,"status":"String"}]}],"delivery":{"pickupAllowed":false,"droppAllowed":false,"shippedAllowed":false,"pickupAddress":"String","pickupDescription":"String","droppFeeMinor":0,"shippedFeeMinor":0,"orderEmail":"String"},"statusCode":0,"message":"String"}