Skip to main content

Manhattan Data Source

The Manhattan connector enables you to access Manhattan Active API endpoints to retrieve orders, shipments, and other supply chain data. This connector is particularly useful for applications that need to extract order data, track shipments, integrate supply chain data with other systems, or build logistics analytics and reporting solutions. Follow the instructions below to create a new data flow that ingests data from a Manhattan source in Nexla.
manhattan_api.png

Manhattan

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 Manhattan connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Manhattan Active API, and click Next; or, create a new Manhattan credential for use in this flow.

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

    Manhattan sources can also be configured manually, allowing you to ingest data from Manhattan Active API 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 Manhattan Active API endpoints. Each template is designed specifically for the corresponding Manhattan Active API 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.

    Fetch All Orders

    This endpoint retrieves all orders from your Manhattan Active system. Use this endpoint when you need to extract order data, analyze order patterns, or integrate order information with other systems.

    • This endpoint automatically retrieves all orders accessible to your Manhattan Active account. The endpoint uses pagination with nextToken to handle large datasets efficiently, automatically fetching additional pages as needed.

    This endpoint uses GET requests with pagination through nextToken. The endpoint automatically fetches additional pages using the nextToken from the response pagination metadata. For more information about the Fetch All Orders endpoint, refer to the Manhattan Active API documentation.

    Fetch All Shipments

    This endpoint retrieves all shipments from your Manhattan Active system. Use this endpoint when you need to extract shipment data, track shipments, or integrate shipment information with other systems.

    • This endpoint automatically retrieves all shipments accessible to your Manhattan Active account. The endpoint uses pagination with nextToken to handle large datasets efficiently, automatically fetching additional pages as needed.

    This endpoint uses GET requests with pagination through nextToken. The endpoint automatically fetches additional pages using the nextToken from the response. For more information about the Fetch All Shipments endpoint, refer to the Manhattan Active 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​

Manhattan data sources can be manually configured to ingest data from any valid Manhattan Active 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 Manhattan sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

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 Manhattan Active API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API (most Manhattan Active endpoints use GET)

API Endpoint URL​

  1. Enter the URL of the Manhattan Active API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Manhattan Active API endpoints typically follow the pattern {api_url}/api/v3/{resource}, where {api_url} is your Manhattan Active API URL configured in the credential.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint URL should use the Manhattan Active API URL configured in your credential.

Path to Data​

Optional

If only a subset of the data that will be returned by API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, when a request call is used to fetch orders, the API will typically return order data along with pagination metadata. By entering the path to the relevant data, you can configure Nexla to extract the specific orders you need.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records. For Manhattan Active API responses, common paths include $.orders[*] for arrays of orders or $.shipments[*] for arrays of shipments.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.orders to access the orders array).
    Path to Data Example:

    If the API response is in JSON format and includes an orders array that contains the order data, the path to the response would be entered as $.orders[*].

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.

    You do not need to include any headers already present in the credentials. Common headers like Authorization, Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration. For Manhattan Active, the Authorization header with Bearer token is automatically included from your credential.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. 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.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Manhattan 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.