Use the Snippets API

Applies to: Snippets APISnippets API | Sites APISites API

Learn how to use the Snippets API to manage snippets for Square Online sites.

You can use the Snippets API to manage a snippet on a Square Online site. Snippets add custom functionality to Square Online sites. For more information, see Snippets APISnippets API.

The UpsertSnippetUpsertSnippet endpoint adds or updates a snippet on a Square Online site. This operation appends the snippet code to the end of the head tag on every page of the site, except for checkout pages. Snippet code is sent as a string that contains valid HTML, CSS, JavaScript, or a combination of the three. The string has a maximum length of 65,535 characters.

An application can create and manage one snippet on any given site. For an example workflow, see Add a Snippet to a SiteAdd a Snippet to a Site.

The following is an example request. To get the site ID, call the ListSitesListSites endpoint to retrieve the sites that belong to a seller.

If successful, this endpoint returns a 200 OK status code and a response similar to the following example:

{
  "snippet": {
    "id": "snippet_5d178150-a6c0-11eb-a9f1-437e6example",
    "site_id": "site_27807527648example",
    "content": "<script type=\"text/javascript\">var js = 1;</script>",
    "created_at": "2021-03-11T25:40:09.000000Z", 
    "updated_at": "2021-03-11T25:40:09.000000Z"
  }
}

If the site cannot be found, this endpoint returns a 404 Not Found status code and the following response:

{
  "errors": [
    {
      "category": "INVALID_REQUEST_ERROR",
      "code": "NOT_FOUND",
      "detail": "Resource not found."
    }
  ]
}

The RetrieveSnippetRetrieveSnippet endpoint retrieves a snippet from a Square Online site. A site can contain snippets from multiple applications, but you can retrieve only the snippet that was added by your application.

The following is an example request. To get the site ID, call the ListSitesListSites endpoint to retrieve the sites that belong to a seller.

If successful, this endpoint returns a 200 OK status code and a response similar to the following example:

{
  "snippet": {
    "id": "snippet_5d178150-a6c0-11eb-a9f1-437e6example",
    "site_id": "site_27807527648example",
    "content": "<script type=\"text/javascript\">var js = 1;</script>",
    "created_at": "2021-03-11T25:40:09.000000Z", 
    "updated_at": "2021-03-11T25:40:09.000000Z"
  }
}

If the snippet cannot be found, this endpoint returns a 404 Not Found status code and the following response:

{
  "errors": [
    {
      "category": "INVALID_REQUEST_ERROR",
      "code": "NOT_FOUND",
      "detail": "Resource not found."
    }
  ]
}

The DeleteSnippetDeleteSnippet endpoint removes a snippet from a Square Online site. You can delete only the snippet that was added by your application.

The following is an example request. To get the site ID, call the ListSitesListSites endpoint to retrieve the sites that belong to a seller.

If successful, this endpoint returns a 200 OK status code and an empty JSON object:

{}

If there is no snippet for the specified site, this endpoint returns a 404 Not Found status code and the following response:

{
  "errors": [
    {
      "category": "INVALID_REQUEST_ERROR",
      "code": "NOT_FOUND",
      "detail": "Resource not found."
    }
  ]
}

• Snippets APISnippets API
• Add a Snippet to a SiteAdd a Snippet to a Site
• Square Online Store Snippets ExampleSquare Online Store Snippets Example
• Video: Sandbox Sessions: Snippets APIVideo: Sandbox Sessions: Snippets API