Get a policy - Spree Commerce documentation

GET

api

store

policies

{id}

Spree SDK

import { createClient } from '@spree/sdk'

const client = createClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

const policy = await client.policies.get('return-policy')

{
  "id": "pol_uw2YK1rnl0",
  "name": "Return Policy",
  "slug": "return-policy",
  "body": "You can return items within 30 days.",
  "body_html": "<div class=\"trix-content\">\n  You can return items within 30 days.\n</div>\n"
}

Authorizations

x-spree-api-key

string

header

required

Publishable API key for store access

Headers

x-spree-api-key

string

required

Path Parameters

string

required

Policy slug (e.g., return-policy) or prefixed ID (e.g., pol_abc123)

Query Parameters

fields

string

Comma-separated list of fields to include. id is always included.

Response

policy found

string

required

name

string

required

slug

string

required

body

string | null

required

body_html

string | null

required

List store policies

Download a digital product

⌘I

Spree SDK

import { createClient } from '@spree/sdk'

const client = createClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

const policy = await client.policies.get('return-policy')

{
  "id": "pol_uw2YK1rnl0",
  "name": "Return Policy",
  "slug": "return-policy",
  "body": "You can return items within 30 days.",
  "body_html": "<div class=\"trix-content\">\n  You can return items within 30 days.\n</div>\n"
}