ShipStation

ShipStation is a web-based shipping software that helps e-commerce businesses manage orders, print shipping labels, and track shipments across multiple carriers, streamlining the fulfillment process.

Power end-to-end data operations for your ShipStation API with Nexla. Our bi-directional ShipStation connector is purpose-built for ShipStation, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to ShipStation or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your ShipStation workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a ShipStation credential, you need to obtain your API Key and API Secret from your ShipStation account. ShipStation uses Basic Authentication for all API requests, with the API Key as the username and the API Secret as the password.

To obtain your ShipStation API credentials, follow these steps:

1. Sign in to your ShipStation account using your administrator credentials.

2. Navigate to Settings in your ShipStation account by clicking the gear icon in the top right corner.

3. In the Settings menu, click API Settings or navigate to Settings > API Settings.

4. Your API Key will be displayed as the username in the API Settings page. Copy the API Key.

5. Your API Secret will be displayed in the API Settings page. Copy the API Secret immediately, as it may not be accessible again after you navigate away from the page.

6. Store both credentials securely, as you will need them to configure your Nexla credential. The API Key and API Secret are sensitive information and should be kept confidential.

The API Key and API Secret are used for Basic Authentication in all API requests to the ShipStation API. The API Key is used as the username and the API Secret is used as the password in the Basic Authentication header. If your credentials are compromised, you should immediately revoke them in your ShipStation account settings and generate new ones. For detailed information about obtaining API credentials, API authentication, and available endpoints, refer to the ShipStation API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
API Key	Yes	No	Your ShipStation API Key. You can find your API Key as the username at https://ss.shipstation.com/#/settings/api.
API Secret	Yes	Yes	Your ShipStation API Secret. You can find your API Secret at https://ss.shipstation.com/#/settings/api.

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – ShipStation API

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your ShipStation API Key in the API Key field. This is the API Key you obtained from your ShipStation account settings (Settings > API Settings). The API Key is used as the username in Basic Authentication for all API requests to the ShipStation API.

4. Enter your ShipStation API Secret in the API Secret field. This is the API Secret you obtained from your ShipStation account settings. The API Secret is used as the password in Basic Authentication for all API requests to the ShipStation API. The API Secret is sensitive information and must be kept confidential.

   Your ShipStation API credentials can be found in your ShipStation account settings under Settings > API Settings. The API Key is used as the username and the API Secret is used as the password in Basic Authentication for all API requests to the ShipStation API.

   If your API credentials are compromised, you should immediately revoke them in your ShipStation account settings and generate new ones. The API Key and API Secret provide access to your ShipStation account data and should be treated as sensitive information. Keep your credentials secure and do not share them publicly.

   For detailed information about obtaining API credentials, API authentication, and available endpoints, see the ShipStation API documentation.

5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the ShipStation connector tile, then select the credential that will be used to connect to your ShipStation account, and click Next; or, create a new ShipStation credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common ShipStation endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Get Orders

This endpoint template retrieves a list of all orders from your ShipStation account. Use this template when you need to retrieve information about orders, including order IDs, order numbers, statuses, and other order metadata.

• This endpoint automatically retrieves all orders from your ShipStation account. The endpoint uses incrementing page-based pagination to handle large datasets efficiently, returning up to 100 records per page by default.

This endpoint returns a list of all orders from your ShipStation account, including order IDs, order numbers, statuses, and other order metadata. The endpoint uses incrementing page-based pagination with page and pageSize parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the page parameter.

For detailed information about orders, API response structures, pagination, and available order data, see the ShipStation API documentation.

Get Filtered Orders List

This endpoint template retrieves a list of orders that match filter criteria from your ShipStation account. Use this template when you need to retrieve orders based on specific search criteria, such as date ranges, order statuses, or other filters.

• Enter the order filter criteria in the Order Filter Criteria field. This should be a URL query string containing the search criteria (e.g., modifyDateStart={now-1}). The filter criteria determine which orders will be retrieved. See the documentation URL for available search criteria options.

