Skip to main content
POST
/
admin
/
shipping-option-types
/
{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.shippingOptionType.update("sotype_123", {
  code: "express"
})
.then(({ shipping_option_type }) => {
  console.log(shipping_option_type)
})
{
  "shipping_option_type": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "label": "<string>",
    "description": "<string>",
    "code": "<string>",
    "shipping_option_id": "<string>"
  }
}

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 shipping option type'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. 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 shipping option type.

​
code
string

The shipping option type's code.

​
description
string

The shipping option type's description.

​
label
string

The shipping option type's label.

Response

OK

The shipping option type's details.

​
shipping_option_type
object
required

The shipping option's details.