Orders
List all Refunds
Orders
List all Refunds
Retrieves a list of refunds for an order.
The response is compatible with the Shopify REST API refund schema. For detailed schema explanations, see the Shopify REST API refund resource.
POST
/
api
/
KarizClientApp
/
Unified
/
Refunds
curl --request POST \
--url https://api.trykariz.com/api/KarizClientApp/Unified/Refunds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"params": {
"shopify": [
{
"key": "baseUrl",
"value": "your-shop.myshopify.com"
},
{
"key": "token",
"value": "your-shopify-oauth-token"
}
]
},
"order_id": "ord_aBcDeFg12345",
"fields": "id,status,created_at,total_price",
"in_shop_currency": true,
"limit": 100
}'{
"Errors": {},
"Output": {
"step": "transform",
"isSuccess": true,
"schemaValidationErrors": null,
"restErrors": null,
"operationErrors": null,
"unexpectedErrors": null,
"execution_id": "ed7ad663-4757-447c-b5cd-1e83c2380afc",
"override_count": 1,
"next_page_token_url": "https://api.trykariz.com/api/KarizClientApp/RunSync?configName=shopify_get_orders&tpUserId=1&data=%7B%22limit%22%3A1%2C%22next_page_token%22%3A%22eyJsYXN0X2lkIjo1OTU0NDYxMzM1ODI3LCJsYXN0X3ZhbHVlIjoiMjAyNC0wOS0xMyAxNDo0NzoxMy4xNDAwNTEiLCJkaXJlY3Rpb24iOiJuZXh0In0%22%7D",
"next_page_token": "eyJsYXN0X2lkIjo1OTU0NDYxMzM1ODI3LCJsYXN0X3ZhbHVlIjoiMjAyNC0wOS0xMyAxNDo0NzoxMy4xNDAwNTEiLCJkaXJlY3Rpb24iOiJuZXh0In0",
"result": {
"refunds": [
{
"id": 509562969,
"order_id": 450789469,
"created_at": "2025-01-02T11:38:15-05:00",
"note": "it broke during shipping",
"user_id": 548380009,
"processed_at": "2025-01-02T11:38:15-05: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": [],
"refund_line_items": [
{
"id": 104689539,
"quantity": 1,
"line_item_id": 703073504,
"location_id": 487838322,
"restock_type": "legacy_restock",
"subtotal": 195.66,
"total_tax": 3.98,
"subtotal_set": {
"shop_money": {
"amount": "195.66",
"currency_code": "USD"
},
"presentment_money": {
"amount": "195.66",
"currency_code": "USD"
}
},
"total_tax_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"line_item": {
"id": 703073504,
"variant_id": 457924702,
"title": "IPod Nano - 8gb",
"quantity": 1,
"sku": "IPOD2008BLACK",
"variant_title": "black",
"vendor": null,
"fulfillment_service": "manual",
"product_id": 632910392,
"requires_shipping": true,
"taxable": true,
"gift_card": false,
"name": "IPod Nano - 8gb - black",
"variant_inventory_management": "shopify",
"properties": [],
"product_exists": true,
"fulfillable_quantity": 1,
"grams": 200,
"price": "199.00",
"total_discount": "0.00",
"fulfillment_status": null,
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"discount_allocations": [
{
"amount": "3.33",
"discount_application_index": 0,
"amount_set": {
"shop_money": {
"amount": "3.33",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.33",
"currency_code": "USD"
}
}
}
],
"duties": [],
"admin_graphql_api_id": "gid://shopify/LineItem/703073504",
"tax_lines": [
{
"title": "State Tax",
"price": "3.98",
"rate": 0.06,
"channel_liable": null,
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
}
}
]
}
},
{
"id": 709875399,
"quantity": 1,
"line_item_id": 466157049,
"location_id": 487838322,
"restock_type": "legacy_restock",
"subtotal": 195.67,
"total_tax": 3.98,
"subtotal_set": {
"shop_money": {
"amount": "195.67",
"currency_code": "USD"
},
"presentment_money": {
"amount": "195.67",
"currency_code": "USD"
}
},
"total_tax_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"line_item": {
"id": 466157049,
"variant_id": 39072856,
"title": "IPod Nano - 8gb",
"quantity": 1,
"sku": "IPOD2008GREEN",
"variant_title": "green",
"vendor": null,
"fulfillment_service": "manual",
"product_id": 632910392,
"requires_shipping": true,
"taxable": true,
"gift_card": false,
"name": "IPod Nano - 8gb - green",
"variant_inventory_management": "shopify",
"properties": [
{
"name": "Custom Engraving Front",
"value": "Happy Birthday"
},
{
"name": "Custom Engraving Back",
"value": "Merry Christmas"
}
],
"product_exists": true,
"fulfillable_quantity": 1,
"grams": 200,
"price": "199.00",
"total_discount": "0.00",
"fulfillment_status": null,
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"discount_allocations": [
{
"amount": "3.34",
"discount_application_index": 0,
"amount_set": {
"shop_money": {
"amount": "3.34",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.34",
"currency_code": "USD"
}
}
}
],
"duties": [],
"admin_graphql_api_id": "gid://shopify/LineItem/466157049",
"tax_lines": [
{
"title": "State Tax",
"price": "3.98",
"rate": 0.06,
"channel_liable": null,
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
}
}
]
}
}
],
"transactions": [
{
"id": 179259969,
"order_id": 450789469,
"kind": "refund",
"gateway": "bogus",
"status": "success",
"message": null,
"created_at": "2005-08-05T12:59:12-04:00",
"test": false,
"authorization": "authorization-key",
"location_id": null,
"user_id": null,
"parent_id": 801038806,
"processed_at": "2005-08-05T12:59:12-04:00",
"device_id": null,
"error_code": null,
"source_name": "web",
"receipt": {},
"amount": "209.00",
"currency": "USD",
"payment_id": "#1001.3",
"total_unsettled_set": {
"presentment_money": {
"amount": "348.0",
"currency": "USD"
},
"shop_money": {
"amount": "348.0",
"currency": "USD"
}
},
"manual_payment_gateway": false,
"amount_rounding": null,
"admin_graphql_api_id": "gid://shopify/OrderTransaction/179259969"
}
]
}
]
}
},
"Report": {
"TraceId": "00-3c6a96b919427b0952ba274800a4b04f-7efc4603f4ee42e7-00",
"TotalExtResourcesDuration": 356.8311,
"TotalEventsTransitDuration": 554.5615,
"TotalTransformationsDuration": 690.4757,
"TotalRequestsDuration": 4296.1973,
"ExtResources": [
{
"Uri": "https://quickstart.myshopify.com/admin/api/2025-01/fulfillments.json",
"Duration": 356.8311
}
]
}
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
Specify the sales channel from which to fetch user data. Each request can only retrieve data from a single channel at a time. Since requests are processed in real-time, response times vary depending on the sales channel’s speed
Available options:
shopify The ID of your user(must be authenticated with target channels).
To receive the completion event. You can use a webhook to find out whether the task is finished.
Body
application/json
The supported parameters to query the data depend on the channels API. Supported channels shows which parameters can be used for which channels.
The body is of type object.
Response
200 - application/json
POST /Unified/Refunds Successful response
The response is of type object.
curl --request POST \
--url https://api.trykariz.com/api/KarizClientApp/Unified/Refunds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"params": {
"shopify": [
{
"key": "baseUrl",
"value": "your-shop.myshopify.com"
},
{
"key": "token",
"value": "your-shopify-oauth-token"
}
]
},
"order_id": "ord_aBcDeFg12345",
"fields": "id,status,created_at,total_price",
"in_shop_currency": true,
"limit": 100
}'{
"Errors": {},
"Output": {
"step": "transform",
"isSuccess": true,
"schemaValidationErrors": null,
"restErrors": null,
"operationErrors": null,
"unexpectedErrors": null,
"execution_id": "ed7ad663-4757-447c-b5cd-1e83c2380afc",
"override_count": 1,
"next_page_token_url": "https://api.trykariz.com/api/KarizClientApp/RunSync?configName=shopify_get_orders&tpUserId=1&data=%7B%22limit%22%3A1%2C%22next_page_token%22%3A%22eyJsYXN0X2lkIjo1OTU0NDYxMzM1ODI3LCJsYXN0X3ZhbHVlIjoiMjAyNC0wOS0xMyAxNDo0NzoxMy4xNDAwNTEiLCJkaXJlY3Rpb24iOiJuZXh0In0%22%7D",
"next_page_token": "eyJsYXN0X2lkIjo1OTU0NDYxMzM1ODI3LCJsYXN0X3ZhbHVlIjoiMjAyNC0wOS0xMyAxNDo0NzoxMy4xNDAwNTEiLCJkaXJlY3Rpb24iOiJuZXh0In0",
"result": {
"refunds": [
{
"id": 509562969,
"order_id": 450789469,
"created_at": "2025-01-02T11:38:15-05:00",
"note": "it broke during shipping",
"user_id": 548380009,
"processed_at": "2025-01-02T11:38:15-05: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": [],
"refund_line_items": [
{
"id": 104689539,
"quantity": 1,
"line_item_id": 703073504,
"location_id": 487838322,
"restock_type": "legacy_restock",
"subtotal": 195.66,
"total_tax": 3.98,
"subtotal_set": {
"shop_money": {
"amount": "195.66",
"currency_code": "USD"
},
"presentment_money": {
"amount": "195.66",
"currency_code": "USD"
}
},
"total_tax_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"line_item": {
"id": 703073504,
"variant_id": 457924702,
"title": "IPod Nano - 8gb",
"quantity": 1,
"sku": "IPOD2008BLACK",
"variant_title": "black",
"vendor": null,
"fulfillment_service": "manual",
"product_id": 632910392,
"requires_shipping": true,
"taxable": true,
"gift_card": false,
"name": "IPod Nano - 8gb - black",
"variant_inventory_management": "shopify",
"properties": [],
"product_exists": true,
"fulfillable_quantity": 1,
"grams": 200,
"price": "199.00",
"total_discount": "0.00",
"fulfillment_status": null,
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"discount_allocations": [
{
"amount": "3.33",
"discount_application_index": 0,
"amount_set": {
"shop_money": {
"amount": "3.33",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.33",
"currency_code": "USD"
}
}
}
],
"duties": [],
"admin_graphql_api_id": "gid://shopify/LineItem/703073504",
"tax_lines": [
{
"title": "State Tax",
"price": "3.98",
"rate": 0.06,
"channel_liable": null,
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
}
}
]
}
},
{
"id": 709875399,
"quantity": 1,
"line_item_id": 466157049,
"location_id": 487838322,
"restock_type": "legacy_restock",
"subtotal": 195.67,
"total_tax": 3.98,
"subtotal_set": {
"shop_money": {
"amount": "195.67",
"currency_code": "USD"
},
"presentment_money": {
"amount": "195.67",
"currency_code": "USD"
}
},
"total_tax_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"line_item": {
"id": 466157049,
"variant_id": 39072856,
"title": "IPod Nano - 8gb",
"quantity": 1,
"sku": "IPOD2008GREEN",
"variant_title": "green",
"vendor": null,
"fulfillment_service": "manual",
"product_id": 632910392,
"requires_shipping": true,
"taxable": true,
"gift_card": false,
"name": "IPod Nano - 8gb - green",
"variant_inventory_management": "shopify",
"properties": [
{
"name": "Custom Engraving Front",
"value": "Happy Birthday"
},
{
"name": "Custom Engraving Back",
"value": "Merry Christmas"
}
],
"product_exists": true,
"fulfillable_quantity": 1,
"grams": 200,
"price": "199.00",
"total_discount": "0.00",
"fulfillment_status": null,
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"discount_allocations": [
{
"amount": "3.34",
"discount_application_index": 0,
"amount_set": {
"shop_money": {
"amount": "3.34",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.34",
"currency_code": "USD"
}
}
}
],
"duties": [],
"admin_graphql_api_id": "gid://shopify/LineItem/466157049",
"tax_lines": [
{
"title": "State Tax",
"price": "3.98",
"rate": 0.06,
"channel_liable": null,
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
}
}
]
}
}
],
"transactions": [
{
"id": 179259969,
"order_id": 450789469,
"kind": "refund",
"gateway": "bogus",
"status": "success",
"message": null,
"created_at": "2005-08-05T12:59:12-04:00",
"test": false,
"authorization": "authorization-key",
"location_id": null,
"user_id": null,
"parent_id": 801038806,
"processed_at": "2005-08-05T12:59:12-04:00",
"device_id": null,
"error_code": null,
"source_name": "web",
"receipt": {},
"amount": "209.00",
"currency": "USD",
"payment_id": "#1001.3",
"total_unsettled_set": {
"presentment_money": {
"amount": "348.0",
"currency": "USD"
},
"shop_money": {
"amount": "348.0",
"currency": "USD"
}
},
"manual_payment_gateway": false,
"amount_rounding": null,
"admin_graphql_api_id": "gid://shopify/OrderTransaction/179259969"
}
]
}
]
}
},
"Report": {
"TraceId": "00-3c6a96b919427b0952ba274800a4b04f-7efc4603f4ee42e7-00",
"TotalExtResourcesDuration": 356.8311,
"TotalEventsTransitDuration": 554.5615,
"TotalTransformationsDuration": 690.4757,
"TotalRequestsDuration": 4296.1973,
"ExtResources": [
{
"Uri": "https://quickstart.myshopify.com/admin/api/2025-01/fulfillments.json",
"Duration": 356.8311
}
]
}
}