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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports TicketUserServices.ServiceModel

Namespace Global

    Namespace TicketUserServices.ServiceModel

        Public Partial Class LocalizedMessage
            Public Overridable Property [Is] As String
            Public Overridable Property En As String
        End Class

        Public Partial Class WebshopOrderRefundRequest
            Public Sub New()
                LineIds = New List(Of Integer)
            End Sub

            Public Overridable Property OrderId As Nullable(Of Integer)
            Public Overridable Property OrderReference As String
            Public Overridable Property LineIds As List(Of Integer)
            Public Overridable Property RestockLines As Boolean
            Public Overridable Property IdempotencyKey As String
            Public Overridable Property OwnerId As Nullable(Of Integer)
        End Class

        Public Partial Class WebshopRefundResult
            Public Overridable Property Success As Boolean
            Public Overridable Property Partial As Boolean
            Public Overridable Property RefundedAmountMinor As Integer
            Public Overridable Property BorgunRefundTransactionId As String
            Public Overridable Property Status As String
            Public Overridable Property Message As LocalizedMessage
            Public Overridable Property StatusCode As Integer
        End Class
    End Namespace
End Namespace

VB.NET WebshopOrderRefundRequest 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/Refund HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<WebshopOrderRefundRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <IdempotencyKey>String</IdempotencyKey>
  <LineIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </LineIds>
  <OrderId>0</OrderId>
  <OrderReference>String</OrderReference>
  <OwnerId>0</OwnerId>
  <RestockLines>false</RestockLines>
</WebshopOrderRefundRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WebshopRefundResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <BorgunRefundTransactionId>String</BorgunRefundTransactionId>
  <Message>
    <En>String</En>
    <Is>String</Is>
  </Message>
  <Partial>false</Partial>
  <RefundedAmountMinor>0</RefundedAmountMinor>
  <Status>String</Status>
  <StatusCode>0</StatusCode>
  <Success>false</Success>
</WebshopRefundResult>