Website

self LINK RELATION

Actions

method	description
GET	View website
PATCH	Update website
DELETE	Delete website
OPTIONS	Retrieve supported HTTP methods

Request parameters

property	type	required
url	url	true
comment	text	false

Profile

A Website represents a webshop. A business can have multiple webshops.

See ch:websites for more information on adding more addresses.

For the purposes of the application process, a website supports a file with label ownership. See ch:files for more information on handling files.

Properties

name	type	read-only	commentable
url	url	false	true
comment	text	false	true

Link relations

rel	conditional
self	false
ch:application	false
ch:comments	false
ch:files	false

Additional semantics

Field comments

This resource supports field comments. See Field comments for more information.

Example representation

{
  "url": "https://www.example.org",
  "comment": "Main website",
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/websites/055cd9bb-daaf-4816-96ab-b1bd0d07be3c"
    },
    "ch:application": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f"
    },
    "ch:comments": {
      "href": "https://merchant.test.clearhaus.com/websites/055cd9bb-daaf-4816-96ab-b1bd0d07be3c/comments{?page,per_page}"
    },
    "ch:files": {
      "href": "https://merchant.test.clearhaus.com/websites/055cd9bb-daaf-4816-96ab-b1bd0d07be3c/files{?page,per_page}"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  }
}