Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from an AWS Selling Partner API source in Nexla.
aws_sp_api_rest.png

AWS Selling Partner API

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

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

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

    Get Orders Created in Time Range

    This endpoint retrieves orders created during a specified time range from your Amazon Seller Central account. Use this endpoint when you need to access order data for analysis, fulfillment, or reporting purposes.

    • Enter the start date and time for the order retrieval in the Created After field. This should be an ISO 8601 formatted date (e.g., 2024-01-01T00:00:00Z) indicating the earliest order creation time to include. You can use Nexla macros like {now} for the current time or {now-1} for one time unit before the current time.
    • Enter the marketplace IDs for the marketplaces from which you want to retrieve orders in the Marketplace IDs field. Marketplace IDs are comma-separated values (e.g., ATVPDKIKX0DER for US marketplace). You can find marketplace IDs in the AWS SP-API documentation for your region.
    • The endpoint uses GET requests to the SP-API Orders endpoint ({sp_api_url}/orders/v0/orders) with query parameters for CreatedAfter and MarketplaceIds. The endpoint URL is automatically constructed based on your credential's SP-API endpoint configuration.
    • The endpoint uses token-based pagination when applicable, automatically fetching additional pages as needed using the NextToken mechanism. When a response includes a NextToken field in the payload object, Nexla automatically includes it in the subsequent request to fetch the next page of results.
    • The endpoint will return all orders created after the specified time within the selected marketplaces. The response data is extracted from the payload.Orders array in the API response ($.payload.Orders[*]), with each order record processed individually.

    This endpoint requires properly formatted ISO 8601 dates for the Created After parameter. The endpoint uses token-based pagination (iteration.type: paging.next.token) through the NextToken mechanism, where the token is located at $.payload.NextToken in the response. The endpoint requires OAuth 2.0 authentication with AWS Signature Version 4, which is handled automatically by your credential configuration. The x-amz-access-token header is automatically included in requests using the OAuth access token from your credential. For detailed information about the Orders API, including available query parameters, response formats, and marketplace IDs, see the AWS SP-API Orders API documentation.

    Get Inventory Summaries

    This endpoint retrieves a list of inventory summaries that have had changes after a specified date and time from your Amazon FBA (Fulfillment by Amazon) inventory. Use this endpoint when you need to access inventory data for stock management, reporting, or synchronization purposes.

    • Enter the start date and time for the inventory retrieval in the Start Time field. This should be an ISO 8601 formatted date (e.g., 2024-01-01T00:00:00Z) indicating the earliest inventory change time to include. You can use Nexla macros like {now} for the current time or {now-1} for one time unit before the current time.
    • Select the granularity type for the inventory summaries from the Granularity Type dropdown menu. Available options include Marketplace for marketplace-level summaries or Warehouse for warehouse-level summaries.
    • Enter the granularity ID in the Granularity ID field. This should match the granularity type selected (e.g., a marketplace ID for marketplace granularity or a warehouse ID for warehouse granularity).
    • Enter the marketplace IDs for the marketplaces from which you want to retrieve inventory in the Marketplace IDs field. Marketplace IDs are comma-separated values (e.g., ATVPDKIKX0DER for US marketplace).
    • The endpoint uses GET requests to the SP-API FBA Inventory endpoint ({sp_api_url}/fba/inventory/v1/summaries) with query parameters for startDateTime, granularityType, granularityId, and marketplaceIds. The endpoint URL is automatically constructed based on your credential's SP-API endpoint configuration.
    • The endpoint uses token-based pagination when applicable, automatically fetching additional pages as needed using the nextToken mechanism. When a response includes a nextToken field in the pagination object, Nexla automatically includes it in the subsequent request to fetch the next page of results.
    • The endpoint will return all inventory summaries that have changed after the specified time within the selected marketplaces. The response data is extracted from the payload.inventorySummaries array in the API response ($.payload.inventorySummaries[*]), with each inventory summary processed individually.

    This endpoint requires properly formatted ISO 8601 dates for the Start Time parameter. The endpoint uses token-based pagination (iteration.type: paging.next.token) through the nextToken mechanism, where the token is located at $.pagination.nextToken in the response. The endpoint requires OAuth 2.0 authentication with AWS Signature Version 4, which is handled automatically by your credential configuration. The x-amz-access-token header is automatically included in requests using the OAuth access token from your credential. For detailed information about the FBA Inventory API, including available query parameters, response formats, and granularity options, see the AWS SP-API FBA Inventory API documentation.

    Request and Retrieve a Report

    This endpoint requests a report from Amazon Seller Central and retrieves the report data once it's ready. Use this endpoint when you need to access Amazon reports for analytics, business intelligence, or data synchronization purposes.

    • Select the report type you want to request from the Report Type dropdown menu. Available report types include various order, inventory, settlement, and performance reports. The report type determines what data will be included in the report.
    • Enter the start date and time for the report data in the Created After field. This should be an ISO 8601 formatted date (e.g., 2024-01-01T00:00:00Z) indicating the earliest data to include in the report. You can use Nexla macros like {now} for the current time or {now-1} for one time unit before the current time.
    • Enter the marketplace IDs for the marketplaces from which you want to retrieve report data in the Marketplace IDs field. Marketplace IDs are comma-separated values (e.g., ATVPDKIKX0DER for US marketplace).
    • Select the file format for the report from the File Format dropdown menu. Available formats include JSON, CSV, TAB, and XLSX, depending on the report type.
    • The endpoint uses a multi-step process to request and retrieve reports: First, it sends a POST request to create a report request ({sp_api_url}/reports/2021-06-30/reports). Then, it polls the report status using GET requests until the report is ready. Once ready, it retrieves the report document URL and downloads the report file.
    • The endpoint automatically handles the asynchronous report generation process, polling the report status until it's complete (status: DONE). The polling interval and timeout are configured automatically by Nexla.
    • The endpoint will return the report data in the selected format. The response data path depends on the file format: JSON reports are parsed and extracted, while CSV, TAB, and XLSX reports are processed as structured data.

    This endpoint uses a multi-step asynchronous process to request and retrieve reports. The endpoint first creates a report request, then polls for completion, retrieves the document URL, and finally downloads the report file. The endpoint requires properly formatted ISO 8601 dates for the Created After parameter. The endpoint requires OAuth 2.0 authentication with AWS Signature Version 4, which is handled automatically by your credential configuration. The x-amz-access-token header is automatically included in requests using the OAuth access token from your credential. Report generation can take time depending on the report type and data volume. For detailed information about the Reports API, including available report types, request parameters, response formats, and file formats, see the AWS SP-API Reports 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​

