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}
WebshopCatalogRequest Parameters:
NameParameterData TypeRequiredDescription
OwnerIdpathintNo
ExternalIdquerystringNo
WebshopCatalogResult Parameters:
NameParameterData TypeRequiredDescription
OwnerIdformintNo
ProductsformList<WebshopProductSummary>No
DeliveryformWebshopDeliveryOptionsNo
StatusCodeformintNo
MessageformstringNo
WebshopProductSummary Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
OwnerIdformintNo
NameformstringNo
DescriptionformstringNo
CategoryformstringNo
SubCategoryformstringNo
DefaultPriceMinorformintNo
ImageUrlformstringNo
ViewOrderformintNo
StatusformstringNo
PayoutInfoIdformint?No
LegacyItemIdformint?No
VariantsformList<WebshopVariantSummary>No
WebshopVariantSummary Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
ProductIdformintNo
SizeformstringNo
ColorformstringNo
StockOnHandformintNo
QuantitySoldformintNo
AvailableQuantityformintNo
StatusformstringNo
WebshopDeliveryOptions Parameters:
NameParameterData TypeRequiredDescription
PickupAllowedformboolNo
DroppAllowedformboolNo
ShippedAllowedformboolNo
PickupAddressformstringNo
PickupDescriptionformstringNo
DroppFeeMinorformintNo
ShippedFeeMinorformintNo
OrderEmailformstringNo

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"}