Skip to Content

Square Query activity

Introduction

A Square Query activity retrieves customers from a Square connection and is intended to be used as a source to provide data to an operation. After configuring a Square connection, you can configure as many Square activities as you like for each Square connection.

Create a Square activity

An instance of an activity is created from a connection using an activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing activity can be edited from these locations:

Configure a Square Query activity

Follow these steps to configure a Square Query activity:

Step 1: Enter a name and specify settings

Connections tab

Tip

Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin typing an open square bracket [ into the field or click the variable icon to display existing variables to choose from.

  • Name: Enter a name to use to identify the Square Query activity. The name must be unique for each Query activity and must not contain forward slashes (/) or colons (:).

  • Field Sort: Specify the field sort to be used, one of DEFAULT or CREATED_AT.

  • Sort Order: Specify the sort order to be used, one of DESC (descending) or ASC (ascending).

  • Number of Records To Return: The maximum number of results to be returned in a single page. A valid entry is either empty or a value from 0 to 1000. Leave the field empty (the default) to return all records.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Step 2: Review the data schemas

Connections tab

  • Data Schema: The response data schema for Square will be displayed. If the operation uses a transformation, the data schemas will be displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

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

    • Response:

      Response Schema Field/Node Notes
      errorMessage The error message
      customers Node of the customers
      id Customer ID
      createdAt Creation date
      updatedAt Update date
      givenName The customer's given (first) name
      familyName The customer's family (last) name
      companyName The customer's company
      nickname The customer's nickname
      emailAddress The customer's email address
      phoneNumber The customer's phone number

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the endpoint. This action also regenerates the schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Next steps

After configuring a Square Query activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

After a Square activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. See Activity actions menu for details.

Square Query activities can be used as a source with these operation patterns:

Other patterns are not valid using Square Query activities. See the validation patterns on the Operation validity page.

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.