Skip to main content
POST
/
admin
/
return-reasons
JS SDK
import Switchyard from "@switchyard/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.returnReason.create({
  value: "refund",
  label: "Refund",
})
.then(({ return_reason }) => {
  console.log(return_reason)
})
{
  "return_reason": {
    "id": "<string>",
    "value": "<string>",
    "label": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "metadata": {}
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Body

application/json

The details of the return reason to create.

​
value
string
required

The return reason's value.

​
label
string
required

The return reason's label.

​
description
string

The return reason's description.

​
parent_return_reason_id
string

The ID of the parent return reason.

​
metadata
object

The return reason's metadata, can hold custom key-value pairs.

Response

OK

The return reason's details.

​
return_reason
object
required

The return reason's details.