| Requires any of the roles: | Admin, TeamAdmin, MobileApp | Requires the permission: | ReadData |
| GET | /Webshop/Order/{Reference} |
|---|
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 LocalizedMessage:
is_: Optional[str] = field(metadata=config(field_name='is'), default=None)
en: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopOrderLineSummary:
id: Optional[int] = None
product_id: Optional[int] = None
variant_id: Optional[int] = None
product_name: Optional[str] = None
size: Optional[str] = None
color: Optional[str] = None
unit_price_minor: Optional[int] = None
quantity: Optional[int] = None
line_total_minor: Optional[int] = None
status: Optional[str] = None
payout_info_id: Optional[int] = None
payout_tag: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopOrderSummary:
id: Optional[int] = None
order_reference: Optional[str] = None
owner_id: Optional[int] = None
status: Optional[str] = None
total_minor: Optional[int] = None
delivery_fee_minor: Optional[int] = None
total_discount_minor: Optional[int] = None
currency: Optional[str] = None
buyer_name: Optional[str] = None
buyer_email: Optional[str] = None
buyer_phone: Optional[str] = None
address: Optional[str] = None
city: Optional[str] = None
zip_code: Optional[str] = None
country: Optional[str] = None
delivery_type: Optional[str] = None
dropp_order_id: Optional[str] = None
dropp_location_id: Optional[str] = None
needs_delivery_attention: Optional[bool] = None
payment_method_id: Optional[str] = None
payment_id: Optional[str] = None
payment_reference: Optional[str] = None
discount_code: Optional[str] = None
gift_paid_minor: Optional[int] = None
created_at: Optional[datetime.datetime] = None
updated_at: Optional[datetime.datetime] = None
lines: Optional[List[WebshopOrderLineSummary]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopOrderResult:
success: Optional[bool] = None
reason: Optional[str] = None
message: Optional[LocalizedMessage] = None
order_reference: Optional[str] = None
order: Optional[WebshopOrderSummary] = None
status_code: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopOrderGetRequest:
reference: Optional[str] = None
owner_id: Optional[int] = None
Python WebshopOrderGetRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Webshop/Order/{Reference} HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"success":false,"reason":"String","message":{"is":"String","en":"String"},"orderReference":"String","order":{"id":0,"orderReference":"String","ownerId":0,"status":"String","totalMinor":0,"deliveryFeeMinor":0,"totalDiscountMinor":0,"currency":"String","buyerName":"String","buyerEmail":"String","buyerPhone":"String","address":"String","city":"String","zipCode":"String","country":"String","deliveryType":"String","droppOrderId":"String","droppLocationId":"String","needsDeliveryAttention":false,"paymentMethodId":"String","paymentId":"String","paymentReference":"String","discountCode":"String","giftPaidMinor":0,"createdAt":"0001-01-01T00:00:00.0000000","updatedAt":"0001-01-01T00:00:00.0000000","lines":[{"id":0,"productId":0,"variantId":0,"productName":"String","size":"String","color":"String","unitPriceMinor":0,"quantity":0,"lineTotalMinor":0,"status":"String","payoutInfoId":0,"payoutTag":"String"}]},"statusCode":0}