Skip to main content
POST
/
admin
/
shipping-options
/
{id}
JS SDK
import Medusa from "@medusajs/js-sdk"

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

sdk.admin.shippingOption.update("so_123", {
  name: "Standard Shipping",
})
.then(({ shipping_option }) => {
  console.log(shipping_option)
})
{
  "shipping_option": {
    "id": "<string>",
    "name": "<string>",
    "price_type": "calculated",
    "service_zone_id": "<string>",
    "service_zone": {},
    "provider_id": "<string>",
    "provider": {
      "id": "<string>",
      "is_enabled": true
    },
    "shipping_option_type_id": "<string>",
    "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>"
    },
    "shipping_profile_id": "<string>",
    "shipping_profile": {
      "id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    },
    "rules": [
      {
        "id": "<string>",
        "attribute": "is_return",
        "operator": "gt",
        "value": "<string>",
        "shipping_option_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ],
    "prices": [
      {
        "price_rules": [
          {
            "id": "<string>",
            "value": "<string>",
            "operator": "gt",
            "attribute": "<string>",
            "price_id": "<string>",
            "priority": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ],
        "rules_count": 123,
        "id": "<string>",
        "title": "<string>",
        "currency_code": "usd",
        "amount": 123,
        "raw_amount": {},
        "min_quantity": 123,
        "max_quantity": 123,
        "price_set_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ],
    "data": {},
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

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

​
name
string

The shipping option's name.

​
data
object

The shipping option's data that is useful for third-party providers.

​
price_type
enum<string>

The type of the shipping option's price. If calculated, its price is retrieved by the associated fulfillment provider during checkout. If flat, its price is set in the prices property.

Available options:
calculated,
flat
​
provider_id
string

The ID of the associated fulfillment provider that is used to process the option.

​
shipping_profile_id
string

The ID of the shipping profile this shipping option belongs to.

​
type
object

The shipping option's type.

​
prices
object[]

The shipping option's prices. If the price_type is calculated, pass an empty array.

The shipping option's price for a currency code.

​
rules
object[]

The shipping option's rules.

The details of a new shipping option rule.

Response

OK

The shipping option's details.

​
shipping_option
object
required

The shipping option's details.