---
title: "order.refund.add"
method: POST
path: "/order.refund.add.json"
tags: ["order"]
---

# order.refund.add

`POST /order.refund.add.json`

## Request

- Base URL: `https://api.api2cart.com/v1.1`
- URL: `https://api.api2cart.com/v1.1/order.refund.add.json`
- Auth: API key in header `x-api-key` and API key in header `x-store-key`

Add a refund to the order.

## Request body

- OrderRefundAdd
  - `order_id` string: Defines the order for which the refund will be created.
  - `items` object[]: Defines items in the order that will be refunded
    - `order_product_id` string
    - `quantity` integer
    - `price` number
  - `total_price` number: Defines order refund amount.
  - `shipping_price` number: Defines refund shipping amount.
  - `fee_price` number: Specifies refund's fee price
  - `message` string: Refund reason, or some else message which assigned to refund.
  - `item_restock` boolean: Boolean, whether or not to add the line items back to the store inventory.
  - `send_notifications` boolean: Send notifications to customer after refund was created
  - `date` string: Specifies an order creation date in format Y-m-d H:i:s
  - `store_id` string: Store Id
  - `is_online` boolean: Indicates whether refund type is online
  - `idempotency_key` string: A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong>

## Response `200`

successful operation

- object
  - `return_code` integer
  - `return_message` string
  - `result` object
    - `refund_id` string
    - `additional_refund_ids` string, nullable

---

[API](https://skmtc.dev/api2cart/apis/api2cart-openapi.md) · [All operations](https://skmtc.dev/api2cart/apis/api2cart-openapi/llms.txt) · [OpenAPI document](https://skmtc.dev/api2cart/apis/api2cart-openapi/revisions/c34440741693?raw)