TicketUserServices

<back to all web services

WebshopVariantCreateRequest

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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopProductVariant:
    id: Optional[int] = None
    product_id: Optional[int] = None
    # @StringLength(50)
    size: Optional[str] = None

    # @StringLength(50)
    color: Optional[str] = None

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

    version: Optional[int] = None
    legacy_detail_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 WebshopVariantCreateRequest:
    item: Optional[WebshopProductVariant] = None
    owner_id: Optional[int] = None

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

<WebshopVariantCreateRequest 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:Color>String</d2p1:Color>
    <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
    <d2p1:ID>0</d2p1:ID>
    <d2p1:LegacyDetailId>0</d2p1:LegacyDetailId>
    <d2p1:ProductId>0</d2p1:ProductId>
    <d2p1:QuantitySold>0</d2p1:QuantitySold>
    <d2p1:Size>String</d2p1:Size>
    <d2p1:Status>String</d2p1:Status>
    <d2p1:StockOnHand>0</d2p1:StockOnHand>
    <d2p1:UpdatedAt>0001-01-01T00:00:00</d2p1:UpdatedAt>
    <d2p1:Version>0</d2p1:Version>
  </Item>
  <OwnerId>0</OwnerId>
</WebshopVariantCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WebshopVariantResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Message>String</Message>
  <StatusCode>0</StatusCode>
  <Variant>
    <AvailableQuantity>0</AvailableQuantity>
    <Color>String</Color>
    <ID>0</ID>
    <ProductId>0</ProductId>
    <QuantitySold>0</QuantitySold>
    <Size>String</Size>
    <Status>String</Status>
    <StockOnHand>0</StockOnHand>
  </Variant>
</WebshopVariantResult>