pos-refund-shortfall

Method: POST
Path: /pos/shipping/shipments/{order_number}/refund-shortfall

Tags: POSAdmin

Summary

Refund shortfall

Description

Refund shortfall

Pos SDK Usage

SDK Method: pos.refundShortfall()

Example:

const { data, error } = await pos.refundShortfall(
  { order_number: "ORD-2024-001234" },
  {
    items: [
      {
        sku: "SKU-123",
        quantity: 2,
        free_quantity: 0
      }
    ],
    payment_method: "original-payment-mode"
  }
);

if (error) {
  console.error("Failed to process refund:", error.message);
} else {
  console.log("Refund processed:", data.message);
  console.log("Success:", data.success);
}

// Refund to bank transfer
const { data: bankData, error: bankError } = await pos.refundShortfall(
  { order_number: "ORD-2024-001234" },
  {
    items: [{ sku: "SKU-123", quantity: 1 }],
    payment_method: "bank-transfer",
    bank_account_id: "BANK_ACC_123"
  }
);

TypeScript Definition

"pos-refund-shortfall": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Order Number */
                order_number: string;
            };
            cookie?: never;
        };
        requestBody?: {
            content: {
                "application/json": {
                    items: {
                        sku: string;
                        quantity: number;
                        /** @default 0 */
                        free_quantity?: number;
                    }[];
                    /** @enum {unknown} */
                    payment_method: "original-payment-mode" | "bank-transfer";
                    /** @description required if payment_method = bank-transfer */
                    bank_account_id?: string | null;
                };
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                    };
                };
            };
        };
    };

Parameters

• order_number (path): Order Number

Request Body

Content Types: application/json

Responses

200

OK

OpenAPI Definition

{
  "operationId": "pos-refund-shortfall",
  "summary": "Refund shortfall",
  "description": "Refund shortfall",
  "parameters": [
    {
      "name": "order_number",
      "in": "path",
      "description": "Order Number",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "items": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "sku",
                  "quantity"
                ],
                "properties": {
                  "sku": {
                    "type": "string"
                  },
                  "quantity": {
                    "type": "integer"
                  },
                  "free_quantity": {
                    "type": "integer",
                    "default": 0
                  }
                }
              }
            },
            "payment_method": {
              "enum": [
                "original-payment-mode",
                "bank-transfer"
              ]
            },
            "bank_account_id": {
              "description": "required if payment_method = bank-transfer",
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "items",
            "payment_method"
          ]
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              }
            }
          }
        }
      }
    }
  },
  "tags": [
    "POSAdmin"
  ],
  "x-speakeasy-group": "pos",
  "x-speakeasy-ignore": true
}

---

Auto-generated from OpenAPI spec and TypeScript definitions