The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.

Anchor to section titled 'undefined'

Policy

You can use the Policy resource to access the policies that a merchant has configured for their shop, such as their refund and privacy policies.

Only the shop owner can edit this information from the Shopify admin. The Policy resource lets you only retrieve information about a shop's policies.

Was this section helpful?
#Endpoints
Anchor to section titled 'The Policy resource'

The Policy resource

Properties
title
->title
The name of the policy.
body
->body
A description of the policy.
url
->url
The public URL of the policy.
created_at
->createdAt
The date and time (ISO 8601 format) when the policy was created.
updated_at
->updatedAt
The date and time (ISO 8601 format) when the policy was last modified.
handle
->type
A unique identifer for the policy used to build the policy's URL.
Was this section helpful?
{}The Policy resource
{
  "title": {
    "title": "Refund Policy"
  },
  "body": {
    "body": "You have 30 days to get a refund"
  },
  "url": {
    "url": "https://jsmith.myshopify.com/548380009/policies/878590288"
  },
  "created_at": {
    "created_at": "2012-02-15T15:12:21-05:00"
  },
  "updated_at": {
    "updated_at": "2012-08-24T14:01:47-04:00"
  },
  "handle": {
    "handle": "terms-of-service"
  }
}
Anchor to section titled 'GET request, Retrieves a list of the shop's policies'

get
Retrieves a list of the shop's policies

shop
Retrieves a list of the shop's policies
Anchor to section titled 'Parameters of Retrieves a list of the shop's policies'

Parameters

api_version
string
required
Was this section helpful?
Anchor to section titled 'Examples of Retrieves a list of the shop's policies'

Examples

Was this section helpful?
get
/admin/api/2024-10/policies.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/policies.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "policies": [
    {
      "body": "You have 30 days to get a refund",
      "created_at": "2024-09-19T10:14:44-04:00",
      "updated_at": "2024-09-19T10:14:44-04:00",
      "handle": "refund-policy",
      "title": "Refund policy",
      "url": "https://jsmith.myshopify.com/548380009/policies/997884056"
    }
  ]
}