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
import Foundation
import ServiceStack

public class WebshopOrderRefundRequest : Codable
{
    public var orderId:Int?
    public var orderReference:String?
    public var lineIds:[Int] = []
    public var restockLines:Bool?
    public var idempotencyKey:String?
    public var ownerId:Int?

    required public init(){}
}

public class WebshopRefundResult : Codable
{
    public var success:Bool?
    public var partial:Bool?
    public var refundedAmountMinor:Int?
    public var borgunRefundTransactionId:String?
    public var status:String?
    public var message:LocalizedMessage?
    public var statusCode:Int?

    required public init(){}
}

public class LocalizedMessage : Codable
{
    public var `is`:String?
    public var en:String?

    required public init(){}
}


Swift 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>