Shipments
Refund shortfall
Refunds items of an order’s unscheduled shipment that won’t be shipped: the shortfall moves to a shipment of its own and is refunded by the original payment or by bank transfer, never beyond what the order’s payments have left. Fails with a 409, changing nothing, while refunds are briefly unavailable or the order’s payment is held for an admin’s review. A refund of a cash or other offline payment in the original mode is manual: done at once when the store marks that payment method paid, else pending until an admin marks it paid or forfeits it.
POST
/
shipping
/
shipments
/
{order_number}
/
refund-shortfall
Refund shortfall
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/shipping/shipments/{order_number}/refund-shortfall \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"product_id": "<string>",
"variant_id": "<string>",
"quantity": 1,
"free_quantity": 0
}
],
"payment_method": "original-payment-mode",
"bank_account_id": "<string>"
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/shipping/shipments/{order_number}/refund-shortfall"
payload = {
"items": [
{
"product_id": "<string>",
"variant_id": "<string>",
"quantity": 1,
"free_quantity": 0
}
],
"payment_method": "original-payment-mode",
"bank_account_id": "<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({
items: [
{product_id: '<string>', variant_id: '<string>', quantity: 1, free_quantity: 0}
],
payment_method: 'original-payment-mode',
bank_account_id: '<string>'
})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/shipping/shipments/{order_number}/refund-shortfall', 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/shipping/shipments/{order_number}/refund-shortfall",
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([
'items' => [
[
'product_id' => '<string>',
'variant_id' => '<string>',
'quantity' => 1,
'free_quantity' => 0
]
],
'payment_method' => 'original-payment-mode',
'bank_account_id' => '<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/shipping/shipments/{order_number}/refund-shortfall"
payload := strings.NewReader("{\n \"items\": [\n {\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"quantity\": 1,\n \"free_quantity\": 0\n }\n ],\n \"payment_method\": \"original-payment-mode\",\n \"bank_account_id\": \"<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/shipping/shipments/{order_number}/refund-shortfall")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"quantity\": 1,\n \"free_quantity\": 0\n }\n ],\n \"payment_method\": \"original-payment-mode\",\n \"bank_account_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/shipping/shipments/{order_number}/refund-shortfall")
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 \"items\": [\n {\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"quantity\": 1,\n \"free_quantity\": 0\n }\n ],\n \"payment_method\": \"original-payment-mode\",\n \"bank_account_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true
}{
"message": "<string>",
"success": true,
"code": "<string>",
"errors": {},
"content": {},
"details": "<string>"
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>"
}{
"message": "A shortfall refund waits for the payment ledger update to finish; try again shortly",
"success": false
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>",
"error_id": "<string>"
}Authorizations
Body
application/json
- RefundShortfallToOriginalPaymentMode
- RefundShortfallByBankTransfer
Was this page helpful?
⌘I
Refund shortfall
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/shipping/shipments/{order_number}/refund-shortfall \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"product_id": "<string>",
"variant_id": "<string>",
"quantity": 1,
"free_quantity": 0
}
],
"payment_method": "original-payment-mode",
"bank_account_id": "<string>"
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/shipping/shipments/{order_number}/refund-shortfall"
payload = {
"items": [
{
"product_id": "<string>",
"variant_id": "<string>",
"quantity": 1,
"free_quantity": 0
}
],
"payment_method": "original-payment-mode",
"bank_account_id": "<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({
items: [
{product_id: '<string>', variant_id: '<string>', quantity: 1, free_quantity: 0}
],
payment_method: 'original-payment-mode',
bank_account_id: '<string>'
})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/shipping/shipments/{order_number}/refund-shortfall', 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/shipping/shipments/{order_number}/refund-shortfall",
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([
'items' => [
[
'product_id' => '<string>',
'variant_id' => '<string>',
'quantity' => 1,
'free_quantity' => 0
]
],
'payment_method' => 'original-payment-mode',
'bank_account_id' => '<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/shipping/shipments/{order_number}/refund-shortfall"
payload := strings.NewReader("{\n \"items\": [\n {\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"quantity\": 1,\n \"free_quantity\": 0\n }\n ],\n \"payment_method\": \"original-payment-mode\",\n \"bank_account_id\": \"<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/shipping/shipments/{order_number}/refund-shortfall")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"quantity\": 1,\n \"free_quantity\": 0\n }\n ],\n \"payment_method\": \"original-payment-mode\",\n \"bank_account_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/shipping/shipments/{order_number}/refund-shortfall")
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 \"items\": [\n {\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"quantity\": 1,\n \"free_quantity\": 0\n }\n ],\n \"payment_method\": \"original-payment-mode\",\n \"bank_account_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true
}{
"message": "<string>",
"success": true,
"code": "<string>",
"errors": {},
"content": {},
"details": "<string>"
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>"
}{
"message": "A shortfall refund waits for the payment ledger update to finish; try again shortly",
"success": false
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>",
"error_id": "<string>"
}