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