The Master Data API provides the Bulk-Load endpoint that allows you to import master data into the Vynamic FCx Retail Management Platform in bulk and asynchronous method. Additionally, it provides the Status-Enquiry endpoint that allows you to track the status of the bulk-load operation. All data in master data can be uploaded asynchronously.
NOTE: The following diagram depicts the asynchronous flow for all bulk-load endpoints except prices/bulk-load and /fuelPrices/bulk-load endpoints.
Client Application sends a request to the Master Data API through an API Gateway using a valid access token provided by the Identity Provider (IdP). The API Gateway validates the access token.
- If the access token is invalid, then the API Gateway sends an error message to the client application.
- If the access token is valid, then the API Gateway sends the API request for further processing.
Master Data API validates the size of the JSON payload received in the request.
- If the size of the JSON payload is incorrect, an error message is sent to the client application.
- If the size of the JSON payload is correct, the API request is sent for further processing.
Master Data API sends the API request to the Vynamic FCx Retail Management Service. A request ID is assigned to the list of shop items and queued for processing.
Vynamic FCx Retail Management Service sends the request ID to the Client Application. This request ID is used to check the status of the bulk-load operation.
Client Application sends a request to the Master Data API through an API Gateway using a valid access token and the request ID. The API Gateway validates the access token.
- If the access token is invalid, then the API Gateway sends an error message to the client application.
- If the access token is valid, then the API Gateway sends the API request for further processing.
Master Data API sends the API request to the Vynamic FCx Retail Management Service.
Vynamic FCx Retail Management Service returns the status of the bulk-load operation to the Client Application.