List delivery methods

Spree SDK

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',
})

{
  "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
  }
}

GET

api

store

delivery_methods

Spree SDK

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',
})

{
  "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
  }
}

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[name_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`available_to_sellers`	True or false	`eq` `not_eq` `in` `not_in` `true` `false` `null`
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`name`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`seller_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`storefront_visible`	True or false	`eq` `not_eq` `in` `not_in` `true` `false` `null`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

Sort by: available_to_sellers, created_at, id, name, seller_id, storefront_visible, updated_at. Prefix a field with - to sort descending.

Authorizations

x-spree-api-key

string

header

required

Publishable API key for store access

Headers

x-spree-api-key

string

required

Query Parameters

q[search]

string

Matches any of name (partial, case-insensitive).

fulfillment_type

string

Filter: shipping, digital, pickup

object

Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.

Response

200 - application/json

delivery methods found

⌘I

API basics

Endpoints

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters