Skip to main content
POST
/
admin
/
shipping-profiles
JS SDK
import Medusa 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.shippingProfile.create({
  name: "Default Shipping Profile",
})
.then(({ shipping_profile }) => {
  console.log(shipping_profile)
})
{
  "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"
  }
}

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 shipping profile's details.

​
name
string
required

The shipping profile's name.

​
type
string
required

The shipping profile's type.

​
metadata
object

The shipping profile's metadata, used to store custom key-value pairs.

Response

OK

The shipping profile's details.

​
shipping_profile
object
required

The shipping profile's details..