Estimate refund for a shipment or order
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/refund-estimates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"order_number": "<string>",
"shipment_number": "<string>"
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/refund-estimates"
payload = {
"order_number": "<string>",
"shipment_number": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({order_number: '<string>', shipment_number: '<string>'})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/refund-estimates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/refund-estimates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'order_number' => '<string>',
'shipment_number' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/refund-estimates"
payload := strings.NewReader("{\n \"order_number\": \"<string>\",\n \"shipment_number\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/refund-estimates")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"order_number\": \"<string>\",\n \"shipment_number\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/refund-estimates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"order_number\": \"<string>\",\n \"shipment_number\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"order": {
"order_number": "<string>",
"shipment_reference_number": "<string>",
"currency": {
"name": "<string>",
"code": "<string>",
"symbol": "<string>"
},
"refund_amount": 123,
"refund_amount_breakup": [
{
"original_payment_mode": "payment-gateway",
"original_payment_method": "<string>",
"amount": 123,
"label": "<string>"
}
],
"recommended_refund_mode": "<string>",
"available_refund_modes": [
"<string>"
],
"previous_refund_amount": 123,
"previous_refund_amount_breakup": [
{
"original_payment_mode": "payment-gateway",
"original_payment_method": "<string>",
"amount": 123,
"label": "<string>"
}
]
}
}
}Orders
Estimate refund for a shipment or order
Calculates the refund amount and breakdown for an order or a specific shipment before a cancellation is initiated. Returns an OrderRefundEstimate describing the total refundable amount, its split across the original payment modes/methods, the recommended and available refund modes, and any refunds already processed against the shipment. Use this to preview the refund the customer will receive and to let the operator pick a refund mode.
POST
/
orders
/
refund-estimates
Estimate refund for a shipment or order
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/refund-estimates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"order_number": "<string>",
"shipment_number": "<string>"
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/refund-estimates"
payload = {
"order_number": "<string>",
"shipment_number": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({order_number: '<string>', shipment_number: '<string>'})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/refund-estimates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/refund-estimates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'order_number' => '<string>',
'shipment_number' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/refund-estimates"
payload := strings.NewReader("{\n \"order_number\": \"<string>\",\n \"shipment_number\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/refund-estimates")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"order_number\": \"<string>\",\n \"shipment_number\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/refund-estimates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"order_number\": \"<string>\",\n \"shipment_number\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"order": {
"order_number": "<string>",
"shipment_reference_number": "<string>",
"currency": {
"name": "<string>",
"code": "<string>",
"symbol": "<string>"
},
"refund_amount": 123,
"refund_amount_breakup": [
{
"original_payment_mode": "payment-gateway",
"original_payment_method": "<string>",
"amount": 123,
"label": "<string>"
}
],
"recommended_refund_mode": "<string>",
"available_refund_modes": [
"<string>"
],
"previous_refund_amount": 123,
"previous_refund_amount_breakup": [
{
"original_payment_mode": "payment-gateway",
"original_payment_method": "<string>",
"amount": 123,
"label": "<string>"
}
]
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Was this page helpful?
⌘I