Skip to Content

ShipStation Connection

Introduction

A ShipStation connection, created using the ShipStation connector, establishes access to ShipStation. Once a connection is configured, you can create instances of ShipStation activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or Edit a ShipStation Connection

A new ShipStation connection is created using the ShipStation connector from one of these locations:

An existing ShipStation connection can be edited from these locations:

Configure a ShipStation Connection

Each user interface element of the ShipStation connection configuration screen is described below.

ShipStation connection configuration

Tip

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

  • Connection Name: Enter a name to use to identify the connection. The name must be unique for each ShipStation connection and must not contain forward slashes / or colons :. This name is also used to identify the ShipStation endpoint, which refers to both a specific connection and its activities.

  • API Key: Enter the API key. The API key is listed as the Username in the ShipStation instance's API settings.

  • API Secret: Enter the API secret. The API secret is listed on the ShipStation instance's API settings.

  • Email: Enter the email associated with the ShipStation instance.

  • Use Proxy per Endpoint: When using a Private Agent, this setting can be selected to use Private Agent proxy settings.

  • Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

  • Save Changes: Click to save and close the connection configuration.

  • Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

  • Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal). A message asks you to confirm that you want to delete the connection.

Next Steps

After a ShipStation connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions Menus in Connector Basics.

These activity types are available:

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

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

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

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