List delivery zones

Spree Seller SDK

import { createSellerClient } from '@spree/seller-sdk'

const client = createSellerClient({
  baseUrl: 'https://your-store.com',
  jwtToken: 'eyJhbGciOi...',
  sellerId: 'sel_UkLWZg9DAJ',
})

const { data: deliveryZones } = await client.deliveryZones.list({
  delivery_profile_id: 'fp_UkLWZg9DAJ',
})

{
  "data": [
    {
      "id": "dz_UkLWZg9DAJ",
      "name": "Domestic",
      "description": "Maxime illum debitis veritatis porro accusantium laudantium omnis.",
      "delivery_profile_id": "fp_gbHJdmfrXB"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

GET

api

seller

delivery_zones

Spree Seller SDK

import { createSellerClient } from '@spree/seller-sdk'

const client = createSellerClient({
  baseUrl: 'https://your-store.com',
  jwtToken: 'eyJhbGciOi...',
  sellerId: 'sel_UkLWZg9DAJ',
})

const { data: deliveryZones } = await client.deliveryZones.list({
  delivery_profile_id: 'fp_UkLWZg9DAJ',
})

{
  "data": [
    {
      "id": "dz_UkLWZg9DAJ",
      "name": "Domestic",
      "description": "Maxime illum debitis veritatis porro accusantium laudantium omnis.",
      "delivery_profile_id": "fp_gbHJdmfrXB"
    }
  ],
  "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
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`delivery_profile_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `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`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

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

Authorizations

Authorization

string

header

required

JWT token for an authenticated seller session (seller_api audience)

Headers

X-Spree-Seller-Id

string

required

Query Parameters

delivery_profile_id

string

Only zones under this delivery profile

page

integer

Page number

limit

integer

Records per page (max 100)

object

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

Response

200 - application/json

delivery zones listed

data

object[]

required

Show child attributes

API basics

Endpoints

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters