list-sites-response.md

List Sites Response

Represents a ListSites response. The response can include either sites or errors.

Structure

ListSitesResponse

Fields

Name	Type	Tags	Description	Getter	Setter
errors	?(Error[])	Optional	Any errors that occurred during the request.	getErrors(): ?array	setErrors(?array errors): void
sites	?(Site[])	Optional	The sites that belong to the seller.	getSites(): ?array	setSites(?array sites): void

Example (as JSON)

{
  "sites": [
    {
      "created_at": "2020-10-28T13:22:51.000000Z",
      "domain": "mysite2.square.site",
      "id": "site_278075276488921835",
      "is_published": false,
      "site_title": "My Second Site",
      "updated_at": "2020-10-28T13:22:51.000000Z"
    },
    {
      "created_at": "2020-06-18T17:45:13.000000Z",
      "domain": "mysite1.square.site",
      "id": "site_102725345836253849",
      "is_published": true,
      "site_title": "My First Site",
      "updated_at": "2020-11-23T02:19:10.000000Z"
    }
  ],
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    }
  ]
}