UiPath Documentation
industry-department-solutions
latest
false
Supply Chain & Retail Solutions user guide

Merchants dataset

Merchants dataset containing merchant entity information used in the Commercial Pricing solution for pricing analysis at merchant and segment levels.

The Merchants dataset contains key information about merchants used in the commercial pricing solution. It defines merchant entities associated with pricing activities and supports pricing analysis at merchant and segment levels.

This dataset is required for application deployment and pricing insights analysis.

→ For the canonical technical schema (data types, validation rules, request/response examples), see Merchant in the API Guide.

Purpose

The commercial pricing solution uses the Merchants dataset to:

  • Identify merchants associated with quotes and sales transactions
  • Support merchant-level pricing segmentation and analysis
  • Enable pricing differentiation across merchant categories and subcategories

This dataset is especially important when pricing strategies vary across merchant types.

Required fields

About the Nullable column: every field below must appear in your data. Nullable: Yes means the field can be sent as null (or left blank in your source) when no value is available; Nullable: No means a non-null value is required for every row.

FieldDescriptionTypeNullable
merchant_idUnique identifier for each merchant.stringNo
merchant_nameMerchant name.stringNo
merchant_categoryMerchant category.stringYes
merchant_subcategoryMerchant sub-category.stringYes
updated_atTimestamp when the record was updated.timestamp_tzNo

Custom fields

The fields listed previously are the standard schema for this dataset. A field that your business requires but the standard schema does not include can be added as a custom attribute after the schema is rolled out. Custom attributes are additive, so they extend the dataset without affecting existing fields, and they are validated in the same way as standard fields.

The following request adds a MERCHANT_CHANNEL column to this dataset:

curl -X POST \
  'https://ingestion.peak.ai/api/v2/schema/QP_MERCHANT_OOTB/add-attribute' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "QP_OOTB",
    "columnName": "MERCHANT_CHANNEL",
    "dataType": "string",
    "validations": [
      { "type": "optional" }
    ]
  }'
curl -X POST \
  'https://ingestion.peak.ai/api/v2/schema/QP_MERCHANT_OOTB/add-attribute' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "QP_OOTB",
    "columnName": "MERCHANT_CHANNEL",
    "dataType": "string",
    "validations": [
      { "type": "optional" }
    ]
  }'

The table name in the request URL is this dataset's fully qualified warehouse name, which includes the prefix and suffix configured when your solution was rolled out — QP_MERCHANT_OOTB in this example. Retrieve the name for your own solution with Describe a solution's schema.

On standard tables the API prefixes the new column name in the warehouse with C_ (Snowflake) or c_ (Redshift), so MERCHANT_CHANNEL becomes C_MERCHANT_CHANNEL and warehouse queries must use the prefixed name.

→ For the full parameter reference, supported data types, and validation rules, see Customizations in the API Guide.

Usage notes

  • Every merchant referenced in the Quote Line or Sales datasets must exist in the Merchants dataset.
  • Merchant identifiers must be consistent across all related datasets.
  • Accurate categorization improves segmentation-based pricing strategies.
  • The updated_at field ensures synchronization integrity during incremental data feeds.

Why this dataset matters

The Merchants dataset enables the pricing solution to segment and analyze pricing behavior by merchant. Without this dataset, the application cannot reliably apply merchant-level pricing strategies or generate accurate merchant-specific insights.

  • Purpose
  • Required fields
  • Custom fields
  • Usage notes
  • Why this dataset matters

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated