TicketUserServices

<back to all web services

WebshopOrderSearchRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequires the permission:ReadData
The following routes are available for this service:
POST/Webshop/Order/Search
WebshopOrderSearchRequest Parameters:
NameParameterData TypeRequiredDescription
OwnerIdbodyint?No
StatusbodystringNo
FrombodyDateTime?No
TobodyDateTime?No
Skipbodyint?No
Takebodyint?No
WebshopOrderSearchResult Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<WebshopOrderSummary>No
TotalCountformintNo
StatusCodeformintNo
MessageformstringNo
WebshopOrderSummary Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
OrderReferenceformstringNo
OwnerIdformintNo
StatusformstringNo
TotalMinorformintNo
DeliveryFeeMinorformintNo
TotalDiscountMinorformintNo
CurrencyformstringNo
BuyerNameformstringNo
BuyerEmailformstringNo
BuyerPhoneformstringNo
AddressformstringNo
CityformstringNo
ZipCodeformstringNo
CountryformstringNo
DeliveryTypeformstringNo
DroppOrderIdformstringNo
DroppLocationIdformstringNo
NeedsDeliveryAttentionformboolNo
PaymentMethodIdformstringNo
PaymentIdformstringNo
PaymentReferenceformstringNo
DiscountCodeformstringNo
GiftPaidMinorformintNo
CreatedAtformDateTimeNo
UpdatedAtformDateTimeNo
LinesformList<WebshopOrderLineSummary>No
WebshopOrderLineSummary Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
ProductIdformintNo
VariantIdformintNo
ProductNameformstringNo
SizeformstringNo
ColorformstringNo
UnitPriceMinorformintNo
QuantityformintNo
LineTotalMinorformintNo
StatusformstringNo
PayoutInfoIdformint?No
PayoutTagformstringNo

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

<WebshopOrderSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <From>0001-01-01T00:00:00</From>
  <OwnerId>0</OwnerId>
  <Skip>0</Skip>
  <Status>String</Status>
  <Take>0</Take>
  <To>0001-01-01T00:00:00</To>
</WebshopOrderSearchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WebshopOrderSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Items>
    <WebshopOrderSummary>
      <Address>String</Address>
      <BuyerEmail>String</BuyerEmail>
      <BuyerName>String</BuyerName>
      <BuyerPhone>String</BuyerPhone>
      <City>String</City>
      <Country>String</Country>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <Currency>String</Currency>
      <DeliveryFeeMinor>0</DeliveryFeeMinor>
      <DeliveryType>String</DeliveryType>
      <DiscountCode>String</DiscountCode>
      <DroppLocationId>String</DroppLocationId>
      <DroppOrderId>String</DroppOrderId>
      <GiftPaidMinor>0</GiftPaidMinor>
      <ID>0</ID>
      <Lines>
        <WebshopOrderLineSummary>
          <Color>String</Color>
          <ID>0</ID>
          <LineTotalMinor>0</LineTotalMinor>
          <PayoutInfoId>0</PayoutInfoId>
          <PayoutTag>String</PayoutTag>
          <ProductId>0</ProductId>
          <ProductName>String</ProductName>
          <Quantity>0</Quantity>
          <Size>String</Size>
          <Status>String</Status>
          <UnitPriceMinor>0</UnitPriceMinor>
          <VariantId>0</VariantId>
        </WebshopOrderLineSummary>
      </Lines>
      <NeedsDeliveryAttention>false</NeedsDeliveryAttention>
      <OrderReference>String</OrderReference>
      <OwnerId>0</OwnerId>
      <PaymentId>String</PaymentId>
      <PaymentMethodId>String</PaymentMethodId>
      <PaymentReference>String</PaymentReference>
      <Status>String</Status>
      <TotalDiscountMinor>0</TotalDiscountMinor>
      <TotalMinor>0</TotalMinor>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <ZipCode>String</ZipCode>
    </WebshopOrderSummary>
  </Items>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
  <TotalCount>0</TotalCount>
</WebshopOrderSearchResult>