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

export class LocalizedMessage
{
    public is?: string;
    public en?: string;

    public constructor(init?: Partial<LocalizedMessage>) { (Object as any).assign(this, init); }
}

export class WebshopRefundResult
{
    public success?: boolean;
    public partial?: boolean;
    public refundedAmountMinor?: number;
    public borgunRefundTransactionId?: string;
    public status?: string;
    public message?: LocalizedMessage;
    public statusCode?: number;

    public constructor(init?: Partial<WebshopRefundResult>) { (Object as any).assign(this, init); }
}

export class WebshopOrderRefundRequest
{
    public orderId?: number;
    public orderReference?: string;
    public lineIds?: number[];
    public restockLines?: boolean;
    public idempotencyKey?: string;
    public ownerId?: number;

    public constructor(init?: Partial<WebshopOrderRefundRequest>) { (Object as any).assign(this, init); }
}

TypeScript WebshopOrderRefundRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"orderId":0,"orderReference":"String","lineIds":[0],"restockLines":false,"idempotencyKey":"String","ownerId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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