Master Data API
Overview
Master Data API enables retail business consumers to store and maintain master data in a cloud-based integration system for downstream system consumption. Includes item groups, shop items, assortments, departments, and more.
Features
The Master Data API provides the following operations to manage master data of various components in the Vynamic Retail Management Platform:
- Bulk-load master data
- Create master data.
- Update master data.
- Check the status of the bulk-load operation.
- Deactivate master data.
- Retrieve master data details.
- Allows uploading a batch of locations in JSON format.
- Business Contract Templates
- Retrieve list of business contract templates.
- Create new template based on existing business contract.
- Update template based on existing business contract.
- Delete template by its identifier.
- Business Contracts
- Create business contracts.
- Update business contracts.
- Retrieve list of business contracts.
- Retrieve business object default rules.
- Retrieve a minimal available number for a new business contract.
- Retrieve datasources for busniess contract card.
- Retrieve business contexts by the allowed access level of the business object.
- Retrieve available advanced filters definations for busniess object.
- POS Configuration
- Create , update the POS from DTO.
- Retrieve a list of all the POS configuration by management node identifier.
- Period Workflows
- Create a new period workflow.
- Retrieve period workflow identifier by period process type identifier.
- Filter workflow with the specified criteria.
- Number Ranges
- Retrieve number ranges for the management node.
- Update number ranges for the management node.
- Barcode Templates
- Retrieve a list of the barcode templates.
- Create or Update the barcode templates.
- Localization
- Enable the API client to import, update and export translations for the selected file in the Retail Management.
- Entity Configuration
- Retrieve the configuration tree for a specified entity by path.
- Update the configuration parameters for the organizational node or user by path.
- Package Units
- Create a new one or update the existing package units.
- Get the list of all available package units.
- Brands
- Create a new one or update the existing brands.
- Get the list of all available brands for the grid.
- Images
- Retrieve an image by its path and entity number.
- Operational Units
- Retrieve the list of all available operational units.
- Price Change Document
- Retrieve the price change document details by document identifier.
- Documents
- Search for documents by document code.
- Application Theme
- Retrieve the application theme based on module and theme identifiers.
- Item Tare
- Create a new one or update the existing item tare.
- Retrieve the list of item tare.
- Counterparties
- Check if number validation is required and if the number is unique.
- Notify ESL Update
- Notifies Electronic Shelf Label (ESL) systems about item changes based on provided filters. Allows filtering by specific item IDs, categories, groups, departments, and locations with an effective date and restriction time.
- Go Live
- Retrieve the current station mode.
- Stations
- Retrieves the data sources for the station card.
- Starts the initial publication process of the SQL database for a given station in Vynamic VRx.
- Configuration
- retrieves the configuration tree for a specified orgNodeId by path.
- Health Check
- Check the status of the dependent backend services. On the 200 response, the client receives the overall status information: healthy, degraded, unhealthy.
Bulk Import of Master Data
- Maximum payload size for bulk import endpoints is configurable with the BULKLOAD_MAX_CONTENT_LENGTH configuration parameter. Using this variable, you can define a maximum bulk load content length and modify the limit from the configuration level.
- If the size of the request payload exceeds the configured limit, then the API returns a bad request error: "Size of request paylod exceeded maximum allowed size".
- If the parameter is not provided, the default limit is 10 MB.
- Additional information about the recommended maximum records per payload is provided in the description of specific endpoints, for example: POST /prices/bulk-load.
Note:
If the request body JSON structure is invalid or includes incorrect data types, then validation of the request fails and none of the data sent in payload is processed. The backend system performs all the field validations.
More information about the bulk-load feature:
- Asynchronous Bulk-Load
- Synchronous Bulk-Load
- Master Data Bulk-Load Sequence - this section depicts the sequence of endpoints to be called to import Master Data.
Security
The Master Data API supports OAuth 2.0 for authentication purposes.
The supported protocol for the Master Data API is HTTPS.