AWS Selling Partner API data sources can be manually configured to ingest data from any valid AWS Selling Partner 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 AWS Selling Partner API 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 AWS Selling Partner API from the Method pulldown menu. The AWS Selling Partner API primarily uses GET and POST requests. The most common methods are:

    • GET: For retrieving data from the API (most common for SP-API)
    • POST: For creating resources or triggering actions (e.g., report requests)
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the AWS Selling Partner 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. AWS Selling Partner API endpoints follow the pattern {sp_api_url}/{api_path} where {sp_api_url} is your SP-API endpoint (e.g., https://sellingpartnerapi-na.amazon.com) and {api_path} is the specific API path (e.g., /orders/v0/orders).

Ensure the API endpoint URL is correct and accessible with your current credentials. The SP-API endpoint URL is automatically constructed based on your credential's SP-API endpoint configuration. You can test the endpoint using the Test button after configuring the URL. AWS Selling Partner API endpoints require OAuth 2.0 authentication with AWS Signature Version 4, and the x-amz-access-token header must be included in all requests. For detailed information about AWS Selling Partner API endpoints and available APIs, see the AWS SP-API documentation.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Macros are particularly useful for APIs that require date ranges, pagination parameters, or other dynamic values that change between data ingestion runs.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}. For AWS SP-API, ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss'Z') is commonly used.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when you need to create API endpoints that reference specific IDs, values, or parameters from other data sources in your Nexla environment.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

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 a list of items, the API will typically return an array of records, along with metadata, in the response. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

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.

  • 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., $.payload.Orders[*] to access an array of orders within a response object).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

    Path to Data Example:

    If the API response is in JSON format and includes a top-level object with a payload object containing an array named Orders that contains the relevant data, the path to the response would be entered as $.payload.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.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, when a request call is used to fetch a list of items, the API response will typically include an array of records along with metadata such as total count, pagination information, or request timestamps. In this case, if you have specified the path to the relevant data but metadata of interest is located in a different part of the response, you can specify a path to this metadata to include it with each record in the generated Nexset(s).

Metadata paths are particularly useful for preserving API response context like request IDs, timestamps, or summary statistics that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

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. AWS Selling Partner API requests require OAuth 2.0 authentication with AWS Signature Version 4, and the x-amz-access-token header is automatically included in requests using the OAuth access token from your credential. The AWS Signature Version 4 signing process is handled automatically by your credential configuration.

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 AWS Selling Partner API 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.