Skip to main content

The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the GraphQL Admin API. For details and migration steps, visit our migration guide.

Refund

Requires ANY of the following access scopes: orders, marketplace_orders.

The Refund resource has two major components:

  • Transaction records of money returned to the customer
  • The line items included in the refund, along with restocking instructions

Before you create a refund, use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you're refunding shipping costs. You can then use the response of the calculate endpoint to create the actual refund.

When you create a refund using the response from the calculate endpoint, you can set additional options, such as whether to notify the customer of the refund. You can refund less than the calculated amount for either shipping or the line items by setting a custom value for the amount property.

If a refund includes shipping costs, or if you choose to refund line items for less than their calculated amount, then an order adjustment is created automatically to account for the discrepancy in the store's financial reports.

Was this section helpful?
#

Endpoints

Anchor to

The Refund resource

Anchor to

Properties

created_at
read-only
->
createdAt

The date and time (<a href='https://en.wikipedia.org/wiki/ISO_8601'target="_blank">ISO 8601 format) when the refund was created.

duties
read-only
->
duties

A list of duties that have been reimbursed as part of the refund.

id
read-only
->
id

The unique identifier for the refund.

note
->
note

An optional note attached to a refund.

order_adjustments
read-only
->
orderAdjustments

A list of order adjustments attached to the refund. Order adjustments are generated to account for refunded shipping costs and differences between calculated and actual refund amounts. As of the 2024-10 Admin API version, refunded shipping costs are no longer considered order adjustments and should be accessed through refund_shipping_lines. Each entry has the following properties:

Show order_adjustments properties
  • id: The unique identifier for the order adjustment.
  • order_id: The unique identifier for the order that the order adjustment is associated with.
  • refund_id: The unique identifier for the refund that the order adjustment is associated with.
  • amount: This field is deprecated, please use amount_set. The value of the discrepancy between the calculated refund and the actual refund. If the kind property's value is shipping_refund, then amount returns the value of shipping charges refunded to the customer.
  • tax_amount: This field is deprecated, please use tax_amount_set. The taxes that are added to amount, such as applicable shipping taxes added to a shipping refund.
  • kind: This field is deprecated as of the 2024-10 Admin API and will not be supported in the future. The order adjustment type. Valid values: shipping_refund and refund_discrepancy.
  • reason: The reason for the order adjustment. To set this value, include discrepancy_reason when you create a refund.
  • amount_set: The amount of the order adjustment in shop and presentment currencies.
  • tax_amount_set: The tax amount of the order adjustment in shop and presentment currencies.
processed_at
read-only
->
processedAt

The date and time (ISO 8601 format) when the refund was imported. This value can be set to a date in the past when importing from other systems. If no value is provided, then it will be auto-generated as the current time in Shopify. Public apps need to be granted permission by Shopify to import orders with the processed_at timestamp set to a value earlier the created_at timestamp. Private apps can't be granted permission by Shopify.

refund_duties
->
duties

A list of refunded duties. Each entry has the following properties:

Show refund_duties properties
  • duty_id: The unique identifier of the duty.
  • refund_type: Specifies how you want the duty refunded. Valid values:
    • FULL: Refunds all the duties associated with a duty ID. You do not need to include refund line items if you are using the full refund type.
    • PROPORTIONAL: Refunds duties in proportion to the line item quantity that you want to refund. If you choose the proportional refund type, then you must also pass the refund line items to calculate the portion of duties to refund.
refund_line_items
->
refundLineItems

A list of refunded line items. Each entry has the following properties:

Show refund_line_items properties
  • id: The unique identifier of the line item in the refund.
  • line_item: A line item being refunded.
  • line_item_id: The ID of the related line item in the order.
  • quantity: The refunded quantity of the associated line item.
  • restock_type: How this refund line item affects inventory levels. Valid values:
    • no_restock: Refunding these items won't affect inventory. The number of fulfillable units for this line item will remain unchanged. For example, a refund payment can be issued but no items will be refunded or made available for sale again.
    • cancel: The items have not yet been fulfilled. The canceled quantity will be added back to the available count. The number of fulfillable units for this line item will decrease.
    • return: The items were already delivered, and will be returned to the merchant. The refunded quantity will be added back to the available count. The number of fulfillable units for this line item will remain unchanged.
    • legacy_restock: The deprecated restock property was used for this refund. These items were made available for sale again. This value is not accepted when creating new refunds.
  • location_id: The unique identifier of the location where the items will be restocked. Required when restock_type has the value return or cancel.
  • subtotal: The subtotal of the refund line item.
  • total_tax: The total tax on the refund line item.
  • subtotal_set: The subtotal of the refund line item in shop and presentment currencies.
  • total_tax_set: The total tax of the line item in shop and presentment currencies.
refund_shipping_lines
read-only
->
refundShippingLines

A list of refunded shipping lines. Each entry has the following properties:

Show refund_shipping_lines properties
  • id: The unique identifier of the shipping line in the refund.
  • shipping_line: The shipping line being refunded.
  • shipping_line_id: The ID of the related shipping line in the order.
  • subtotal_amount_set: The subtotal of the refund shipping line in shop and presentment currencies.
restock
deprecated

Whether to add any of the line items back to the store's inventory. Use restock_type for refund line items instead.

transactions
->
transactions

A list of transactions involved in the refund. A single order can have multiple transactions associated with it. For more information, see the Transaction resource.

user_id
read-only
->
staffMember

The unique identifier of the user who performed the refund.

Was this section helpful?
{}

The Refund resource

{
"created_at": "2008-01-10T11:00:00-05:00",
"duties": {
"duties": [
{
"duty_id": 1,
"amount_set": {
"shop_money": {
"amount": "9.83",
"currency_code": "CAD"
},
"presentment_money": {
"amount": "9.83",
"currency_code": "CAD"
}
}
}
]
},
"id": 92738740,
"note": "Item was damaged during shipping",
"order_adjustments": [
{
"id": 4221763620,
"order_id": 171016912932,
"refund_id": 8244756516,
"amount": "10.00",
"tax_amount": "0.00",
"kind": "refund_discrepancy",
"reason": "Refund discrepancy",
"amount_set": {
"shop_money": {
"amount": 10,
"currency_code": "CAD"
},
"presentment_money": {
"amount": 7.3,
"currency_code": "USD"
}
},
"tax_amount_set": {
"shop_money": {
"amount": 0,
"currency_code": "CAD"
},
"presentment_money": {
"amount": 0,
"currency_code": "USD"
}
}
}
],
"processed_at": "2007-01-10T11:00:00-05:00",
"refund_duties": [
{
"duty_id": 1,
"refund_type": "FULL"
}
],
"refund_line_items": [
{
"id": 209341123,
"line_item": {},
"line_item_id": 128323456,
"quantity": 2,
"location_id": 40642626,
"restock_type": "return",
"subtotal": 10.99,
"total_tax": 2.67,
"subtotal_set": {
"shop_money": {
"amount": 10.99,
"currency_code": "CAD"
},
"presentment_money": {
"amount": 8.95,
"currency_code": "USD"
}
},
"total_tax_set": {
"shop_money": {
"amount": 1.67,
"currency_code": "CAD"
},
"presentment_money": {
"amount": 1.32,
"currency_code": "USD"
}
}
}
],
"refund_shipping_lines": [
{
"id": 712736824,
"shipping_line": {},
"shipping_line_id": 8845532987448,
"subtotal_amount_set": {
"shop_money": {
"amount": 5,
"currency_code": "CAD"
},
"presentment_money": {
"amount": 3.65,
"currency_code": "USD"
}
}
}
],
"restock": true,
"transactions": [
{
"id": 179259969,
"order_id": 450789469,
"amount": "209.00",
"kind": "refund",
"gateway": "shopify_payments",
"status": "success",
"message": null,
"created_at": "2005-08-05T12:59:12-04:00",
"test": false,
"authorization": "authorization-key",
"currency": "USD",
"location_id": null,
"user_id": null,
"parent_id": 801038806,
"device_id": null,
"receipt": {},
"error_code": null,
"source_name": "web"
}
],
"user_id": 238478920
}

Anchor to POST request, Creates a refund
post
Creates a refund

refundCreate
Caution

For multi-currency orders, the currency property is required whenever the amount property is provided.

Creates a refund. Use the calculate endpoint to produce the transactions to submit.


Note

When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute.

Anchor to Parameters of Creates a refundParameters

api_version
string
required
order_id
string
required
currency

The three-letter code (ISO 4217 format) for the currency used for the refund.

discrepancy_reason

An optional comment that explains a discrepancy between calculated and actual refund amounts. Used to populate the reason property of the resulting order_adjustment object attached to the refund. Valid values: restock, damage, customer, and other.

note

An optional note attached to a refund.

notify

Whether to send a refund notification to the customer.

refund_line_items

A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:

Show refund_line_items properties

  • line_item_id: The ID of a line item to refund.

  • quantity: The quantity to refund.

  • restock_type: How this refund line item affects inventory levels. Valid values:

    • no_restock: Refunding these items won't affect inventory.
    • cancel: The items have not yet been fulfilled. The canceled quantity will be added back to the available count. The number of fulfillable units for this line item will decrease.
    • return: The items were already delivered but will be returned to the merchant. The returned quantity will be added back to the available count. The number of fulfillable units for this line item will remain unchanged.

  • location_id: The ID of the location where the items should be restocked. This is required when the value of restock_type is return or cancel. If the item is not already stocked at the location, then the item is connected to the location. An error is returned when the item is connected to a fulfillment service location and a different location is provided.

restock
deprecated

Whether to add the line items back to the store inventory. Use restock_type for refund line items instead.

shipping

Specify how much shipping to refund. It has the following properties:

Show shipping properties

  • full_refund: Whether to refund all remaining shipping.

  • amount: Set a specific amount to refund for shipping. Takes precedence over full_refund.

transactions

A list of transactions to process as refunds. Use the calculate endpoint to obtain these transactions.

Was this section helpful?

Anchor to post-orders-order-id-refunds-examplesExamples

Create a refund for an order

Path parameters
order_id=450789469
string
required
Request body
refund
Refund resource
Show refund properties
refund.note:"wrong size"
->
note

An optional note attached to a refund.

refund.refund_line_items:[{"line_item_id":518995019,"quantity":1,"restock_type":"return","location_id":487838322}]
->
refundLineItems

A list of refunded line items. Each entry has the following properties:

Show refund_line_items properties
  • id: The unique identifier of the line item in the refund.
  • line_item: A line item being refunded.
  • line_item_id: The ID of the related line item in the order.
  • quantity: The refunded quantity of the associated line item.
  • restock_type: How this refund line item affects inventory levels. Valid values:
    • no_restock: Refunding these items won't affect inventory. The number of fulfillable units for this line item will remain unchanged. For example, a refund payment can be issued but no items will be refunded or made available for sale again.
    • cancel: The items have not yet been fulfilled. The canceled quantity will be added back to the available count. The number of fulfillable units for this line item will decrease.
    • return: The items were already delivered, and will be returned to the merchant. The refunded quantity will be added back to the available count. The number of fulfillable units for this line item will remain unchanged.
    • legacy_restock: The deprecated restock property was used for this refund. These items were made available for sale again. This value is not accepted when creating new refunds.
  • location_id: The unique identifier of the location where the items will be restocked. Required when restock_type has the value return or cancel.
  • subtotal: The subtotal of the refund line item.
  • total_tax: The total tax on the refund line item.
  • subtotal_set: The subtotal of the refund line item in shop and presentment currencies.
  • total_tax_set: The total tax of the line item in shop and presentment currencies.
refund.transactions:[{"parent_id":801038806,"amount":41.94,"kind":"refund","gateway":"bogus"}]
->
transactions

A list of transactions involved in the refund. A single order can have multiple transactions associated with it. For more information, see the Transaction resource.

Refund a specific amount of shipping

Path parameters
order_id=450789469
string
required
Request body
refund
Refund resource
Show refund properties
refund.transactions:[{"parent_id":801038806,"amount":5,"kind":"refund","gateway":"web"}]
->
transactions

A list of transactions involved in the refund. A single order can have multiple transactions associated with it. For more information, see the Transaction resource.

Was this section helpful?
post

/admin/api/2025-10/orders/450789469/refunds.json

curl -d '{"refund":{"currency":"USD","notify":true,"note":"wrong size","shipping":{"full_refund":true},"refund_line_items":[{"line_item_id":518995019,"quantity":1,"restock_type":"return","location_id":487838322}],"transactions":[{"parent_id":801038806,"amount":41.94,"kind":"refund","gateway":"bogus"}]}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2025-10/orders/450789469/refunds.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"

{}

Response

