Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Return Reasons
  • Getting Started
    • Introduction
    • Authentication
    • HTTP Compression
    • Publishable API Key
    • Expanding Fields
    • Selecting Fields
    • Query Parameter Types
    • Pagination
  • Auth
    • Check if Email Exists
      GET
    • Customer Login (JWT)
      POST
    • Customer Login (JWT)
      POST
    • Customer Log out
      DELETE
    • Get Current Customer
      GET
    • Customer Login
      POST
  • Carts
    • Create Payment Sessions
      POST
    • Update a Payment Session
      POST
    • Delete a Payment Session
      DELETE
    • Create a Cart
      POST
    • Get a Cart
      GET
    • Update a Cart
      POST
    • Remove Discount
      DELETE
    • Add a Line Item
      POST
    • Update a Line Item
      POST
    • Delete a Line Item
      DELETE
    • Select a Payment Session
      POST
    • Refresh a Payment Session
      POST
    • Add Shipping Method
      POST
    • Calculate Cart Taxes
      POST
    • Complete a Cart
      POST
  • Customers
    • Get Saved Payment Methods
    • Request Password Reset
    • Update a Shipping Address
    • Delete an Address
    • Create a Customer
    • Get a Customer
    • Update Customer
    • Add a Shipping Address
    • Reset Password
    • List Orders
  • Gift Cards
    • Get Gift Card by Code
  • Orders
    • Claim Order
    • Verify Order Claim
    • Look Up an Order
    • Get by Cart ID
    • Get an Order
  • Order Edits
    • Retrieve an Order Edit
    • Decline an Order Edit
    • Complete an Order Edit
  • Payment Collections
    • Refresh a Payment Session
    • Authorize Payment Session
    • Get a PaymentCollection
    • Create a Payment Session
    • Manage Payment Sessions
    • Authorize Payment Sessions
  • Products
    • Search Products
    • Get a Product
    • List Products
  • Product Variants
    • Get Product Variants
    • Get a Product Variant
  • Product Categories
    • Get a Product Category
    • List Product Categories
  • Product Collections
    • List Collections
    • Get a Collection
  • Product Tags
    • List Product Tags
  • Product Types
    • List Product Types
  • Regions
    • Get a Region
    • List Regions
  • Returns
    • Create Return
  • Return Reasons
    • List Return Reasons
      GET
    • Get a Return Reason
      GET
  • Shipping Options
    • List for Cart
    • Get Shipping Options
  • Swaps
    • Create a Swap
    • Get by Cart ID
  1. Return Reasons

Get a Return Reason

GET
/store/return-reasons/{id}
Return Reasons
Retrieve a Return Reason's details.

Request

Path Params
id
string 
required
The id of the Return Reason.

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.medusa-commerce.com/store/return-reasons/'

Responses

🟢200OK
application/json
Body
The return reason's details.
return_reason
object (Return Reason) 
required
A Return Reason is a value defined by an admin. It can be used on Return Items in order to indicate why a Line Item was returned.
id
string 
required
The return reason's ID
Example:
rr_01G8X82GCCV2KSQHDBHSSAH5TQ
value
string 
required
The value to identify the reason by.
Example:
damaged
label
string 
required
A text that can be displayed to the Customer as a reason.
Example:
Damaged goods
description
string  | null 
required
A description of the Reason.
Example:
Items that are damaged
parent_return_reason_id
string  | null 
required
The ID of the parent reason.
Example:
null
parent_return_reason
object  | null 
optional
The details of the parent reason.
return_reason_children
object 
optional
The details of the child reasons.
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.
deleted_at
string <date-time> | null 
required
The date with timezone at which the resource was deleted.
metadata
object  | null 
required
An optional key-value map with additional details
Example:
{"car":"white"}
Example
{
  "return_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"
    }
  }
}
🟠400Client Error or Multiple Errors
🟠404Not Found Error
🟠409Invalid State Error
🟠422Invalid Request Error
🔴500Server Error
Modified at 2023-10-08 12:33:05
Previous
List Return Reasons
Next
List for Cart
Built with