GET
/
admin
/
fulfillment-providers
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.fulfillmentProvider.list()
.then(({ fulfillment_providers, count, limit, offset }) => {
  console.log(fulfillment_providers)
})
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "fulfillment_providers": [
    {
      "id": "<string>",
      "is_enabled": true
    }
  ],
  "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.

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

​
id

Filter by a fulfillment provider's ID.

​
is_enabled
boolean

Filter by whether the fulfillment provider is enabled.

​
q
string

Search term to filter a fulfillment provider's searchable properties.

​
stock_location_id

Filter by associated stock location's ID.

​
with_deleted
boolean

Whether to include deleted records in the result.

Response

OK

The paginated list of fulfillment providers.

​
limit
number
required

The maximum number of items returned.

​
offset
number
required

The number of items skipped before retrieving the returned items.

​
count
number
required

The total count of items.

​
fulfillment_providers
object[]
required

The list of fulfillment providers.

​
estimate_count
number

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