Skip to main content

Upshop API Data Source

The Upshop API connector enables you to access Upshop API endpoints to retrieve and manage retail data including product hierarchies, items, departments, forecasting data, and pricing information. This connector is particularly useful for applications that need to extract retail data, integrate product information with other systems, build analytics and reporting solutions, or automate retail operations workflows. Follow the instructions below to create a new data flow that ingests data from an Upshop API source in Nexla.
upshop_api.png

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

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

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

    This endpoint retrieves a list of all departments. Use this endpoint when you need to extract department information, analyze organizational structure, or integrate department data with other systems.

    • This endpoint uses POST requests to retrieve department data. No additional configuration is required beyond selecting this endpoint template.

    The Get List of Departments endpoint uses POST requests to retrieve department information from the Upshop API. The endpoint returns a list of all departments in your organization. For more information about the Get List of Departments endpoint, refer to the Upshop 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​

Upshop API data sources can be manually configured to ingest data from any valid Upshop 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 Upshop 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 Upshop API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API
    • POST: For querying data or executing operations (many Upshop endpoints use POST)

API Endpoint URL​

  1. Enter the URL of the Upshop 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. Upshop API endpoints typically follow the pattern {base_url}/{resource_path}, where {base_url} is typically https://api.upshop.com.

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 base URL configured in your credential. Upshop API requires both Ocp-Apim-Subscription-Key and X-Tenant headers, which are automatically included from 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.

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 Upshop API responses, common paths include $ for the entire response or $.data[*] for arrays within data objects.

  • 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., $.data to access the data object).

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 Ocp-Apim-Subscription-Key, X-Tenant, Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration. For Upshop, the Ocp-Apim-Subscription-Key and X-Tenant headers are 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 Upshop 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.