Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Returns
  • Auth
    • Get Current User
      GET
    • User Logout
      DELETE
    • User Login
      POST
    • User Login (JWT)
      POST
  • Apps Oauth
    • Generate Token for App
      POST
    • List Applications
      GET
  • Batch Jobs
    • Cancel a Batch Job
      POST
    • Get a Batch Job
      GET
    • Confirm a Batch Job
      POST
    • List Batch Jobs
      GET
    • Create a Batch Job
      POST
  • Currencies
    • List Currency
      GET
    • Update a Currency
      POST
  • Customers
    • Create a Customer
      POST
    • List Customers
      GET
    • Update a Customer
      POST
    • Get a Customer
      GET
  • Customer Groups
    • Remove Customers from Group
      DELETE
    • Add Customers to Group
      POST
    • List Customers
      GET
    • Create a Customer Group
      POST
    • List Customer Groups
      GET
    • Get a Customer Group
      GET
    • Delete a Customer Group
      DELETE
    • Update a Customer Group
      POST
  • Discounts
    • Create a Condition
    • Create a Discount
    • List Discounts
    • Get a Condition
    • Update a Condition
    • Delete a Condition
    • Create a Dynamic Code
    • Remove Batch Resources
    • Add Batch Resources
    • Get Discount by Code
    • Delete a Dynamic Code
    • Add Region to Discount
    • Remove Region
    • Delete a Discount
    • Update a Discount
    • Get a Discount
  • Draft Orders
    • Create a Line Item
    • Delete a Line Item
    • Update a Line Item
    • Update a Draft Order
    • Delete a Draft Order
    • Get a Draft Order
    • Create a Draft Order
    • List Draft Orders
    • Mark Paid
  • Gift Cards
    • Create a Gift Card
    • List Gift Cards
    • Delete a Gift Card
    • Get a Gift Card
    • Update a Gift Card
  • Inventory Items
    • Create an Inventory Item
    • List Inventory Items
    • List Inventory Level
    • Create an Location Level
    • Update an Inventory Item
    • Get an Inventory Item
    • Delete an Inventory Item
    • Update a Location Level
    • Delete a Location Level
  • Invites
    • Lists Invites
    • Create an Invite
    • Delete an Invite
    • Accept an Invite
    • Resend an Invite
  • Notes
    • List Notes
    • Create a Note
    • Get a Note
    • Delete a Note
    • Update a Note
  • Notifications
    • Resend Notification
    • List Notifications
  • Orders
    • Create a Reservation
    • Cancel Claim's Fulfillment
    • Ship a Claim's Fulfillment
    • Cancel Swap's Fulfilmment
    • Get Order Reservations
    • Add a Shipping Method
    • Create a Refund
    • Get an Order
    • Update an Order
    • Create a Fulfillment
    • Cancel a Swap
    • List Orders
    • Create a Swap
    • Complete an Order
    • Create a Swap Fulfillment
    • Cancel a Claim
    • Process a Swap Payment
    • Ship a Fulfillment
    • Capture an Order's Payments
    • Archive Order
    • Update a Claim
    • Request a Return
    • Create a Claim Fulfillment
    • Ship a Swap's Fulfillment
    • Cancel a Fulfilmment
    • Create a Claim
    • Cancel an Order
  • Order Edits
    • Delete a Line Item Change
    • Add a Line Item
    • Upsert Line Item Change
    • Delete Line Item
    • Cancel an Order Edit
    • Delete an Order Edit
    • Get an Order Edit
    • Update an Order Edit
    • Request Confirmation
    • Create an OrderEdit
    • List Order Edits
    • Confirm an OrderEdit
  • Payments
    • Capture a Payment
    • Get Payment details
    • Refund Payment
  • Payment Collections
    • Delete a Payment Collection
    • Get a Payment Collection
    • Update Payment Collection
    • Mark Authorized
  • Product Collections
    • Add Products to Collection
    • Remove Products from Collection
    • Get a Collection
    • Update a Collection
    • Delete a Collection
    • List Collections
    • Create a Collection
  • Product Tags
    • List Product Tags
  • Product Types
    • List Product Types
  • Product Variants
    • Get Variant's Inventory
    • List Product Variants
    • Get a Product variant
  • Price Lists
    • Delete a Product's Prices
    • List Products
    • Delete a Variant's Prices
    • Get a Price List
    • Update a Price List
    • Delete a Price List
    • Add or Update Prices
    • Delete Prices
    • Create a Price List
    • List Price Lists
  • Products
    • List Product Types
    • List Tags Usage Number
    • List a Product's Variants
    • Create a Product Variant
    • Update a Product Variant
    • Delete a Product Variant
    • Add a Product Option
    • Set Metadata
    • Delete a Product Option
    • Update a Product Option
    • List Products
    • Create a Product
    • Delete a Product
    • Update a Product
    • Get a Product
  • Product Categories
    • Create a Product Category
    • List Product Categories
    • Update a Product Category
    • Delete a Product Category
    • Get a Product Category
    • Add Products to a Category
    • Remove Products from Category
  • Publishable Api Keys
    • List Sales Channels
    • Delete Publishable API Key
    • Get a Publishable API Key
    • Revoke a Publishable API Key
    • Remove Sales Channels
    • Add Sales Channels
    • Update Publishable API Key
    • List Publishable API keys
    • Create Publishable API Key
  • Reservations
    • Delete a Reservation
    • Update a Reservation
    • Get a Reservation
    • Create a Reservation
    • List Reservations
  • Regions
    • List Fulfillment Options
    • Add Country
    • Remove Fulfillment Provider
    • Remove Payment Provider
    • Add Payment Provider
    • Delete a Region
    • Update a Region
    • Get a Region
    • List Regions
    • Create a Region
    • Add Fulfillment Provider
    • Remove Country
  • Return Reasons
    • Get a Return Reason
    • Delete a Return Reason
    • Update a Return Reason
    • List Return Reasons
    • Create a Return Reason
  • Returns
    • Receive a Return
      POST
    • List Returns
      GET
    • Cancel a Return
      POST
  • Sales Channels
    • Remove Stock Location from Sales Channels.
    • Associate a Stock Location
    • Get a Sales Channel
    • Delete a Sales Channel
    • Update a Sales Channel
    • Remove Products from Sales Channel
    • Add Products to Sales Channel
    • Create a Sales Channel
    • List Sales Channels
  • Shipping Options
    • Update Shipping Option
    • Get a Shipping Option
    • Delete Shipping Option
    • List Shipping Options
    • Create Shipping Option
  • Shipping Profiles
    • List Shipping Profiles
    • Create a Shipping Profile
    • Delete a Shipping Profile
    • Update a Shipping Profile
    • Get a Shipping Profile
  • Stock Locations
    • Get a Stock Location
    • List Stock Locations
    • Create a Stock Location
    • Update a Stock Location
    • Delete a Stock Location
  • Store
    • List Payment Providers
    • Add a Currency Code
    • Remove a Currency
    • List Tax Providers
    • Update Store Details
    • Get Store details
  • Swaps
    • Get a Swap
    • List Swaps
  • Uploads
    • Upload Files
    • Delete an Uploaded File
    • Get a File's Download URL
    • Protected File Upload
  • Tax Rates
    • Add to Shipping Options
    • Remove Shipping Options from Rate
    • Create a Tax Rate
    • List Tax Rates
    • Add to Products
    • Remove Products from Rate
    • Delete a Tax Rate
    • Get a Tax Rate
    • Update a Tax Rate
    • Add to Product Types
    • Remove Product Types from Rate
  • Users
    • Reset Password
    • Request Password Reset
    • Get a User
    • Delete a User
    • Update a User
    • Create a User
    • List Users
  1. Returns

