Skip to main content
POST
/
admin
/
refund-reasons
/
{id}
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.refundReason.update("ret_123", {
  code: "refund",
  label: "Refund",
})
.then(({ refund_reason }) => {
  console.log(refund_reason)
})
{
"refund_reason": {
"id": "<string>",
"label": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"code": "<string>",
"description": "<string>",
"metadata": {}
}
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The refund reason's ID.

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 properties to update in the refund reason.

label
string
required

The refund reason's label.

code
string
required

The refund reason's code.

description
string

The refund reason's description.

metadata
object

The refund reason's metadata.

Response

OK

The refund reason's details.

refund_reason
object
required

The refund reason's details.