Skip to main content

Import from APIs

Import product feed data from APIs in Productsup.

An Application Programming Interface (API) is a method for transporting data by sending responses and receiving requests. It lets two systems talk directly with each other and, in this case, send product data.

Importing data via API is a popular choice for product data. It typically allows for dynamic and quick data handling.

Productsup has several API connections directly to external systems. See Import data from third-party external systems.

Productsup offers Stream API as a high-performance product upload or content API.

Import data via the Productsup Platform API

Note

Productsup plans to eventually sunset the Platform API's product data write endpoints. You can use the Platform API for organization management and Stream API for content or product data uploads for new integrations. For now, Productsup supports the Platform API endpoint for existing integrations.

To import data via the outgoing Productsup Platform API:

  1. Go to Data Sources from your site's main menu and select ADD DATA SOURCE.

  2. Select Add for the Productsup Platform API data source.

    platform_api.png

  3. (Optional) Give your data source a custom name. This custom name replaces the name of the data source on the Data Sources Overview page. Then, select Continue.

  4. Enter one (1) of the following settings in Product Update Mode:

    • replace - Uploads an entire file of all product information during each run.

    • update - Only uploads fields where you modified data, known as a delta update.

  5. (Optional) In Import process report email address, enter an email address to receive a report for each import run.

    • Receive an email with the batch ID logs you imported.

  6. Select Save.

    api.png

See the Productsup Introduction into our APIs website to explore this topic more deeply.

Import data via the Productsup Stream API

To import data via the Productsup Stream API:

  1. Go to Data Sources from your site's main menu and select ADD DATA SOURCE.

  2. Select Add for the Productsup Stream API data source.

    add_stream_api_data_source.png

  3. (Optional) Give your data source a custom name. This custom name replaces the name of the data source on the Data Sources Overview page. Then, select Continue.

  4. In Stream, choose the Stream ID you want to import data from in the drop-down list.

  5. Select Save.

    stream_api.png

Import from a SOAP service with Basic SOAP Request

To import XML data from a SOAP Service:

  1. Go to Data Sources from your site's main menu and select ADD DATA SOURCE.

  2. Select Add for the Basic SOAP Request data source.

    add_basic_soap_request_data_source.png

  3. (Optional) Give your data source a custom name. This custom name replaces the name of the data source on the Data Sources Overview page. Then, select Continue.

  4. Add your data URL in WSDL URL.

  5. In XML root node, define your file's root node.

  6. Add your endpoint in SOAP Endpoint.

  7. (Optional) Request Parameters imports the products you specified in the parameters only.

  8. (Optional) Select authentication in the Auth Type drop-down list. You can select None or Basic authentication. Next, add your credentials in Auth User and Auth Pass.

  9. Select Save.

    soap.png

Import paginated with Basic API Request with JSON Response

This data source is specifically for APIs that return a JSON response and authenticate with a token. To import paginated product data in a JSON format through a basic REST API:

  1. Go to Data Sources from your site's main menu and select ADD DATA SOURCE.

  2. Select Add for the Basic API Request with JSON Response data source.

    add_basic_api_request_w_json_response_data_source.png

  3. (Optional) Give your data source a custom name. This custom name replaces the name of the data source on the Data Sources Overview page. Then, select Continue.

  4. Add your data URL in Source.

  5. (Optional) If the URL contains any parameters, not the page parameter, add them in Parameter (optional).

  6. (Optional) If you require authentication, add your credentials in Username (optional) and Password (optional).

  7. (Optional) Occasionally, a JSON file may contain a root node, which defines the key that your product data falls under. Add that node in Root Node (optional). See Import JSON files - advanced settings for more information.

  8. (Optional) Enter the product variants from the JSON file you want to import in Variant Node (optional).

  9. (Optional) Enter the variable that defines the page in Page Variable.

    • For example, the page variable would be page located in www.myonlineshop.com/export.json?page=1.

  10. Establish the first page in Start Page (optional, default: 1), and set the page interval in Next Page Interval (optional).

    • This is necessary if the pages do not increase by one (1) each time, for example, if not page=1, page=2,...

  11. Switch Bundle Elements to On if you want to activate bundle elements, and add a delimiter in Bundle Delimeter. See Import JSON files - advanced settings for more information.

  12. In Notifications, set a notification to inform you how many products you imported. You can specify the notification interval.

  13. In Concurrency (how many requests at once), define how many requests occur simultaneously.

  14. Select Save.

    basic_api_old.png

Import paginated with Basic API Request with JSON Response (Cursors)

This data source is specifically for APIs that return a JSON response, authenticate with a token, and use cursors to page larger result sets. If you need to use cursors instead of pagination:

  1. Go to Data Sources from your site's main menu and select ADD DATA SOURCE.

  2. Select Add for the Basic API Request with JSON Response (Cursors) data source.

    add_basic_api_request_w_json_response_cursors_data_source.png

  3. (Optional) Give your data source a custom name. This custom name replaces the name of the data source on the Data Sources Overview page. Then, select Continue.

  4. Add your data URL in Source.

  5. (Optional) If the URL contains any parameters, not the page parameter, add them in Parameter (optional).

  6. (Optional) If you require authentication, add your credentials in Username (optional) and Password (optional).

  7. (Optional) Occasionally, a JSON file may contain a root node, which defines the key that your product data falls under. Add that node in Root Node (optional). See Import JSON files - advanced settings for more information.

  8. (Optional) Enter the product variants from the JSON file you want to import in Variant Node (optional).

  9. Switch Bundle Elements to On if you want to activate bundle elements, and add a delimiter in Bundle Delimeter. See Import JSON files - advanced settings for more information.

  10. In Notifications, set a notification to inform you how many products you imported. You can specify the notification interval.

  11. In Cursor Location, choose None or Header regarding the cursor from the drop-down list. If you've selected Header, enter the appropriate information in Cursor Response Header and the Cursor Request Header.

  12. Define the columns you want to exclude in Excluded Columns. For example, column_1,column_value*,column_*_name.

  13. Select Save.

    basic_api_request_w_json_response_cursors.png
In this section: