Skip to Content

ShipStation Delete Activity

Introduction

A ShipStation Delete activity, using its ShipStation connection, deletes object data from ShipStation and is intended to be used as a target to consume data in an operation.

Rate Limits

The ShipStation API enforces a rate limit of 40 requests per second per API key and API secret pair. For more information on the rate limit, see the ShipStation API documentation.

Create a ShipStation Delete Activity

An instance of a ShipStation Delete activity is created from a ShipStation connection using its Delete 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 ShipStation Delete activity can be edited from these locations:

Configure a ShipStation Delete Activity

Follow these steps to configure a ShipStation Delete activity:

Step 1: Enter a Name and Select an Object

In this step, provide a name for the activity and select the object containing the data to be deleted. Each user interface element of this step is described below.

ShipStation Delete Activity Configuration Step 1

  • Name: Enter a name to identify the activity. The name must be unique for each ShipStation Delete activity and must not contain forward slashes / or colons :.

  • Select an Object: This section displays objects available in the ShipStation endpoint. When reopening an existing activity configuration, only the selected object is displayed instead of reloading the entire object list.

    • Selected ShipStation Object: After an object is selected, it is listed here.

    • Search: Enter any part of the object name into the search box to filter the list of objects. The search is not case-sensitive. If objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload objects from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload objects from the ShipStation endpoint. This may be useful if objects have been added to ShipStation. This action refreshes all metadata used to build the table of objects displayed in the configuration.

    • Selecting an Object: Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the ShipStation endpoint:

      • Name: The object name from ShipStation.

      • Description: The object description from ShipStation.

!!! tip If the table does not populate with available objects, the ShipStation connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • 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 to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the Data Schemas

Any request or response schemas generated from the endpoint are displayed. Each user interface element of this step is described below.

ShipStation Delete Activity Configuration Step 2

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

!!! note Data supplied in a transformation takes precedence over the activity configuration.

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

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the ShipStation endpoint. This action also regenerates a 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 to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps

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

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

ShipStation Delete activities can be used as a target with these operation patterns:

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.