| Requires any of the roles: | Admin, TeamAdmin | Required permission: | Tickets.Add |
| POST | /Webshop/Order/Refund |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LocalizedMessage:
is_: Optional[str] = field(metadata=config(field_name='is'), default=None)
en: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopRefundResult:
success: Optional[bool] = None
partial: Optional[bool] = None
refunded_amount_minor: Optional[int] = None
borgun_refund_transaction_id: Optional[str] = None
status: Optional[str] = None
message: Optional[LocalizedMessage] = None
status_code: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopOrderRefundRequest:
order_id: Optional[int] = None
order_reference: Optional[str] = None
line_ids: Optional[List[int]] = None
restock_lines: Optional[bool] = None
idempotency_key: Optional[str] = None
owner_id: Optional[int] = None
Python WebshopOrderRefundRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>