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
namespace TicketUserServices.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type WebshopOrderLineSummary() = 
        member val ID:Int32 = new Int32() with get,set
        member val ProductId:Int32 = new Int32() with get,set
        member val VariantId:Int32 = new Int32() with get,set
        member val ProductName:String = null with get,set
        member val Size:String = null with get,set
        member val Color:String = null with get,set
        member val UnitPriceMinor:Int32 = new Int32() with get,set
        member val Quantity:Int32 = new Int32() with get,set
        member val LineTotalMinor:Int32 = new Int32() with get,set
        member val Status:String = null with get,set
        member val PayoutInfoId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PayoutTag:String = null with get,set

    [<AllowNullLiteral>]
    type WebshopOrderSummary() = 
        member val ID:Int32 = new Int32() with get,set
        member val OrderReference:String = null with get,set
        member val OwnerId:Int32 = new Int32() with get,set
        member val Status:String = null with get,set
        member val TotalMinor:Int32 = new Int32() with get,set
        member val DeliveryFeeMinor:Int32 = new Int32() with get,set
        member val TotalDiscountMinor:Int32 = new Int32() with get,set
        member val Currency:String = null with get,set
        member val BuyerName:String = null with get,set
        member val BuyerEmail:String = null with get,set
        member val BuyerPhone:String = null with get,set
        member val Address:String = null with get,set
        member val City:String = null with get,set
        member val ZipCode:String = null with get,set
        member val Country:String = null with get,set
        member val DeliveryType:String = null with get,set
        member val DroppOrderId:String = null with get,set
        member val DroppLocationId:String = null with get,set
        member val NeedsDeliveryAttention:Boolean = new Boolean() with get,set
        member val PaymentMethodId:String = null with get,set
        member val PaymentId:String = null with get,set
        member val PaymentReference:String = null with get,set
        member val DiscountCode:String = null with get,set
        member val GiftPaidMinor:Int32 = new Int32() with get,set
        member val CreatedAt:DateTime = new DateTime() with get,set
        member val UpdatedAt:DateTime = new DateTime() with get,set
        member val Lines:ResizeArray<WebshopOrderLineSummary> = new ResizeArray<WebshopOrderLineSummary>() with get,set

    [<AllowNullLiteral>]
    type WebshopOrderSearchResult() = 
        member val Items:ResizeArray<WebshopOrderSummary> = new ResizeArray<WebshopOrderSummary>() with get,set
        member val TotalCount:Int32 = new Int32() with get,set
        member val StatusCode:Int32 = new Int32() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type WebshopOrderSearchRequest() = 
        member val OwnerId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Status:String = null with get,set
        member val From:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val To:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set

F# WebshopOrderSearchRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ownerId: 0,
	status: String,
	from: 0001-01-01,
	to: 0001-01-01,
	skip: 0,
	take: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	items: 
	[
		{
			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-01,
			updatedAt: 0001-01-01,
			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
				}
			]
		}
	],
	totalCount: 0,
	statusCode: 0,
	message: String
}