Upshop API

Upshop is a retail technology platform that provides solutions for product hierarchy management, item master data, forecasting, and pricing. 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.

Power end-to-end data operations for your Upshop API API with Nexla. Our bi-directional Upshop API connector is purpose-built for Upshop API, 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 Upshop API or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Upshop API 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 an Upshop API credential, you'll need to obtain an API subscription key and tenant ID from your Upshop account. Upshop uses Azure API Management authentication, requiring both an Ocp-Apim-Subscription-Key header and an X-Tenant header for API access.

To obtain Upshop API credentials:

1. Log in to your Upshop account or contact your Upshop administrator to access the Upshop API portal.

2. Navigate to the API settings or developer portal. This is typically accessible from your Upshop account dashboard or through the Upshop developer portal.

3. In the API settings, locate the API Subscription Key (Ocp-Apim-Subscription-Key). This is the Azure API Management subscription key used to authenticate API requests.

4. Copy the Ocp-Apim-Subscription-Key. Store it securely, as you'll need it to authenticate API requests.

5. Locate your X-Tenant ID. This is the organization or store identifier for multi-tenant API operations. The tenant ID identifies your specific organization or store within the Upshop platform.

6. Copy the X-Tenant ID. Store it securely, as you'll need it for all API requests.

7. Note your Base URL. The default base URL for Upshop API is https://api.upshop.com, but this may vary depending on your Upshop deployment or region.

Upshop API requires dual authentication: Ocp-Apim-Subscription-Key header + X-Tenant header. Both are mandatory for all API requests. The Ocp-Apim-Subscription-Key is used for Azure API Management authentication, and the X-Tenant header identifies your organization or store. If you're unsure about your API credentials, contact your Upshop administrator or Upshop support.

For detailed information about Upshop API authentication and credential management, refer to the Upshop API Documentation and Upshop Developer Documentation.

Authenticate

Credentials required

Authentication using Ocp-Apim-Subscription-Key and X-Tenant headers.

Field	Required	Secret	Description
Base URL	Yes	No	Root URL for API endpoints. Default: https://api.upshop.com
Ocp-Apim-Subscription-Key	Yes	Yes	API authentication key for Azure API Management.
X-Tenant ID	Yes	No	Organization or store identifier for multi-tenant API operations.

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 – Upshop API

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. In the Base URL field, enter the root URL for API endpoints. The default value is https://api.upshop.com. You can specify a different base URL if your organization uses a custom endpoint.

4. In the Ocp-Apim-Subscription-Key field, enter the API subscription key that you obtained from your Upshop account. This is the Azure API Management subscription key used to authenticate API requests.

5. In the X-Tenant ID field, enter your organization or store identifier. This is the tenant ID that identifies your specific organization or store within the Upshop platform for multi-tenant API operations.

   The Ocp-Apim-Subscription-Key and X-Tenant ID are sensitive information and should be kept secure. Both are required for all Upshop API requests. The Ocp-Apim-Subscription-Key is sent as a header, and the X-Tenant ID is also sent as a header to identify your organization or store.

6. Click the Save button at the bottom of the overlay to save the configured credential. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.

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 Upshop API connector tile, 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.

Endpoint templates

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

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

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

Upshop API endpoints typically follow the pattern {base_url}/{resource_path}, where {base_url} is https://api.upshop.com by default. For nested responses, set the Path to Data using JSON path notation—for example, $ for the entire response or $.data[*] for arrays within data objects. The Ocp-Apim-Subscription-Key and X-Tenant headers are automatically included from your credential, so you do not need to add them as additional request headers.

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 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.

Use as a destination

Click the + icon on the Nexset that will be sent to the Upshop API destination, and select the Send to Destination option from the menu. Select the Upshop API connector from the list of available destination connectors, then select the credential that will be used to connect to the Upshop instance, and click Next; or, create a new Upshop API 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 Upshop API 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.

Import Major Department

This endpoint imports major department data. Use this endpoint when you need to create or update major department information, sync department data, or import department hierarchies.

• This endpoint accepts JSON data in the request body. The data should include major department information. Each record will be sent as a separate API request.
• Ensure your data includes the required fields for Upshop major departments.

This endpoint uses POST method for importing major department data. The endpoint accepts JSON data in the request body and does not support batch mode. For more information about the Import Major Department endpoint, refer to the Upshop API Documentation.

Import Merchandising Hierarchy (async)

This endpoint imports merchandising hierarchy data asynchronously. Use this endpoint when you need to create or update merchandising hierarchies, sync product hierarchy data, or import large hierarchy datasets.

• This endpoint accepts JSON data in the request body and processes it asynchronously. The data should include merchandising hierarchy information.
• Ensure your data includes the required fields for Upshop merchandising hierarchies.

This endpoint uses POST method for importing merchandising hierarchy data asynchronously. The endpoint accepts JSON data in the request body and processes large datasets asynchronously. For more information about the Import Merchandising Hierarchy endpoint, refer to the Upshop API Documentation.

Add/Update/Delete Items (async)

This endpoint adds, updates, or deletes items asynchronously. Use this endpoint when you need to manage item master data, sync product information, or import large item datasets.

• This endpoint accepts JSON data in the request body and processes it asynchronously. The data should include item information with action indicators (add, update, delete).
• Ensure your data includes the required fields for Upshop items and appropriate action indicators.

This endpoint uses POST method for managing items asynchronously. The endpoint accepts JSON data in the request body and processes large datasets asynchronously. For more information about the Add/Update/Delete Items endpoint, refer to the Upshop API Documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to send a sample of the data. The response will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the destination is configured correctly before saving.

Manual configuration

Upshop API destinations can also be manually configured to send data to any valid Upshop API endpoint, including endpoints not covered by the pre-built templates or destinations that require custom authentication headers or 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, data format, endpoint URL, request headers, and request body template.

Upshop API endpoints typically follow the pattern {base_url}/{resource_path}, where {base_url} is https://api.upshop.com by default. The Ocp-Apim-Subscription-Key and X-Tenant headers are automatically included from your credential. For most Upshop ingestion endpoints, the default Request Body Template {message.json} sends the entire record as JSON and will work correctly; customize it if the endpoint requires a different structure. Content-Type is typically set to application/json for ingestion endpoints.

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

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