List Returns

GET
/admin/returns
Returns
Retrieve a list of Returns. The returns can be paginated.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '{{BASE_URL}}/admin/returns'
Response Response Example
200 - Example 1
{
  "count": 0,
  "offset": 0,
  "limit": 0,
  "returns": [
    {
      "id": "ret_01F0YET7XPCMF8RZ0Y151NZV2V",
      "swap_id": null,
      "swap": {},
      "claim_order_id": null,
      "claim_order": {},
      "order_id": "order_01G8TJSYT9M6AVS5N4EMNFS1EK",
      "order": {},
      "location_id": "sloc_01G8TJSYT9M6AVS5N4EMNFS1EK",
      "refund_amount": 1000,
      "no_notification": false,
      "received_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "status": "requested",
      "shipping_data": {},
      "idempotency_key": "string",
      "metadata": {
        "car": "white"
      },
      "shipping_method": {
        "id": "sm_01F0YET7DR2E7CYVSDHM593QG2",
        "shipping_option_id": "so_01G1G5V27GYX4QXNARRQCW1N8T",
        "order_id": "order_01G8TJSYT9M6AVS5N4EMNFS1EK",
        "order": {},
        "claim_order_id": null,
        "claim_order": {},
        "cart_id": "cart_01G8ZH853Y6TFXWPG5EYE81X63",
        "cart": {},
        "swap_id": null,
        "swap": {},
        "return_id": null,
        "return_order": {},
        "price": 200,
        "includes_tax": false,
        "subtotal": 8000,
        "total": 8200,
        "tax_total": 0,
        "data": {},
        "tax_lines": [
          {
            "id": "smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8",
            "code": "tax01",
            "name": "Tax Example",
            "rate": 10,
            "shipping_method_id": "sm_01F0YET7DR2E7CYVSDHM593QG2",
            "shipping_method": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "metadata": {
              "car": "white"
            }
          }
        ],
        "shipping_option": {
          "id": "so_01G1G5V27GYX4QXNARRQCW1N8T",
          "name": "PostFake Standard",
          "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
          "region": {},
          "profile_id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
          "provider_id": "manual",
          "amount": 200,
          "is_return": false,
          "admin_only": false,
          "includes_tax": false,
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "deleted_at": "2019-08-24T14:15:22Z",
          "price_type": "flat_rate",
          "data": {},
          "metadata": {
            "car": "white"
          },
          "provider": {
            "id": "manual",
            "is_installed": true
          },
          "requirements": [
            {
              "id": "sor_01G1G5V29AB4CTNDRFSRWSRKWD",
              "shipping_option_id": "so_01G1G5V27GYX4QXNARRQCW1N8T",
              "shipping_option": {},
              "amount": 100,
              "deleted_at": "2019-08-24T14:15:22Z",
              "type": "min_subtotal"
            }
          ],
          "profile": {
            "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
            "name": "Default Shipping Profile",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "type": "default",
            "products": [
              {}
            ],
            "shipping_options": [
              {}
            ],
            "metadata": {
              "car": "white"
            }
          }
        }
      },
      "items": [
        {
          "return_id": "ret_01F0YET7XPCMF8RZ0Y151NZV2V",
          "item_id": "item_01G8ZC9GWT6B2GP5FSXRXNFNGN",
          "return_order": {},
          "quantity": 1,
          "is_requested": true,
          "requested_quantity": 1,
          "received_quantity": 1,
          "reason_id": "rr_01G8X82GCCV2KSQHDBHSSAH5TQ",
          "note": "I didn't like it.",
          "metadata": {
            "car": "white"
          },
          "reason": {
            "id": "rr_01G8X82GCCV2KSQHDBHSSAH5TQ",
            "value": "damaged",
            "label": "Damaged goods",
            "description": "Items that are damaged",
            "parent_return_reason_id": null,
            "parent_return_reason": {},
            "return_reason_children": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "metadata": {
              "car": "white"
            }
          },
          "item": {
            "id": "item_01G8ZC9GWT6B2GP5FSXRXNFNGN",
            "cart_id": "cart_01G8ZH853Y6TFXWPG5EYE81X63",
            "cart": {},
            "order_id": "order_01G8TJSYT9M6AVS5N4EMNFS1EK",
            "order": {},
            "swap_id": null,
            "swap": {},
            "claim_order_id": null,
            "claim_order": {},
            "original_item_id": "string",
            "order_edit_id": "string",
            "order_edit": {},
            "title": "Medusa Coffee Mug",
            "description": "One Size",
            "thumbnail": "https://medusa-public-images.s3.eu-west-1.amazonaws.com/coffee-mug.png",
            "is_return": false,
            "is_giftcard": false,
            "should_merge": true,
            "allow_discounts": true,
            "has_shipping": false,
            "unit_price": 8000,
            "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
            "quantity": 1,
            "fulfilled_quantity": 0,
            "returned_quantity": 0,
            "shipped_quantity": 0,
            "refundable": 0,
            "subtotal": 8000,
            "tax_total": 0,
            "total": 8000,
            "original_total": 8000,
            "original_tax_total": 0,
            "discount_total": 0,
            "raw_discount_total": 0,
            "gift_card_total": 0,
            "includes_tax": false,
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "metadata": {
              "car": "white"
            },
            "tax_lines": [
              {
                "id": "litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8",
                "code": "tax01",
                "name": "Tax Example",
                "rate": 10,
                "item_id": "item_01G8ZC9GWT6B2GP5FSXRXNFNGN",
                "item": {},
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "metadata": {
                  "car": "white"
                }
              }
            ],
            "variant": {
              "id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
              "title": "Small",
              "product_id": "prod_01G1G5V2MBA328390B5AXJ610F",
              "product": {},
              "sku": "shirt-123",
              "barcode": null,
              "ean": null,
              "upc": null,
              "variant_rank": 0,
              "inventory_quantity": 100,
              "allow_backorder": false,
              "manage_inventory": true,
              "hs_code": null,
              "origin_country": null,
              "mid_code": null,
              "material": null,
              "weight": null,
              "length": null,
              "height": null,
              "width": null,
              "created_at": "2019-08-24T14:15:22Z",
              "updated_at": "2019-08-24T14:15:22Z",
              "deleted_at": "2019-08-24T14:15:22Z",
              "purchasable": true,
              "metadata": {
                "car": "white"
              },
              "options": [
                {
                  "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ",
                  "value": "large",
                  "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                  "option": {},
                  "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                  "variant": {},
                  "created_at": "2019-08-24T14:15:22Z",
                  "updated_at": "2019-08-24T14:15:22Z",
                  "deleted_at": "2019-08-24T14:15:22Z",
                  "metadata": {
                    "car": "white"
                  }
                }
              ],
              "inventory_items": [
                {
                  "id": "pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A",
                  "inventory_item_id": "string",
                  "variant_id": "string",
                  "variant": {},
                  "required_quantity": 1,
                  "created_at": "2019-08-24T14:15:22Z",
                  "updated_at": "2019-08-24T14:15:22Z",
                  "deleted_at": "2019-08-24T14:15:22Z"
                }
              ],
              "prices": [
                {
                  "id": "ma_01F0YESHRFQNH5S8Q0PK84YYZN",
                  "amount": 100,
                  "min_quantity": 1,
                  "max_quantity": 1,
                  "price_list_id": "pl_01G8X3CKJXCG5VXVZ87H9KC09W",
                  "price_list": {},
                  "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                  "variant": {},
                  "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
                  "region": {},
                  "created_at": "2019-08-24T14:15:22Z",
                  "updated_at": "2019-08-24T14:15:22Z",
                  "deleted_at": "2019-08-24T14:15:22Z",
                  "currency_code": "usd",
                  "currency": {
                    "symbol": "$",
                    "symbol_native": "$",
                    "name": "US Dollar",
                    "includes_tax": false,
                    "code": "usd"
                  }
                }
              ]
            },
            "adjustments": [
              {
                "id": "lia_01G8TKE4XYCTHSCK2GDEP47RE1",
                "item_id": "item_01G8ZC9GWT6B2GP5FSXRXNFNGN",
                "item": {},
                "description": "Adjusted item's price.",
                "discount_id": "disc_01F0YESMW10MGHWJKZSDDMN0VN",
                "amount": 1000,
                "metadata": {
                  "car": "white"
                },
                "discount": {
                  "id": "disc_01F0YESMW10MGHWJKZSDDMN0VN",
                  "code": "10DISC",
                  "is_dynamic": false,
                  "rule_id": "dru_01F0YESMVK96HVX7N419E3CJ7C",
                  "is_disabled": false,
                  "parent_discount_id": "disc_01G8ZH853YPY9B94857DY91YGW",
                  "parent_discount": {},
                  "starts_at": "2019-08-24T14:15:22Z",
                  "ends_at": "2019-08-24T14:15:22Z",
                  "valid_duration": "P3Y6M4DT12H30M5S",
                  "usage_limit": 100,
                  "usage_count": 0,
                  "created_at": "2019-08-24T14:15:22Z",
                  "updated_at": "2019-08-24T14:15:22Z",
                  "deleted_at": "2019-08-24T14:15:22Z",
                  "metadata": {
                    "car": "white"
                  },
                  "rule": {
                    "id": "dru_01F0YESMVK96HVX7N419E3CJ7C",
                    "description": "10 Percent",
                    "value": 10,
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "type": "fixed",
                    "allocation": "total",
                    "conditions": [
                      {}
                    ],
                    "metadata": {
                      "car": "white"
                    }
                  },
                  "regions": [
                    {
                      "id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
                      "name": "EU",
                      "tax_rate": 0,
                      "tax_code": null,
                      "gift_cards_taxable": true,
                      "automatic_taxes": true,
                      "tax_provider_id": null,
                      "includes_tax": false,
                      "created_at": "2019-08-24T14:15:22Z",
                      "updated_at": "2019-08-24T14:15:22Z",
                      "deleted_at": "2019-08-24T14:15:22Z",
                      "currency_code": "usd",
                      "metadata": {
                        "car": "white"
                      },
                      "currency": {
                        "symbol": "$",
                        "symbol_native": "$",
                        "name": "US Dollar",
                        "includes_tax": false,
                        "code": "usd"
                      },
                      "countries": [
                        {
                          "id": 109,
                          "name": "ITALY",
                          "display_name": "Italy",
                          "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
                          "region": {},
                          "iso_2": "it",
                          "iso_3": "ita",
                          "num_code": 380
                        }
                      ],
                      "tax_provider": {
                        "id": "manual",
                        "is_installed": true
                      },
                      "payment_providers": [
                        {
                          "id": "manual",
                          "is_installed": true
                        }
                      ],
                      "fulfillment_providers": [
                        {
                          "id": "manual",
                          "is_installed": true
                        }
                      ],
                      "tax_rates": [
                        {
                          "id": "txr_01G8XDBAWKBHHJRKH0AV02KXBR",
                          "rate": 10,
                          "code": "tax01",
                          "name": "Tax Example",
                          "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
                          "region": {},
                          "product_count": 10,
                          "product_type_count": 2,
                          "shipping_option_count": 1,
                          "created_at": "2019-08-24T14:15:22Z",
                          "updated_at": "2019-08-24T14:15:22Z",
                          "metadata": {
                            "car": "white"
                          },
                          "product_types": [
                            {
                              "metadata": {}
                            }
                          ],
                          "shipping_options": [
                            {
                              "region": {},
                              "data": {},
                              "metadata": {},
                              "requirements": []
                            }
                          ],
                          "products": [
                            {
                              "metadata": {},
                              "images": [],
                              "categories": [],
                              "tags": [],
                              "profiles": [],
                              "sales_channels": [],
                              "options": [],
                              "variants": []
                            }
                          ]
                        }
                      ]
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  ]
}

Request

Query Params
limit
number 
optional
Limit the number of Returns returned.
offset
number 
optional
The number of Returns to skip when retrieving the Returns.

Responses

🟢200OK
application/json
Body
count
integer 
required
The total number of items available
offset
integer 
required
The number of returns skipped when retrieving the returns.
limit
integer 
required
The number of items per page
returns
array[object (Return) {19}] 
required
An array of returns details.
id
string 
required
The return's ID
Example:
ret_01F0YET7XPCMF8RZ0Y151NZV2V
swap_id
string  | null 
required
The ID of the swap that the return may belong to.
Example:
null
swap
object  | null 
optional
The details of the swap that the return may belong to.
claim_order_id
string  | null 
required
The ID of the claim that the return may belong to.
Example:
null
claim_order
object  | null 
optional
The details of the claim that the return may belong to.
order_id
string  | null 
required
The ID of the order that the return was created for.
Example:
order_01G8TJSYT9M6AVS5N4EMNFS1EK
order
object  | null 
optional
The details of the order that the return was created for.
location_id
string  | null 
required
The ID of the stock location the return will be added back.
Example:
sloc_01G8TJSYT9M6AVS5N4EMNFS1EK
refund_amount
integer 
required
The amount that should be refunded as a result of the return.
Example:
1000
no_notification
boolean  | null 
required
When set to true, no notification will be sent related to this return.
Example:
false
received_at
string <date-time> | null 
required
The date with timezone at which the return was received.
created_at
string <date-time>
required
The date with timezone at which the resource was created.
updated_at
string <date-time>
required
The date with timezone at which the resource was updated.
status
enum<string> 
required
Status of the Return.
Allowed values:
requestedreceivedrequires_actioncanceled
Default:
requested
shipping_data
object  | null 
required
Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.
Example:
{}
idempotency_key
string  | null 
required
Randomly generated key used to continue the completion of the return in case of failure.
metadata
object  | null 
required
An optional key-value map with additional details
Example:
{"car":"white"}
shipping_method
object (Shipping Method) 
optional
A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of.
items
array[object (Return Item) {12}] 
optional
The details of the items that the customer is returning.
🟠400Client Error or Multiple Errors
🟠401User is not authorized. Must log in first
🟠404Not Found Error
🟠409Invalid State Error
🟠422Invalid Request Error
🔴500Server Error
Modified at 2023-10-10 11:56:36
Previous
Receive a Return
Next
Cancel a Return
Built with