This endpoint returns a list of orders that match the specified filter criteria from your ShipStation account. The endpoint uses incrementing page-based pagination with page and pageSize parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the page parameter.

For detailed information about order filtering, available search criteria, API response structures, pagination, and available order data, see the ShipStation API documentation.

Get Fulfillments

This endpoint template retrieves a list of all fulfillments from your ShipStation account. Use this template when you need to retrieve information about fulfillments, including fulfillment IDs, order numbers, and other fulfillment metadata.

• This endpoint automatically retrieves all fulfillments from your ShipStation account. The endpoint uses incrementing page-based pagination to handle large datasets efficiently, returning up to 100 records per page by default.

This endpoint returns a list of all fulfillments from your ShipStation account, including fulfillment IDs, order numbers, and other fulfillment metadata. The endpoint uses incrementing page-based pagination with page and pageSize parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the page parameter.

For detailed information about fulfillments, API response structures, pagination, and available fulfillment data, see the ShipStation API documentation.

Get Shipments

This endpoint template retrieves a list of all shipments from your ShipStation account. Use this template when you need to retrieve information about shipments, including shipment IDs, tracking numbers, and other shipment metadata.

• This endpoint automatically retrieves all shipments from your ShipStation account. The endpoint uses incrementing page-based pagination to handle large datasets efficiently, returning up to 100 records per page by default.

This endpoint returns a list of all shipments from your ShipStation account, including shipment IDs, tracking numbers, and other shipment metadata. The endpoint uses incrementing page-based pagination with page and pageSize parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the page parameter.

For detailed information about shipments, API response structures, pagination, and available shipment data, see the ShipStation API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

ShipStation data sources can also be manually configured to ingest data from any valid ShipStation API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

ShipStation API endpoint URLs are rooted at https://ssapi.shipstation.com/ (e.g., https://ssapi.shipstation.com/orders, https://ssapi.shipstation.com/fulfillments). For the Response Data Path, use $.orders[*] to extract items from the orders array, $.fulfillments[*] for fulfillments, $.shipments[*] for shipments, or $[*] for a plain response array, depending on your endpoint. Most endpoints use incrementing page-based pagination with page and pageSize parameters.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new ShipStation data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the ShipStation destination, and select the Send to Destination option from the menu. Select the ShipStation connector from the list of available destination connectors, then select the credential that will be used to connect to your ShipStation account, and click Next; or, create a new ShipStation credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common ShipStation endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create or Update Orders

This endpoint template allows you to create or update multiple orders in your ShipStation account using records from a Nexset. If the orderKey is specified in an order, the existing order with that key will be updated. This call does not currently support partial updates; the entire resource must be provided in the body of the request.

• This endpoint sends data as JSON in the request body to create or update orders in your ShipStation account. Records from your Nexset will be sent in batch mode to efficiently create or update multiple orders. The request body should contain the order data in the format required by the ShipStation API.

This endpoint sends data as JSON in the request body to create or update multiple orders in your ShipStation account. Records from your Nexset will be sent in batch mode to efficiently create or update multiple orders. The request body should contain the order data in the format required by the ShipStation API, including order details, customer information, and other order properties.

If the orderKey is specified in an order, the existing order with that key will be updated. This call does not currently support partial updates; the entire resource must be provided in the body of the request. The order structure must match the ShipStation API's expected format.

For detailed information about order creation and updates, request body formats, batch mode, and available order properties, see the ShipStation API documentation.

Manual configuration

ShipStation destinations can also be manually configured to send data to any valid ShipStation API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

ShipStation API typically uses the POST method and expects JSON format for all requests. The destination endpoint URL is rooted at https://ssapi.shipstation.com/ (e.g., https://ssapi.shipstation.com/orders/createorders/). The request body is typically {message.json} to send the entire Nexset data as JSON, or you can construct a custom JSON structure with specific field mappings.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured ShipStation endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the ShipStation endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.