BFF API - SOM GUI API Specification

Endpoints

Product Catalogue Versions API

Overview

The Product Catalogue Versions API handles operations related to importing, managing, and deploying product catalogue versions. It enables users to upload CSV or binary files, retrieve information about imported and deployed catalogue versions, and deploy a specific version.

Import Product Catalogue Version (CSV)

POST /productCatalogueVersions/import/csv

• Description: Imports a product catalogue version using CSV files.
• Authentication: Required (Bearer Token)
• Request Body: Multipart form-data containing required fields:
  • comment: (string) Description of the import.
  • changeLog: (CSV) Change log file.
  • executionSteps: (CSV) Execution steps file.
  • executionStepsCompensation: (CSV) Compensation execution steps file.
  • products: (CSV) Products file.
  • productsRelationships: (CSV) Product relationships file.
• Responses:
  • 201 Created: Import successful.
  • 400 Bad Request: Error details.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Import Product Catalogue Version

POST /productCatalogueVersions/import

• Description: Imports a product catalogue version using a binary file.
• Authentication: Required (Bearer Token)
• Request Body: Multipart form-data containing:
  • comment: (string) Description of the import.
  • file: (binary) Product catalogue file.
• Responses:
  • 201 Created: Import successful.
  • 400 Bad Request: Error details.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Deploy Product Catalogue Version

POST /productCatalogueVersions/{id}/deploy

• Description: Deploys a specific product catalogue version.
• Authentication: Required (Bearer Token)
• Path Parameters:
  • id: (string) ID of the product catalogue version to be deployed.
• Responses:
  • 204 No Content: Deployment successful.
  • 400 Bad Request: Error details.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Get Product Catalogue XLS

POST /productCatalogueVersions/{id}/xls

• Description: Retrieves a specific product catalogue xls.
• Authentication: Required (Bearer Token)
• Path Parameters:
  • id: (string) ID of the product catalogue version.
• Responses:
  • 200 OK: Returns file.
  • 400 Bad Request: Error details.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Get Product Catalogue Versions

GET /productCatalogueVersions

• Description: Retrieves a paginated list of imported and deployed product catalogue versions.
• Authentication: Required (Bearer Token)
• Headers (Optional):
  • X-SortDirection: Sorting direction (asc or desc).
  • X-SortName: Sorting field (e.g., importDate, deployed).
  • X-PageIndex: Page index.
  • X-PageSize: Page size.
  • X-Total: Total records.
• Responses:
  • 200 OK: Returns a JSON array of product catalogue versions.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Get Deployed Product Catalogue Version

GET /productCatalogueVersions/deployed

• Description: Retrieves the currently deployed product catalogue version.
• Authentication: Required (Bearer Token)
• Responses:
  • 200 OK: Returns details of the deployed product catalogue version.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.