| Requires any of the roles: | Admin, TeamAdmin | Required permission: | Tickets.Add |
| PUT | /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 WebshopProductUpdateRequest:
item: Optional[WebshopProduct] = None
owner_id: Optional[int] = None
Python WebshopProductUpdateRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /Webshop/Product HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
item:
{
id: 0,
ownerId: 0,
name: String,
description: String,
category: String,
subCategory: String,
defaultPriceMinor: 0,
imageUrl: String,
viewOrder: 0,
status: String,
payoutInfoId: 0,
legacyItemId: 0,
createdAt: 0001-01-01,
updatedAt: 0001-01-01
},
ownerId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
product:
{
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
}
]
},
statusCode: 0,
message: String
}