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

export class WebshopOrderLineSummary
{
    public id?: number;
    public productId?: number;
    public variantId?: number;
    public productName?: string;
    public size?: string;
    public color?: string;
    public unitPriceMinor?: number;
    public quantity?: number;
    public lineTotalMinor?: number;
    public status?: string;
    public payoutInfoId?: number;
    public payoutTag?: string;

    public constructor(init?: Partial<WebshopOrderLineSummary>) { (Object as any).assign(this, init); }
}

export class WebshopOrderSummary
{
    public id?: number;
    public orderReference?: string;
    public ownerId?: number;
    public status?: string;
    public totalMinor?: number;
    public deliveryFeeMinor?: number;
    public totalDiscountMinor?: number;
    public currency?: string;
    public buyerName?: string;
    public buyerEmail?: string;
    public buyerPhone?: string;
    public address?: string;
    public city?: string;
    public zipCode?: string;
    public country?: string;
    public deliveryType?: string;
    public droppOrderId?: string;
    public droppLocationId?: string;
    public needsDeliveryAttention?: boolean;
    public paymentMethodId?: string;
    public paymentId?: string;
    public paymentReference?: string;
    public discountCode?: string;
    public giftPaidMinor?: number;
    public createdAt?: string;
    public updatedAt?: string;
    public lines?: WebshopOrderLineSummary[];

    public constructor(init?: Partial<WebshopOrderSummary>) { (Object as any).assign(this, init); }
}

export class WebshopOrderSearchResult
{
    public items?: WebshopOrderSummary[];
    public totalCount?: number;
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<WebshopOrderSearchResult>) { (Object as any).assign(this, init); }
}

export class WebshopOrderSearchRequest
{
    public ownerId?: number;
    public status?: string;
    public from?: string;
    public to?: string;
    public skip?: number;
    public take?: number;

    public constructor(init?: Partial<WebshopOrderSearchRequest>) { (Object as any).assign(this, init); }
}

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