Skip to Content

Square v2 Connector

Summary

The Square v2 connector establishes access to Square v2.

The Square v2 connector provides an interface for creating a Square v2 connection, the foundation used for generating instances of Square v2 activities. These activities, once configured, interact with Square v2 through the connection.

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

Connector Overview

This connector is used to first configure a Square v2 connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific Square v2 connection and its activities are referred to as a Square v2 endpoint:

Square v2 activity types

  • Read: Retrieves all object data from Square and is intended to be used as a source in an operation.

  • Query: Retrieves specified object data from Square and is intended to be used as a source in an operation.

  • Create: Creates object data in Square and is intended to be used as a target in an operation.

  • Update: Updates object data in Square and is intended to be used as a target in an operation.

  • Delete: Deletes object data from Square and is intended to be used as a target in an operation.

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.

Prerequisites and Supported API Versions

The Square v2 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.

The Square v2 connector uses the Square API. Refer to the API documentation for information on the schema nodes and fields.

Troubleshooting

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

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  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.squarev2" level="DEBUG"/>

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