Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a ShipStation source in Nexla.
shipstation_api.png

ShipStation

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the ShipStation connector tile from the list of available 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.

  3. In Nexla, ShipStation data sources can be created using pre-built endpoint templates, which expedite source setup for common ShipStation endpoints. Each template is designed specifically for the corresponding ShipStation endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    ShipStation sources can also be configured manually, allowing you to ingest data from ShipStation endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common ShipStation endpoints. Each template is designed specifically for the corresponding ShipStation endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • 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. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    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.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

ShipStation data sources can be manually configured to ingest data from any valid ShipStation API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex ShipStation sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or filters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the ShipStation API from the Method pulldown menu. ShipStation API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the ShipStation API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL to your ShipStation endpoint (e.g., https://ssapi.shipstation.com/orders, https://ssapi.shipstation.com/fulfillments). Include any required query parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The ShipStation API endpoint URL should include the API path (/ssapi.shipstation.com/) and the resource type path. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For ShipStation API responses, use $.orders[*] to extract all items from the orders array, $.fulfillments[*] to extract all items from the fulfillments array, $.shipments[*] to extract all items from the shipments array, or $[*] to extract all items from the response array, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your ShipStation API response. ShipStation API responses may have different structures depending on the endpoint. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Pagination (if applicable)​

  1. If your endpoint supports pagination, configure the pagination settings in the Pagination section. ShipStation API uses incrementing page-based pagination with page and pageSize parameters for most endpoints. Select the pagination type that matches your endpoint's pagination mechanism.

  2. Configure the pagination parameters based on your selected pagination type. For incrementing page-based pagination, specify the page parameter name (page), page size parameter name (pageSize), and starting page number.

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.