Spree SDK
List delivery methods
Storefront-visible delivery methods. Filter by fulfillment_type to discover pickup options.
GET
Spree SDK
Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
import { createClient } from '@spree/sdk'
const client = createClient({
baseUrl: 'https://your-store.com',
publishableKey: '<api-key>',
})
const { data: pickupMethods } = await client.deliveryMethods.list({
fulfillment_type: 'pickup',
})curl --request GET \
--url http://{defaultHost}/api/v3/store/delivery_methods \
--header 'x-spree-api-key: <api-key>'{
"data": [
{
"id": "dm_gbHJdmfrXB",
"name": "Store pickup",
"code": "PICKUP_1",
"estimated_transit_business_days_min": null,
"estimated_transit_business_days_max": null,
"digital": false,
"pickup": true,
"pickup_point": false
}
],
"meta": {
"page": 1,
"limit": 25,
"count": 1,
"pages": 1,
"from": 1,
"to": 1,
"in": 1,
"previous": null,
"next": null
}
}Storefront-visible delivery methods. Filter by fulfillment_type to discover pickup options.
import { createClient } from '@spree/sdk'
const client = createClient({
baseUrl: 'https://your-store.com',
publishableKey: '<api-key>',
})
const { data: pickupMethods } = await client.deliveryMethods.list({
fulfillment_type: 'pickup',
})curl --request GET \
--url http://{defaultHost}/api/v3/store/delivery_methods \
--header 'x-spree-api-key: <api-key>'{
"data": [
{
"id": "dm_gbHJdmfrXB",
"name": "Store pickup",
"code": "PICKUP_1",
"estimated_transit_business_days_min": null,
"estimated_transit_business_days_max": null,
"digital": false,
"pickup": true,
"pickup_point": false
}
],
"meta": {
"page": 1,
"limit": 25,
"count": 1,
"pages": 1,
"from": 1,
"to": 1,
"in": 1,
"previous": null,
"next": null
}
}Was this page helpful?
