Skip to main content

Upshop API Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to an Upshop API location.
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 instance, and click Next; or, create a new Upshop API credential for use in this flow.

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

    Upshop API destinations can also be configured manually, allowing you to send data to Upshop API endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Upshop API endpoints. Each template is designed specifically for the corresponding Upshop API endpoint, making destination setup easy and efficient.

Endpoint Settings​

  • Select the endpoint to which this destination will send 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 destination for this endpoint.

    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.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can send a sample of the data that will be sent according to the current settings. This allows users to verify that the destination 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 sent & the response will be displayed in the Endpoint Test Result panel on the right.

  • If the test is not successful or the response 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 response to ensure that the destination is configured correctly.

Configure Manually​

Upshop API destinations can be manually configured to send data to 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 destinations, such as destinations that send data to multiple endpoints or destinations that require custom authentication headers or request parameters.

API Method​

  1. To manually configure this destination, 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:

    • POST: For creating or updating resources (most Upshop ingestion endpoints use POST)

API Endpoint URL​

  1. Enter the URL of the Upshop API endpoint to which this destination will send 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.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, 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, and Content-Type is typically set to application/json for ingestion endpoints.

Request Body Template​

Optional

  • If the API endpoint requires a specific request body format, you can customize how Nexla formats the data before sending it to the Upshop API by entering a request body template in the Request Body Template field. The template should use {message.json} to include the entire record as JSON, or you can specify individual fields using dot notation (e.g., {message.field_name}).

    For most Upshop ingestion endpoints, the default request body template {message.json} will work correctly, sending the entire record as JSON. You may need to customize the template if the API requires a specific structure or if you need to transform the data before sending. Upshop endpoints typically require specific JSON structures depending on the resource being created or updated.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can send a sample of the data that will be sent according to the current configuration. This allows users to verify that the destination 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 sent & the response will be displayed in the Endpoint Test Result panel on the right.

  • If the test is not successful or the response 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 response to ensure that the destination is configured correctly.

Save & Activate the Destination​

  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 destination. Nexla will now begin sending data to the configured endpoint according to your data flow schedule.