Skip to main content
POST
/
admin
/
draft-orders
/
{id}
/
edit
/
shipping-methods
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.draftOrder.addShippingMethod("order_123", {
  shipping_option_id: "shipping_option_123",
})
.then(({ draft_order_preview }) => {
  console.log(draft_order_preview)
})

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 draft order's ID.

Body

application/json

The details of the shipping method to add to a draft order.

​
shipping_option_id
string
required

The ID of the shipping option that this method is created from.

​
custom_amount
number

A custom amount to be charged for this shipping method. If not provided, the shipping option's amount will be used.

​
description
string

The shipping method's description.

​
internal_note
string

A note viewed only by admin users about the shipping method.

​
metadata
object

The shipping method's metadata, can hold custom key-value pairs.

Response

OK