Medusa
Get a Return Reason
GET/store/return-reasons/{id}Retrieve a Return Reason's details.
Request
Path Params
id
string
required
The id of the Return Reason.
Request samples
Responses
OK(200)
Client Error or Multiple Errors(400)
Not Found Error(404)
Invalid State Error(409)
Invalid Request Error(422)
Server Error(500)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
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
Not configured
Last modified: a year ago