Introduction
Catalog Management
The Catalog Management Service acts as a centralized hub for organizing and maintaining the entities within our catalog. It facilitates the efficient management of products, services, and offerings, ensuring accuracy and accessibility across our organization. Key features include entity and attribute management, hierarchical structuring for intuitive navigation, and robust lifecycle and security management.
Promotion Management
Our Promotion Management Service provides a comprehensive platform for creating, managing, and monitoring promotional campaigns. It supports targeted marketing initiatives, sales strategies, customer loyalty programs, and seasonal promotions. With lifecycle management and seamless integration capabilities, it enables organizations to execute data-driven promotional activities effectively.
Price Point Management
The Price Point Management Service is a strategic tool designed for retail and e-commerce to optimize pricing strategies. It allows dynamic price adjustments, overwrites catalog prices based on specific conditions, and supports scenario-based pricing strategies. This service ensures businesses maintain competitive pricing while maximizing profitability.
GraphQL Queries
Within our Catalog Services, the GraphQL Queries section empowers users to retrieve specific catalog data efficiently and with flexibility. It enhances performance by optimizing data retrieval processes and allows customization tailored to specific user requirements.
What made this section unhelpful for you?
Catalog Management
Overview
The Catalog Management Service plays a pivotal role in managing and organizing the various entities within a catalog, facilitating efficient product and service offerings to customers. It serves as a centralized hub for maintaining, updating, and orchestrating the catalog's contents, ensuring accuracy, consistency, and accessibility across the organization's ecosystem.
Key Features
- Entity Management: The service is responsible for managing various entities such as products, services, offerings, and their associated attributes within the catalog. This includes creating, updating, and deleting catalog entries as necessary.
- Hierarchy Structuring: It organizes catalog entities into logical hierarchies, enabling easy navigation and comprehension of product/service relationships. This hierarchical structure aids in effective catalog browsing and search functionalities.
- Attribute Definition: Catalog Management Service defines and manages attributes associated with catalog entities. These attributes provide detailed information about products/services, such as pricing, specifications, availability, and more.
- Lifecycle Management: It oversees the lifecycle of catalog entities, ensuring they progress through stages like design, development, testing, and deployment seamlessly. This includes managing lifecycle statuses and transitions for each entity.
- Access Control and Security: Catalog Management Service enforces access control measures to regulate user permissions and restrict unauthorized access to sensitive catalog data. It also implements security protocols to safeguard against data breaches and malicious activities.
- Integration Support: It provides APIs and integration capabilities to seamlessly integrate with other systems and services within the organization's architecture. This allows for real-time synchronization of catalog data and interoperability with external applications.
Base URL
Production:
https://your-url.com/catalog-management/v4
https://your-url.com/promotion-management/v4
https://your-url.com/pricepoint-management/v4
Promotion Management
Overview
The Promotion Management Service serves as a crucial component in orchestrating promotional activities within an organization's ecosystem. It provides a centralized platform for creating, managing, and monitoring various promotions such as discounts, offers, and coupon management, ensuring efficient execution and analysis of promotional campaigns.
Key Features
Promotion Creation and Management: The service allows administrators to create, modify, and delete promotions, enabling them to tailor promotional activities to specific business objectives and target audiences.
Integration Support: Promotion Management Service integrates with other systems and services, enabling seamless execution of promotions across multiple channels and touchpoints. This ensures consistent messaging and customer experience throughout promotional campaigns.
Lifecycle Management: It oversees the lifecycle of promotions, managing status transitions from creation to expiration. This includes activating, deactivating, and archiving promotions based on predefined timelines.
Business Processes Supported
- Targeted Marketing Campaigns: Promotion Management Service supports targeted marketing initiatives by enabling the creation of promotions tailored to specific customer segments, demographics, or purchasing behaviors.
- Sales Boosting Strategies: It aids in boosting sales by offering discounts, incentives, or special offers to encourage purchase behavior and drive revenue growth.
- Customer Loyalty Programs: The service facilitates the implementation of customer loyalty programs, rewarding repeat purchases and incentivizing customer retention through exclusive promotions and rewards.
- Seasonal and Holiday Promotions: Promotion Management Service allows organizations to launch seasonal or holiday-themed promotions to capitalize on seasonal trends and increase customer engagement during peak periods.
- Cross-Selling and Upselling: It enables cross-selling and upselling opportunities by offering promotions on complementary products or upgrades, encouraging customers to explore additional offerings and increase their purchase value.
Base URL
Production:
https://your-url.com/catalog-management/v4
https://your-url.com/promotion-management/v4
https://your-url.com/pricepoint-management/v4
Pricepoint Management
Overview
The Pricepoint Management Service is a strategic tool used in retail and e-commerce to dynamically set prices for products by overriding them. This service ensures that the prices are optimal, balancing customer demand and business costs.
What is a Pricepoint?
A price point is the specific price at which a product can be sold by overriding the default prices defined without negatively impacting customer demand while ensuring that the costs of the business are covered. Effective pricepoint management can help a business maximize profits and maintain a competitive edge.
Purpose of Pricepoint Management Service
The Pricepoint Management Service allows businesses to:
- Adjust product prices dynamically.
- Overwrite default prices set in the product catalog based on various combinations and conditions.
- Maintain an optimal balance between competitiveness and profitability.
Key Features
- Dynamic Pricing Adjustments
- Real-time Updates: Prices can be adjusted in near real-time based on market trends, competitor pricing, and demand.
- Overwriting Catalog Prices
- Specific Combinations: The service can target specific combinations of products, categories, customer segment or sales channel to apply unique pricing strategies.
- Scenario-based Pricing: Adjust prices for different scenarios such as sales events, market entry, or clearance sales.
Base URL
Production:
https://your-url.com/catalog-management/v4
https://your-url.com/promotion-management/v4
https://your-url.com/pricepoint-management/v4
GraphQL Queries
Overview:
The GraphQL Queries section in the Catalog Services area allows users to retrieve specific data and information from the catalog using flexible query structures.
Benefits
- Efficiency: Users can efficiently request only the necessary data they need.
- Optimization: Optimizes the retrieval process, enhancing overall performance.
- Customization: Easily access catalog information tailored to specific requirements.
What made this section unhelpful for you?
Base URL
Production:
https://your-url.com/catalog-management/v4
https://your-url.com/promotion-management/v4
https://your-url.com/pricepoint-management/v4
What made this section unhelpful for you?
getCategoryByID
The getCategoryByID section allows users to retrieve detailed information about a specific category within the Category Management Service. By providing the unique identifier of the category, users can access essential details such as the category code, name, description, and other relevant attributes. This functionality enables users to efficiently access and manipulate specific category data for effective catalog management.
Body Parameters
The unique identifier of the category for which information is to be retrieved. This parameter is required for the getCategoryByID query.
What made this section unhelpful for you?
What made this section unhelpful for you?
getAllCategory
The getAllCategory section allows users to retrieve a comprehensive list of all categories. By accessing information such as category ID, name, description, and other metadata, users can efficiently manage and organize their catalog. This section provides a clear overview of available categories for effective catalog organization.
Body Parameters
Represents the input data required for the query request to retrieve categories.
Show child attributes
What made this section unhelpful for you?
What made this section unhelpful for you?
getRootCategories
The "getRootCategories" query allows users to retrieve the all root categories of a catalog. By querying this section, users can access essential information such as category IDs, names, descriptions, and visibility settings. This functionality enables users to efficiently manage and organize their catalog structure.
Body Parameters
The type parameter is used to filter the root categories based on a specific type, such as product type, category type, etc.
The input parameter is used to specify the PageDataInput object containing information such as page size, page number, and any other relevant data required for the query.
Show child attributes
What made this section unhelpful for you?
What made this section unhelpful for you?
getNavCategories
The getNavCategories section allows users to retrieve navigation categories based on a specified type. By querying this section, users can access information such as the category's ID, name, type, description, and visibility. This functionality enables users to manage and display navigation categories within their catalog management service.
Body Parameters
The type parameter specifies the type of navigation categories to retrieve. This can be used to filter the results based on a specific category type.
What made this section unhelpful for you?
What made this section unhelpful for you?
getProductOfferByID
The getProductOfferByID section allows users to retrieve detailed information about a specific product offer by its unique identifier. With this API, users can access key details such as the product's code, description, pricing options, and classification etc.
Body Parameters
The unique identifier of the product offer to retrieve.
What made this section unhelpful for you?
What made this section unhelpful for you?
getProductOfferByIDs
The getProductOfferByIDs section allows users to retrieve detailed information about product offers based on their unique identifiers. By providing a list of IDs, users can access various attributes such as code, description, price options, and offer classification for the specified product offers.
Body Parameters
An array of strings containing the unique identifiers of the product offers to retrieve.
Show child attributes
What made this section unhelpful for you?
What made this section unhelpful for you?
getOffersByBundle
The getOffersByBundle section allows users to retrieve a list of offers based on a specified bundle parameter. Users can access detailed information such as offer codes, descriptions, pricing options, and lifecycle statuses for better catalog management and product offering decisions.
Body Parameters
The isBundle parameter is a boolean value that determines whether the offers returned are part of a bundle or not.
The input parameter is used to specify the PageDataInput containing the details needed to fetch offers by bundle.
Show child attributes
What made this section unhelpful for you?
What made this section unhelpful for you?
getAllProductOffer
The getAllProductOffer section allows users to retrieve a list of product offers with detailed information such as codes, descriptions, pricing, and status. By querying this API, users can access a comprehensive view of available product offers within the catalog management service, enabling streamlined product selection and management processes.
Body Parameters
Defines the criteria used to filter the product offers.
Show child attributes
Contains additional input data for the query operation.
Show child attributes
What made this section unhelpful for you?
What made this section unhelpful for you?
getProductOffersByGroupId
The getProductOffersByGroupId section allows users to retrieve detailed information about product offers associated with a specific group ID. By querying this section, users can access essential data such as offer codes, descriptions, pricing details, and lifecycle statuses for offers within a particular group. This functionality enables efficient catalog management and decision-making processes based on offer attributes and classifications.
Body Parameters
The unique identifier of the group for which to retrieve product offers.
Additional criteria to filter the product offers by. This includes specific parameters for refining the search results.
Show child attributes
What made this section unhelpful for you?
What made this section unhelpful for you?
getProductOffersByCategoryAnchor
The getProductOffersByCategoryAnchor section allows users to retrieve detailed information about product offers associated with a specific category anchor. By querying this section, users can access attributes such as code, description, pricing options, and lifecycle status for each offer. This functionality enables efficient retrieval and management of product offers based on category anchors.
Body Parameters
The unique identifier of the category anchor for which to retrieve product offers.
What made this section unhelpful for you?
What made this section unhelpful for you?
getProductOfferingPriceByID
The getProductOfferingPriceByID section allows users to retrieve detailed information about a specific product offering price by its unique identifier. Users can access essential data such as pricing details, lifecycle status, and creation information for the identified product offering. This section facilitates efficient catalog management by providing comprehensive insights into individual product prices within the system.
Body Parameters
The unique identifier of the product offering price to retrieve.
What made this section unhelpful for you?
What made this section unhelpful for you?
getProductOfferingPriceByPlaceID
The getProductOfferingPriceByPlaceID section allows users to retrieve detailed information about a specific product offering price based on the unique place ID provided. By querying this section, users can access essential details such as pricing, description, status, and creation information for the specified product offering. This functionality enhances catalog management capabilities by enabling precise price retrieval for efficient decision-making and analysis.
Body Parameters
The unique identifier of the product offering price to retrieve.
What made this section unhelpful for you?
What made this section unhelpful for you?
getAllProductOfferingPrice
The getAllProductOfferingPrice section allows users to retrieve detailed information about product offering prices, including IDs, descriptions, prices, and other relevant attributes. By querying this section, users can access a comprehensive list of product offering prices to facilitate catalog management and pricing decisions within their applications.
Body Parameters
Contains the PageDataInput object with various fields such as id, code, externalID, href, description, offset, isBundle, isDefault, lastUpdate, lifecycleStatus, name, percentage, priceType, recurringChargePeriodLength, recurringChargePeriodType, version, schemaLocation, referredType, baseType, type, createdBy, createdOn, lastUpdatedBy, notes, internalLifecycleStatus, priceSubType, isDownPaymentRequired, and minimumDownPaymentAmount.
Show child attributes
What made this section unhelpful for you?
What made this section unhelpful for you?
getSpecCharacteristicsbyID
The "getSpecCharacteristicsbyID" section allows users to retrieve specific characteristics of a catalog item by providing its unique identifier. Users can access detailed information such as the name, type, description, and configuration settings associated with the specified characteristic. This section enables efficient catalog management by providing targeted data retrieval for improved customization and analysis.
Body Parameters
The unique identifier of the specific specification characteristics to retrieve.
What made this section unhelpful for you?
What made this section unhelpful for you?
getProductSpecificationByID
The getProductSpecificationByID section allows users to retrieve detailed information about a product specification by its unique ID. Users can access essential details such as the product's name, brand, description, version, and lifecycle status, providing valuable insight into the specific product's attributes. This section enables users to efficiently retrieve comprehensive product specifications for further analysis or integration within their systems.
Body Parameters
The unique identifier of the product specification to retrieve.
What made this section unhelpful for you?
What made this section unhelpful for you?
getProductSpecificationByCode
The "getProductSpecificationByCode" section allows users to retrieve detailed information about a product specification using its unique code. By querying this operation, users can access key details such as the product's name, brand, description, and version, enabling efficient catalog management and product identification within the system.
Body Parameters
The unique identifier code of the product specification to retrieve.
What made this section unhelpful for you?
What made this section unhelpful for you?
getProductSpecificationByStatus
The getProductSpecificationByStatus section allows users to retrieve detailed information about product specifications based on a specified lifecycle status. By querying this section, users can access essential data such as product name, description, brand, and version details. This functionality enables efficient catalog management and streamlined access to specific product specifications based on their lifecycle status.
Body Parameters
The status of the product specification lifecycle. Can be one of "draft", "active", "inactive", "pending", or "removed".
What made this section unhelpful for you?
What made this section unhelpful for you?
getResourceCandidateById
The getResourceCandidateById section allows users to retrieve detailed information about a specific resource candidate by providing the unique identifier. Users can access key details such as the resource's name, description, creation date, and external references, enabling them to effectively manage and track the lifecycle of the resource within the Catalog Management Service.
Body Parameters
The unique identifier of the resource candidate to retrieve.
What made this section unhelpful for you?
What made this section unhelpful for you?
getServiceCandidateById
The getServiceCandidateById
section allows users to retrieve detailed information about a specific service candidate by providing its unique identifier. By querying this section, users can access essential details such as the service's name, description, lifecycle status, and version reference. This functionality enables efficient catalog management and helps users make informed decisions based on the service's attributes.
Body Parameters
A unique identifier used to retrieve the service candidate by its ID.
What made this section unhelpful for you?
What made this section unhelpful for you?
getSpecificationById
The "getSpecificationById" section of the Catalog Management Service API allows users to retrieve detailed information about a specific specification by providing its unique identifier. By querying this section, users can access essential attributes such as code, description, version, and related system details for the specified specification. This functionality enables users to efficiently retrieve specific specification data for further analysis or utilization within their systems.
Body Parameters
A unique identifier for the specification that needs to be retrieved.
What made this section unhelpful for you?
What made this section unhelpful for you?
getPricePointById
The "getPricePointById" section allows users to retrieve detailed information about a specific price point within the catalog management service. By providing the unique ID of the price point, users can access attributes such as pricing details, priority, as well as any custom attributes associated with the price point. This section enables users to efficiently access and manage individual price points for accurate and effective catalog management.
Body Parameters
The unique identifier of the price point to retrieve.
What made this section unhelpful for you?
What made this section unhelpful for you?
getPricePointByTargetOfferId
The getPricePointByTargetOfferId section allows users to retrieve detailed information about a specific price point associated with a target offer ID. Users can access data such as price, customer segment, and description for the specified offer, enabling effective catalog management and pricing strategies within their application.
Body Parameters
The unique identifier for the target offer to retrieve the price point information.
What made this section unhelpful for you?
What made this section unhelpful for you?
getPricePointByFilterCriteria
The getPricePointByFilterCriteria section allows users to retrieve price points based on specific filter criteria such as source or target offer IDs, place IDs, and custom attributes. By querying this endpoint, users can access detailed information about price points, including their source offers, target offer IDs, price values, and associated customer segments. This section is essential for managing and analyzing pricing data
Body Parameters
The filter criteria to apply when retrieving price points.
Show child attributes
What made this section unhelpful for you?
What made this section unhelpful for you?
getRecommendationById
The getRecommendationById section allows users to fetch detailed information about a specific recommendation by providing its unique identifier. By calling this operation, users can retrieve data such as the recommendation's text, type, title, visibility location, and other relevant details. This section is useful for applications that require accessing specific recommendations based on their IDs.
Body Parameters
The unique identifier of the recommendation to retrieve.
What made this section unhelpful for you?
What made this section unhelpful for you?
getRecommendationByIds
The getRecommendationByIds section allows users to retrieve information about specific recommendations by their IDs. By providing a list of IDs, users can access details such as text, type, title, version, and more for each recommendation. This section enables users to efficiently gather targeted information for catalog management and decision-making processes.
Body Parameters
An array of strings containing the unique IDs of the recommendations to retrieve.
Show child attributes
What made this section unhelpful for you?
What made this section unhelpful for you?
getPromotionById
The "getPromotionById" section allows users to retrieve detailed information about a specific promotion by providing its unique identifier. By querying this section, users can access key details such as the promotion's code, description, coupon related information, promotion action and classification, enabling them to efficiently manage and analyze promotional campaigns within their catalog.
Body Parameters
The unique identifier of the promotion to retrieve from the catalog management service.
What made this section unhelpful for you?
What made this section unhelpful for you?
getPromotionByIds
The "getPromotionByIds" section allows users to retrieve detailed information about multiple promotions by their unique IDs. With this functionality, users can efficiently access key details such as By querying this section, users can access key details such as the promotion's code, description, coupon related information, promotion action and classification and more for specified promotions in the catalog. This section facilitates streamlined catalog management by providing a centralized method to fetch specific promotion data based on user-provided IDs.
Body Parameters
An array of unique identifiers for promotions to retrieve.--------
Show child attributes
What made this section unhelpful for you?
What made this section unhelpful for you?
getOffersByCategoryWithGrouping
The 'getOffersByCategoryWithGrouping' section allows users to retrieve offers grouped by category, providing essential information such as offer group IDs, group names, and total number of offers within each group. By utilizing this API, users can efficiently organize and display offers based on specified categories with optional sorting and filtering parameters.
Body Parameters
Identifies the category for which offers are being retrieved.
Contains input data for the request.
Show child attributes
Sorts the results alphabetically by name.
Sorts the results based on price.
Sorts the results based on the date of creation.
Sorts the results based on a specific feature.
Specifies the order in which the results are returned.
Filters the results based on specific specifications.
Show child attributes
Filters the results based on price range criteria.
Show child attributes
What made this section unhelpful for you?
What made this section unhelpful for you?
getProductOffersByExternalId
The getProductOffersByExternalId section allows users to retrieve detailed information about product offers based on their external ID. By querying this section, users can access key attributes such as code, description, price options, and classification of the offers. This enables efficient catalog management and decision-making related to product offerings.
Body Parameters
The unique identifier for the product offers to be retrieved based on this external ID.
What made this section unhelpful for you?
What made this section unhelpful for you?
getProductOffersByExternalIDs
The getProductOffersByExternalIDs section allows users to retrieve detailed information about product offers based on their external IDs. Users can access attributes such as code, name, description, and pricing details to effectively manage their catalog inventory. This section provides a comprehensive view of product offers to streamline catalog management processes.
Body Parameters
An array of external IDs used to retrieve product offers associated with them.