Skip to Content

Jitterbit Harmony Square Connector

Summary

The Square connector for Jitterbit Harmony Cloud Studio provides an interface for entering user-provided input such as credentials to create an authenticated Square connection. That connection provides the foundation to configure associated Square connector activities that interact with the connection. Together, a specific Square connection and its activities are referred to as a Square endpoint.

Note

This connector supports the Customers object in the Square API. To interact with additional objects, such as the Catalog, Customers, Inventory, Invoices, Orders, Payments, Subscriptions, and Terminal objects, use the Square v2 (Beta) connector.

Supported API Versions and Prerequisites

The Square connector uses the Square REST API. Refer to the API documentation for information on the schema fields.

The Square connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

Connector Overview

This connector is used to first configure a Square connection, establishing access to Square, and then used to configure one or more Square activities associated with that connection as a source or target within an operation:

  • Query Activity: Retrieves customers from a Square connection and is used as a source in an operation.

  • Create Activity: Creates new customers at a Square connection and is used as a target in an operation.

  • Update Activity: Updates existing customers at a Square connection and is used as a target in an operation.

  • Delete Activity: Deletes existing customers from a Square connection and is used as a target in an operation.

The Square connector uses the Square REST API. Refer to the API documentation for information on the schema fields.

The Square connector requires the use of an agent version 10.1 or later.

Together, a specific Square connection and its activities are referred to as a Square endpoint. Once a connection is configured, activities associated with the endpoint are available from the Endpoints filter:

Connections tab

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Square Registration

As the connection will be an application that interfaces with Square, you will need a Personal Access Token to access the Square server. See Square Registration for details.

Accessing the Connector

The Square connector is accessed from the design component palette's Connections tab (see Design Component Palette).

Activities

Troubleshooting

If you experience issues with the Square connector, these troubleshooting steps are recommended:

  1. Ensure the Square connection is successful by using the Test button in the configuration screen. If the connection is not successful, the error returned may provide an indication as to the problem.

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.verbose.logging.square" level="DEBUG"/>

  5. If using Private Agents, you can check the agent logs for more information.