TicketUserServices

<back to all web services

WebshopProductCreateRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Tickets.Add
The following routes are available for this service:
POST/Webshop/Product
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 WebshopProductResult:
    product: Optional[WebshopProductSummary] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopProduct:
    id: Optional[int] = None
    owner_id: Optional[int] = None
    # @StringLength(200)
    name: Optional[str] = None

    # @StringLength(2000)
    description: Optional[str] = None

    # @StringLength(150)
    category: Optional[str] = None

    # @StringLength(150)
    sub_category: Optional[str] = None

    default_price_minor: Optional[int] = None
    # @StringLength(1500)
    image_url: Optional[str] = None

    view_order: Optional[int] = None
    # @StringLength(20)
    status: Optional[str] = None

    payout_info_id: Optional[int] = None
    legacy_item_id: Optional[int] = None
    created_at: Optional[datetime.datetime] = None
    updated_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopProductCreateRequest:
    item: Optional[WebshopProduct] = None
    owner_id: Optional[int] = None

Python WebshopProductCreateRequest 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 HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<WebshopProductCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types">
    <d2p1:Category>String</d2p1:Category>
    <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
    <d2p1:DefaultPriceMinor>0</d2p1:DefaultPriceMinor>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:ID>0</d2p1:ID>
    <d2p1:ImageUrl>String</d2p1:ImageUrl>
    <d2p1:LegacyItemId>0</d2p1:LegacyItemId>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:OwnerId>0</d2p1:OwnerId>
    <d2p1:PayoutInfoId>0</d2p1:PayoutInfoId>
    <d2p1:Status>String</d2p1:Status>
    <d2p1:SubCategory>String</d2p1:SubCategory>
    <d2p1:UpdatedAt>0001-01-01T00:00:00</d2p1:UpdatedAt>
    <d2p1:ViewOrder>0</d2p1:ViewOrder>
  </Item>
  <OwnerId>0</OwnerId>
</WebshopProductCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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