Skip to main content
GET
/
admin
/
shipping-option-types
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.shippingOptionType.list()
.then(({ shipping_option_types, count, limit, offset }) => {
  console.log(shipping_option_types)
})
{ "limit": 123, "offset": 123, "count": 123, "shipping_option_types": [ { "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>" } ], "estimate_count": 123 }

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. 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.

​
offset
number

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the list.

​
order
string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

​
with_deleted
boolean

Whether to include deleted records in the result.

​
q
string

Search query to apply on the shipping option type's searchable properties.

​
id

Filter by a shipping option type's ID.

​
label

Filter by a shipping option type's label.

​
code

Filter by a shipping option type's code.

​
created_at
created_at · object

Filter by a shipping option type's creation date.

​
updated_at
updated_at · object

Filter by a shipping option type's update date.

​
deleted_at
deleted_at · object

Filter by a shipping option type's deletion date.

​
$and
$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

​
$or
$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

Response

OK

The paginated list of shipping option types.

​
limit
number
required

The maximum number of items returned.

​
offset
number
required

The number of items skipped before returning the results.

​
count
number
required

The total number of items.

​
shipping_option_types
object[]
required

The list of shipping option types.

​
estimate_count
number

The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.