Skip to Content

ShipStation Create activity

Introduction

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

Rate limits

Different rate limits are enforced depending on the ShipStation API version used:

For more information on the rate limits, see the ShipStation API V1 or ShipStation API V2 documentation.

Create a ShipStation Create activity

An instance of a ShipStation Create activity is created from a ShipStation connection using its Create 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 Create an activity or tool instance in Component reuse.

An existing ShipStation Create activity can be edited from these locations:

Configure a ShipStation Create activity

Follow these steps to configure a ShipStation Create activity:

Step 1: Enter a name and select an object

In this step, provide a name for the activity and select an object. Each user interface element of this step is described below.

ShipStation Create activity configuration step 1

  • Name: Enter a name to identify the activity. The name must be unique for each ShipStation Create 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 column's value 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 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 Create 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 V1 or ShipStation API V2 depending on the version selected when configuring a ShipStation connection. Refer to the API documentation for information on the schema nodes and fields.

  • Refresh: Click the 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.

  • Edit: Click the edit icon above the response data schema to enter the editor for that schema. The editor allows you to add, delete, and reorganize nodes and fields and change their data types. All newly added nodes and fields are set to [0, 1] cardinality. Changes made to the data schema must be acceptable to the endpoint and should be made only after consulting any available documentation for the endpoint. After making schema edits, a last-edited date is displayed along the top of the data schema to indicate the schema has had manual edits. Refreshing the data schema will reset the schema to its default structure.

  • 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 Create activity, complete the configuration of the operation by adding and configuring other activities or tools 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 Create 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.