Skip to main content

Policy

Version: 1.0

The list of policies that a merchant has configured for their store, such as their refund or privacy policies.

Only the shop owner can edit this information from inside their shop admin dashboard by navigating to the "Settings" tab and selecting the "General" tab. The API doesn't let you do anything other than retrieve information about a shop.

Authenticated access scopes: com.read_shop

What can you do with Policy?​

The haravan API lets you do the following with the Policy resource. More detailed versions of these general actions may be available:

Endpoints​



Receive a list of all Policies​

GET
https://apis.haravan.com/com/policies.json

Get the policies and their contents for a shop

Parameters​

title

Name of the policy

body

Contents of the policy

url

Public URL to policy

Getting the shops policies

  • GET https://apis.haravan.com/com/policies.json

Response:

Details
HTTP/1.1 200 OK
{
  "policies": [
    {
      "body": "You have 30 days to get a refund",
      "created_at": "2015-03-28T13:31:32-04:00",
      "title": "Refund Policy",
      "updated_at": "2015-03-28T13:31:32-04:00",
      "url": "https:\/\/apple.myharavan.com\/690933842\/policies\/878590288"
    }
  ]
}