ShipBob

ShipBob is a third-party logistics (3PL) provider that offers e-commerce fulfillment services, including inventory management, order processing, and shipping solutions to help businesses scale their operations efficiently.

Power end-to-end data operations for your ShipBob API with Nexla. Our bi-directional ShipBob connector is purpose-built for ShipBob, 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 ShipBob or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your ShipBob 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 ShipBob credential, you need to obtain your Personal Access Token (PAT) from your ShipBob account. ShipBob uses Personal Access Token authentication for all API requests, with the token sent in the Authorization header with the Bearer prefix.

To obtain your ShipBob Personal Access Token, follow these steps:

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

2. Navigate to your account settings or API management section in the ShipBob interface.

3. Look for the API or Personal Access Tokens section in your account settings, or navigate to Settings > API or Account > API.

4. If you don't have a Personal Access Token yet, look for the option to generate or create your Personal Access Token.

5. Click Create Personal Access Token or Generate PAT to create a new Personal Access Token.

6. Configure your Personal Access Token settings:

   • Enter a name for the token (e.g., "Nexla Integration")
   • Review and select the permissions or scopes for the token (if applicable)

7. Click Create or Generate to create the Personal Access Token.

8. Copy the Personal Access Token immediately after it's generated, as it may not be accessible again after you navigate away from the page.

9. Store the Personal Access Token securely, as you will need it to configure your Nexla credential. The Personal Access Token is sensitive information and should be kept confidential.

The Personal Access Token is sent in the Authorization: Bearer {token} header for all API requests to the ShipBob API. The token authenticates your requests and grants access to ShipBob resources based on your account permissions. If your Personal Access Token is compromised, you should immediately revoke it in your ShipBob account settings and generate a new one. For detailed information about obtaining Personal Access Tokens, API authentication, and available endpoints, refer to the ShipBob API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
ShipBob Personal Access Token (PAT)	Yes	Yes	Check out the documentation URL for creating and managing your ShipBob PATs.

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 – ShipBob 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 ShipBob Personal Access Token (PAT) in the ShipBob Personal Access Token (PAT) field. This is the Personal Access Token you obtained from your ShipBob account settings (Settings > API or Account > API). The Personal Access Token is sent in the Authorization: Bearer {token} header for all API requests to the ShipBob API and must be kept confidential.

   Your ShipBob Personal Access Token can be found in your ShipBob account settings under Settings > API or Account > API. The Personal Access Token is sent in the Authorization: Bearer {token} header for all API requests to the ShipBob API.

   If your Personal Access Token is compromised, you should immediately revoke it in your ShipBob account settings and generate a new one. The Personal Access Token provides access to your ShipBob account data and should be treated as sensitive information. Keep your Personal Access Token secure and do not share it publicly.

   For detailed information about creating and managing Personal Access Tokens, API authentication, and available endpoints, see the ShipBob API documentation.

4. 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 ShipBob connector tile, 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.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common ShipBob 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 Inventory Items

This endpoint template retrieves a list of inventory items from your ShipBob account. Use this template when you need to retrieve information about inventory items, including item IDs, SKUs, quantities, and other inventory metadata.

• This endpoint automatically retrieves all inventory items from your ShipBob account. The endpoint uses incrementing page-based pagination to handle large datasets efficiently.

This endpoint returns a list of inventory items from your ShipBob account, including item IDs, SKUs, quantities, and other inventory metadata. The endpoint uses incrementing page-based pagination with Page parameter to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the page parameter.

For detailed information about inventory items, API response structures, pagination, and available inventory data, see the ShipBob API documentation.

Get Products

This endpoint template retrieves a list of products from your ShipBob account. Use this template when you need to retrieve information about products, including product IDs, names, SKUs, and other product metadata.

• This endpoint automatically retrieves all products from your ShipBob account. The endpoint uses incrementing page-based pagination to handle large datasets efficiently.

This endpoint returns a list of products from your ShipBob account, including product IDs, names, SKUs, and other product metadata. The endpoint uses incrementing page-based pagination with Page parameter to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the page parameter.

For detailed information about products, API response structures, pagination, and available product data, see the ShipBob API documentation.

Get Orders

This endpoint template retrieves a list of orders from your ShipBob 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 ShipBob account. The endpoint uses incrementing page-based pagination to handle large datasets efficiently.

This endpoint returns a list of orders from your ShipBob account, including order IDs, order numbers, statuses, and other order metadata. The endpoint uses incrementing page-based pagination with Page parameter 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 ShipBob 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

ShipBob data sources can also be manually configured to ingest data from any valid ShipBob 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.

ShipBob API typically uses the GET method for retrieving data. Endpoint URLs include the API version (/1.0/) and the resource type path (e.g., https://api.shipbob.com/1.0/inventory, https://api.shipbob.com/1.0/product). For the Response Data Path, use $[*] to extract all items from a response array, or $ to extract the entire response for single record endpoints. ShipBob uses incrementing page-based pagination with a Page parameter for most endpoints.

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 ShipBob 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 ShipBob destination, and select the Send to Destination option from the menu. 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.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common ShipBob 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.

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.

Manual configuration

ShipBob destinations can also be manually configured to send data to any valid ShipBob 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.

ShipBob API typically uses the POST method and expects JSON format for all requests. Endpoint URLs include the API version (/1.0/) and the resource type path (e.g., https://api.shipbob.com/1.0/product/batch/). The request body is typically {message.json} to send the entire Nexset data as JSON, or a custom JSON structure with specific field mappings. Nexla can also be configured to automatically send the API response received after each call to a new Nexla webhook data source.

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 ShipBob endpoint, open the destination resource menu, and select Activate.

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