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 ShipBob location.
shipbob_api.png

ShipBob

Create a ShipBob Destination​

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

  2. Select the ShipBob connector from the list of available destination connectors. Then, select the credential that will be used to connect to your ShipBob account, and click Next; or, create a new ShipBob credential for use in this flow.

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

    ShipBob destinations can also be configured manually, allowing you to send data to ShipBob 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 ShipBob endpoints. Each template is designed specifically for the corresponding ShipBob 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.

    Add Products to Store

    This endpoint template allows you to add multiple products to your ShipBob store using records from a Nexset. Use this template when you need to create or update products in bulk in your ShipBob account.

    • This endpoint sends data as JSON in the request body to add products to your ShipBob store. Records from your Nexset will be sent in batch mode to efficiently add multiple products. The request body should contain the product data in the format required by the ShipBob API.

    This endpoint sends data as JSON in the request body to add multiple products to your ShipBob store. Records from your Nexset will be sent in batch mode to efficiently add multiple products. The request body should contain the product data in the format required by the ShipBob API, including product names, SKUs, and other product properties.

    The product structure must match the ShipBob API's expected format. For detailed information about product creation, request body formats, batch mode, and available product properties, see the ShipBob API documentation.

Configure Manually​

ShipBob destinations can be manually configured to send data to any valid ShipBob 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 ShipBob 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 ShipBob API from the Method pulldown menu. ShipBob API typically uses POST method for creating resources.

Data Format​

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

API Endpoint URL​

  1. Enter the URL of the ShipBob API endpoint to which data will be sent in the URL field. This should be the complete URL to your ShipBob endpoint (e.g., https://api.shipbob.com/1.0/product/batch/). Include any required query parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The ShipBob API endpoint URL should point to the endpoint where you want to create or update resources. The endpoint URL should include the API version (/1.0/) 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 ShipBob API. The request body should contain the resource data formatted as JSON, with field names matching the ShipBob 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 ShipBob API's expected format for the specific endpoint you're using. ShipBob API uses specific structures for different endpoints (products, orders, etc.). For detailed information about request body formats, available endpoints, and resource structures, see the ShipBob 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.