JSON
HTTP/1.1 201 Created
{
"refund": {
"id": 929361462,
"order_id": 450789469,
"created_at": "2025-10-01T14:53:52-04:00",
"note": "wrong size",
"user_id": null,
"processed_at": "2025-10-01T14:53:52-04:00",
"duties": [],
"total_duties_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"return": null,
"restock": false,
"additional_fees": [],
"total_additional_fees_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"refund_shipping_lines": [],
"admin_graphql_api_id": "gid://shopify/Refund/929361462",
"order_adjustments": [],

Anchor to POST request, Calculates a refund
post
Calculates a refund

order
Caution

For multi-currency orders, the currency property is required whenever the amount property is provided.

Calculates refund transactions based on line items and shipping. When you want to create a refund, you should first use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you intend to refund shipping costs. If the restock instructions can't be met—for example, because you try to return more items than have been fulfilled—then the endpoint returns modified restock instructions. You can then use the response in the body of the request to create the actual refund.

The response includes a transactions object with "kind": "suggested_refund", which must to be changed to "kind" : "refund" for the refund to be accepted.

Anchor to Parameters of Calculates a refundParameters

api_version
string
required
order_id
string
required
currency

The three-letter code (ISO 4217 format) for the currency used for the refund. Note: Required whenever the shipping amount property is provided.

refund_line_items

A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:

Show refund_line_items properties

  • line_item_id: The ID of a line item to refund.

  • quantity: The quantity to refund.

  • restock_type: How this refund line item affects inventory levels. Valid values:

    • no_restock: Refunding these items won't affect inventory.
    • cancel: The items have not yet been fulfilled. The canceled quantity will be added back to the available count. The number of fulfillable units for this line item will decrease.
    • return: The items were already delivered but will be returned to the merchant. The returned quantity will be added back to the available count. The number of fulfillable units for this line item will remain unchanged.

  • location_id: The ID of the location where the items should be restocked. If location_id is not provided and the value of restock_type is return or cancel, then the endpoint returns a suitable location ID.

  • already_stocked: Whether the item is already stocked at the location. If this is false, then creating the refund will connect the item to the location and start stocking it there.

shipping

Specify how much shipping to refund. It has the following properties:

Show shipping properties

  • full_refund: Whether to refund all remaining shipping.

  • amount: Set a specific amount to refund for shipping. Takes precedence over full_refund.

Was this section helpful?

Anchor to post-orders-order-id-refunds-calculate-examplesExamples

Calculate a refund for a partial amount of shipping

Path parameters
order_id=450789469
string
required

Calculate the refund for a line item and shipping

Path parameters
order_id=450789469
string
required
Request body
refund
Refund resource
Show refund properties
refund.refund_line_items:[{"line_item_id":518995019,"quantity":1,"restock_type":"no_restock"}]
->
refundLineItems

A list of refunded line items. Each entry has the following properties:

Show refund_line_items properties
  • id: The unique identifier of the line item in the refund.
  • line_item: A line item being refunded.
  • line_item_id: The ID of the related line item in the order.
  • quantity: The refunded quantity of the associated line item.
  • restock_type: How this refund line item affects inventory levels. Valid values:
    • no_restock: Refunding these items won't affect inventory. The number of fulfillable units for this line item will remain unchanged. For example, a refund payment can be issued but no items will be refunded or made available for sale again.
    • cancel: The items have not yet been fulfilled. The canceled quantity will be added back to the available count. The number of fulfillable units for this line item will decrease.
    • return: The items were already delivered, and will be returned to the merchant. The refunded quantity will be added back to the available count. The number of fulfillable units for this line item will remain unchanged.
    • legacy_restock: The deprecated restock property was used for this refund. These items were made available for sale again. This value is not accepted when creating new refunds.
  • location_id: The unique identifier of the location where the items will be restocked. Required when restock_type has the value return or cancel.
  • subtotal: The subtotal of the refund line item.
  • total_tax: The total tax on the refund line item.
  • subtotal_set: The subtotal of the refund line item in shop and presentment currencies.
  • total_tax_set: The total tax of the line item in shop and presentment currencies.

Calculate the refund without specifying currency

Path parameters
order_id=450789469
string
required
Request body
refund
Refund resource
Show refund properties
refund.refund_line_items:[{"line_item_id":518995019,"quantity":1,"restock_type":"no_restock"}]
->
refundLineItems

A list of refunded line items. Each entry has the following properties:

Show refund_line_items properties
  • id: The unique identifier of the line item in the refund.
  • line_item: A line item being refunded.
  • line_item_id: The ID of the related line item in the order.
  • quantity: The refunded quantity of the associated line item.
  • restock_type: How this refund line item affects inventory levels. Valid values:
    • no_restock: Refunding these items won't affect inventory. The number of fulfillable units for this line item will remain unchanged. For example, a refund payment can be issued but no items will be refunded or made available for sale again.
    • cancel: The items have not yet been fulfilled. The canceled quantity will be added back to the available count. The number of fulfillable units for this line item will decrease.
    • return: The items were already delivered, and will be returned to the merchant. The refunded quantity will be added back to the available count. The number of fulfillable units for this line item will remain unchanged.
    • legacy_restock: The deprecated restock property was used for this refund. These items were made available for sale again. This value is not accepted when creating new refunds.
  • location_id: The unique identifier of the location where the items will be restocked. Required when restock_type has the value return or cancel.
  • subtotal: The subtotal of the refund line item.
  • total_tax: The total tax on the refund line item.
  • subtotal_set: The subtotal of the refund line item in shop and presentment currencies.
  • total_tax_set: The total tax of the line item in shop and presentment currencies.
Was this section helpful?
post

/admin/api/2025-10/orders/450789469/refunds/calculate.json

curl -d '{"refund":{"currency":"USD","shipping":{"amount":2.0}}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2025-10/orders/450789469/refunds/calculate.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"

{}

Response

JSON
HTTP/1.1 200 OK
{
"refund": {
"duties": [],
"total_duties_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"return": null,
"shipping": {
"amount": "2.00",
"tax": "0.00",
"maximum_refundable": "5.00"
},
"additional_fees": [],
"total_additional_fees_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"refund_shipping_lines": [
{
"id": null,
"shipping_line_id": 369256396,
"subtotal_amount_set": {
"shop_money": {
"amount": "2.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "2.00",
"currency_code": "USD"
}
},
"shipping_line": {
"id": 369256396,
"carrier_identifier": null,
"code": "Free Shipping",
"discounted_price": "5.00",
"discounted_price_set": {
"shop_money": {
"amount": "5.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "5.00",
"currency_code": "USD"
}
},
"phone": null,
"price": "5.00",
"price_set": {
"shop_money": {
"amount": "5.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "5.00",
"currency_code": "USD"
}
},
"requested_fulfillment_service_id": null,
"source": "shopify",
"title": "Free Shipping",
"tax_lines": [],
"discount_allocations": []
}
}
],
"refund_line_items": [],
"transactions": [
{
"order_id": 450789469,
"kind": "suggested_refund",
"gateway": "bogus",
"parent_id": 801038806,
"amount": "2.00",
"currency": "USD",
"maximum_refundable": "41.94"
}
],
"currency": "USD"
}
}

Anchor to GET request, Retrieves a list of refunds for an order
get
Retrieves a list of refunds for an order

order

Retrieves a list of refunds for an order. Note: This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to Make paginated requests to the REST Admin API.

Anchor to Parameters of Retrieves a list of refunds for an orderParameters

api_version
string
required
order_id
string
required
fields

Show only certain fields, specified by a comma-separated list of field names.

in_shop_currency
default false

Show amounts in the shop currency for the underlying transaction.

limit
≤ 250
default 50

The maximum number of results to retrieve.

Was this section helpful?

Anchor to get-orders-order-id-refunds-examplesExamples

Retrieve all refunds from a specific order

Path parameters
order_id=450789469
string
required
Was this section helpful?
get

/admin/api/2025-10/orders/450789469/refunds.json

curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/orders/450789469/refunds.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK
{
"refunds": [
{
"id": 509562969,
"order_id": 450789469,
"created_at": "2025-10-01T14:30:56-04:00",
"note": "it broke during shipping",
"user_id": 548380009,
"processed_at": "2025-10-01T14:30:56-04:00",
"duties": [],
"total_duties_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"return": null,
"restock": true,
"additional_fees": [],
"total_additional_fees_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"refund_shipping_lines": [],
"admin_graphql_api_id": "gid://shopify/Refund/509562969",

Anchor to GET request, Retrieves a specific refund
get
Retrieves a specific refund

refund

Retrieves a specific refund.

Anchor to Parameters of Retrieves a specific refundParameters

api_version
string
required
order_id
string
required
refund_id
string
required
fields

Show only certain fields, specified by a comma-separated list of field names.

in_shop_currency
default false

Show amounts in the shop currency for the underlying transaction.

Was this section helpful?

Anchor to get-orders-order-id-refunds-refund-id-examplesExamples

Retrieve a specific refund

Was this section helpful?
get

/admin/api/2025-10/orders/450789469/refunds/509562969.json

curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/orders/450789469/refunds/509562969.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK
{
"refund": {
"id": 509562969,
"order_id": 450789469,
"created_at": "2025-10-01T14:30:56-04:00",
"note": "it broke during shipping",
"user_id": 548380009,
"processed_at": "2025-10-01T14:30:56-04:00",
"duties": [],
"total_duties_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"return": null,
"restock": true,
"additional_fees": [],
"total_additional_fees_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"refund_shipping_lines": [],
"admin_graphql_api_id": "gid://shopify/Refund/509562969",
"order_adjustments": [],