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
import Foundation
import ServiceStack

public class WebshopOrderSearchRequest : Codable
{
    public var ownerId:Int?
    public var status:String?
    public var from:Date?
    public var to:Date?
    public var skip:Int?
    public var take:Int?

    required public init(){}
}

public class WebshopOrderSearchResult : Codable
{
    public var items:[WebshopOrderSummary] = []
    public var totalCount:Int?
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}

public class WebshopOrderSummary : Codable
{
    public var id:Int?
    public var orderReference:String?
    public var ownerId:Int?
    public var status:String?
    public var totalMinor:Int?
    public var deliveryFeeMinor:Int?
    public var totalDiscountMinor:Int?
    public var currency:String?
    public var buyerName:String?
    public var buyerEmail:String?
    public var buyerPhone:String?
    public var address:String?
    public var city:String?
    public var zipCode:String?
    public var country:String?
    public var deliveryType:String?
    public var droppOrderId:String?
    public var droppLocationId:String?
    public var needsDeliveryAttention:Bool?
    public var paymentMethodId:String?
    public var paymentId:String?
    public var paymentReference:String?
    public var discountCode:String?
    public var giftPaidMinor:Int?
    public var createdAt:Date?
    public var updatedAt:Date?
    public var lines:[WebshopOrderLineSummary] = []

    required public init(){}
}

public class WebshopOrderLineSummary : Codable
{
    public var id:Int?
    public var productId:Int?
    public var variantId:Int?
    public var productName:String?
    public var size:String?
    public var color:String?
    public var unitPriceMinor:Int?
    public var quantity:Int?
    public var lineTotalMinor:Int?
    public var status:String?
    public var payoutInfoId:Int?
    public var payoutTag:String?

    required public init(){}
}


Swift WebshopOrderSearchRequest 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/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>