Refund
Query refunds
Queries all refunds.
Parameters for "Query refunds"
POST/API/Refund/Query
Request Example
curl -X POST 'https://mgmtapi.geins.io/API/Refund/Query' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic [USER-CREDENTIALS-BASE64-ENCODED]' \
-H 'X-ApiKey: {MGMT_API_KEY}'\
-d '{
"CreatedAfter": "string",
"CreatedBefore": "string",
"ApprovedAfter": "string",
"ApprovedBefore": "string",
"UpdatedAfter": "string",
"UpdatedBefore": "string",
"IncludeStatuses": [
0
],
"ExcludeStatuses": [
0
]
}'
import axios from 'axios';
const config = {
method: 'POST',
url: 'https://mgmtapi.geins.io/API/Refund/Query',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Authorization': 'Basic [USER-CREDENTIALS-BASE64-ENCODED]',
'X-ApiKey': '{MGMT_API_KEY}'
},
data: {
"CreatedAfter": "string",
"CreatedBefore": "string",
"ApprovedAfter": "string",
"ApprovedBefore": "string",
"UpdatedAfter": "string",
"UpdatedBefore": "string",
"IncludeStatuses": [
0
],
"ExcludeStatuses": [
0
]
}
};
axios.request(config)
.then(response => response.data)
.catch(error => console.error(error));
fetch('https://mgmtapi.geins.io/API/Refund/Query', {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Authorization': 'Basic [USER-CREDENTIALS-BASE64-ENCODED]',
'X-ApiKey': '{MGMT_API_KEY}'
},
body: JSON.stringify({
"CreatedAfter": "string",
"CreatedBefore": "string",
"ApprovedAfter": "string",
"ApprovedBefore": "string",
"UpdatedAfter": "string",
"UpdatedBefore": "string",
"IncludeStatuses": [
0
],
"ExcludeStatuses": [
0
]
})
})
.then(res => res.json())
.then((response) => response)
.catch(console.error);
import requests
url = "https://mgmtapi.geins.io/API/Refund/Query"
headers = {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Authorization': 'Basic [USER-CREDENTIALS-BASE64-ENCODED]',
'X-ApiKey': '{MGMT_API_KEY}'
}
payload = {
"CreatedAfter": "string",
"CreatedBefore": "string",
"ApprovedAfter": "string",
"ApprovedBefore": "string",
"UpdatedAfter": "string",
"UpdatedBefore": "string",
"IncludeStatuses": [
0
],
"ExcludeStatuses": [
0
]
}
response = requests.POST(url, json=payload, headers=headers)
print(response.json())
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
url := "https://mgmtapi.geins.io/API/Refund/Query"
payload := []byte(`{
"CreatedAfter": "string",
"CreatedBefore": "string",
"ApprovedAfter": "string",
"ApprovedBefore": "string",
"UpdatedAfter": "string",
"UpdatedBefore": "string",
"IncludeStatuses": [
0
],
"ExcludeStatuses": [
0
]
}`)
req, _ := http.NewRequest("POST", url, bytes.NewBuffer(payload))
req.Header.Add("Accept", "application/json")
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "Basic [USER-CREDENTIALS-BASE64-ENCODED]")
req.Header.Add("X-ApiKey", "{MGMT_API_KEY}")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
using System.Text;
using System.Text.Json;
using System.Net.Http;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Basic [USER-CREDENTIALS-BASE64-ENCODED]");
client.DefaultRequestHeaders.Add("X-ApiKey", "{MGMT_API_KEY}");
var body = new
{
CreatedAfter = "string",
CreatedBefore = "string",
ApprovedAfter = "string",
ApprovedBefore = "string",
UpdatedAfter = "string",
UpdatedBefore = "string",
IncludeStatuses = new[]
{
0
},
ExcludeStatuses = new[]
{
0
}
};
var jsonContent = JsonSerializer.Serialize(body);
var content = new StringContent(jsonContent, Encoding.UTF8, "application/json");
var response = await client.POSTAsync("https://mgmtapi.geins.io/API/Refund/Query", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
Response
{
"Resource": [
{
"RefundId": "00000000-0000-0000-0000-000000000000",
"RefundInstanceId": 0,
"OrderId": 0,
"Reference": "string",
"Description": "string",
"Author": "string",
"ExternalOrderId": "string",
"OrderTransactionId": "string",
"SecondaryOrderTransactionId": "string",
"ExternalId": "string",
"PaymentName": "string",
"Locale": "string",
"SiteName": "string",
"Customer": "string",
"OrderSum": 0,
"OrderVat": 0,
"OrderValue": 0,
"OrderDiscount": 0,
"ShippingFee": 0,
"PaymentFee": 0,
"Currency": "string",
"CreatedOn": "string",
"SentOn": "string",
"ProcessedOn": "string",
"Sent": true,
"Processed": true,
"RequiresApproval": true,
"Approved": true,
"ApprovalDecidedBy": "string",
"ApprovalDecidedOn": "string",
"VatRate": 0,
"SkipRefundEvents": true,
"RefundedItemTotal": 0,
"RefundedShippingFee": 0,
"OrderStatus": "string",
"RefundedPaymentFee": 0,
"RefundedDiscount": 0,
"Shipped": true,
"RefundedBalance": 0,
"RefundedTotal": 0,
"RefundRows": [
{
"OrderId": 0,
"RefundRowId": 0,
"OrderRowId": 0,
"CaptureId": "00000000-0000-0000-0000-000000000000",
"RefundAmount": 0,
"RefundAmountExVat": 0,
"ToBalance": true,
"Settled": true,
"SettledOn": "string",
"CreatedOn": "string",
"Investigation": true,
"RefundType": 0
}
],
"Rows": [
{
"OrderRowId": 0,
"ItemId": 0,
"ProductId": 0,
"Price": 0,
"PriceExVat": 0,
"Name": "string",
"ProductName": "string",
"Variant": "string",
"Brand": "string",
"PrimaryImage": "string",
"ArticleNumber": "string",
"Shelf": "string",
"CampaignNames": "string",
"Discount": 0,
"SuggestedRefundAmount": 0,
"AverageDiscount": 0,
"PriceBeforeDiscount": 0
}
]
}
],
"Message": "string",
"Details": [
"string"
]
}
{
"Message": "string",
"Details": [
"string"
]
}
{
"Message": "string",
"Details": [
"string"
]
}