Skip to main content
The Sites API allows you to retrieve information about Square Online sites. Square Online enables sellers to create and manage online stores.
Square Online APIs are publicly available as part of an early access program. For more information, see Early access program for Square Online APIs.

​
Overview

The Sites client provides methods to:
  • List all Square Online sites for a seller

​
Client Initialization

import (
    "context"
    "github.com/square/square-go-sdk/v3"
    "github.com/square/square-go-sdk/v3/core"
)

client := square.NewClient(
    &core.RequestOptions{
        Token: "YOUR_ACCESS_TOKEN",
    },
)

​
Methods

​
List Sites

Lists all Square Online sites that belong to a seller. Sites are listed in descending order by the created_at date.
sites/client.go
response, err := client.Sites.List(context.TODO())
if err != nil {
    // Handle error
}

for _, site := range response.Sites {
    fmt.Printf("Site: %s\n", *site.SiteTitle)
    fmt.Printf("Domain: %s\n", *site.Domain)
    fmt.Printf("Published: %t\n", *site.IsPublished)
    fmt.Printf("Created: %s\n", *site.CreatedAt)
}
​
sites
[]*Site
Array of site objects belonging to the seller

​
Response Types

​
Site

Represents a Square Online site.
​
id
string
The Square-assigned ID of the site
​
site_title
string
The title of the site (displayed in the browser title bar)
​
domain
string
The domain of the site without the protocol. For example, mysite1.square.site
​
is_published
bool
Indicates whether the site is currently published and accessible to customers
​
created_at
string
The timestamp when the site was created, in RFC 3339 format
​
updated_at
string
The timestamp when the site was last updated, in RFC 3339 format

​
Use Cases

​
List All Published Sites

response, err := client.Sites.List(context.TODO())
if err != nil {
    log.Fatal(err)
}

fmt.Println("Published Sites:")
for _, site := range response.Sites {
    if *site.IsPublished {
        fmt.Printf("- %s (https://%s)\n", *site.SiteTitle, *site.Domain)
    }
}

​
Get Site IDs for Snippet Management

// First, get all sites
response, err := client.Sites.List(context.TODO())
if err != nil {
    log.Fatal(err)
}

// Store site IDs for use with Snippets API
var siteIDs []string
for _, site := range response.Sites {
    siteIDs = append(siteIDs, *site.ID)
    fmt.Printf("Site ID: %s - %s\n", *site.ID, *site.SiteTitle)
}

// Now you can use these IDs with the Snippets API
for _, siteID := range siteIDs {
    snippetResponse, err := client.Snippets.Get(context.TODO(), &square.GetSnippetsRequest{
        SiteID: siteID,
    })
    // Process snippets...
}

​
Check Site Status

response, err := client.Sites.List(context.TODO())
if err != nil {
    log.Fatal(err)
}

for _, site := range response.Sites {
    status := "Draft"
    if *site.IsPublished {
        status = "Published"
    }
    
    fmt.Printf("%s: %s\n", *site.SiteTitle, status)
    fmt.Printf("  Domain: %s\n", *site.Domain)
    fmt.Printf("  Last Updated: %s\n", *site.UpdatedAt)
}

​
Error Handling

response, err := client.Sites.List(context.TODO())
if err != nil {
    // Check for API errors
    if response != nil && len(response.Errors) > 0 {
        for _, e := range response.Errors {
            fmt.Printf("Error: %s - %s\n", e.Category, e.Detail)
        }
    }
    return err
}

​
Integration with Other APIs

The Sites API works closely with the Snippets API to manage custom code injections on Square Online sites. 
// Step 1: Get all sites
sitesResponse, err := client.Sites.List(context.TODO())
if err != nil {
    log.Fatal(err)
}

// Step 2: Add a snippet to a specific site
if len(sitesResponse.Sites) > 0 {
    siteID := *sitesResponse.Sites[0].ID
    
    snippetRequest := &square.UpsertSnippetRequest{
        SiteID: siteID,
        Snippet: &square.Snippet{
            Content: "<script>console.log('Hello from Square!');</script>",
        },
    }
    
    snippetResponse, err := client.Snippets.Upsert(context.TODO(), snippetRequest)
    if err != nil {
        log.Fatal(err)
    }
    
    fmt.Println("Snippet added successfully!")
}

​
Important Notes

The Sites API is part of an early access program and may be subject to changes.
Use the is_published field to filter sites that are currently live and accessible to customers.
Sites are automatically sorted by created_at in descending order (newest first).

Build docs developers (and LLMs) love

Get started for freeTalk to us