TicketUserServices

<back to all web services

WebshopOrderRefundRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Tickets.Add
The following routes are available for this service:
POST/Webshop/Order/Refund
WebshopOrderRefundRequest Parameters:
NameParameterData TypeRequiredDescription
OrderIdbodyint?No
OrderReferencebodystringNo
LineIdsbodyList<int>No
RestockLinesbodyboolNo
IdempotencyKeybodystringNo
OwnerIdbodyint?No
WebshopRefundResult Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
PartialformboolNo
RefundedAmountMinorformintNo
BorgunRefundTransactionIdformstringNo
StatusformstringNo
MessageformLocalizedMessageNo
StatusCodeformintNo
LocalizedMessage Parameters:
NameParameterData TypeRequiredDescription
IsformstringNo
EnformstringNo

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/Refund HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	orderId: 0,
	orderReference: String,
	lineIds: 
	[
		0
	],
	restockLines: False,
	idempotencyKey: String,
	ownerId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	success: False,
	partial: False,
	refundedAmountMinor: 0,
	borgunRefundTransactionId: String,
	status: String,
	message: 
	{
		is: String,
		en: String
	},
	statusCode: 0
}