Skip to main content

Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to a ShipStation location.
shipstation_api.png

ShipStation

Create a ShipStation Destination​

  1. Click the + icon on the Nexset that will be sent to the ShipStation destination, and select the Send to Destination option from the menu.

  2. 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.

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

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

Configure Using a Template​

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

  • To configure this destination using a template, 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.

Configure Manually​

ShipStation destinations can be manually configured to send data to 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.

Using manual configuration, you can also configure Nexla to automatically send the response received from the ShipStation API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, 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 POST method for creating resources.

Data Format​

  1. Select the format in which the Nexset data will be sent to the ShipStation API from the Content Format pulldown menu. ShipStation API expects JSON format for all requests.

API Endpoint URL​

  1. Enter the URL of the ShipStation API endpoint to which data will be sent in the URL field. This should be the complete URL to your ShipStation endpoint (e.g., https://ssapi.shipstation.com/orders/createorders/). 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 point to the endpoint where you want to create or update orders. The 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.

Request Body​

  1. Configure the request body that will be sent to the ShipStation API. The request body should contain the resource data formatted as JSON, with field names matching the ShipStation API's expected structure. The request body format is typically {message.json} to send the entire Nexset data as JSON, or you can construct a custom JSON structure with specific field mappings.

The request body must be valid JSON and must match the ShipStation API's expected format for the specific endpoint you're using. ShipStation API uses specific structures for different endpoints (orders, fulfillments, etc.). For detailed information about request body formats, available endpoints, and resource structures, see the ShipStation API documentation.

Save the Destination​

  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 destination configuration for later use.