Openbravo Issue Tracking System - Retail Modules
View Issue Details
0057934Retail ModulesRetail APIpublic2025-02-10 17:112025-02-21 11:28
XABIER_AGUADO 
jorgewederago 
normalminoralways
acknowledgedopen 
5
 
 
No
0057934: Product Category API Improvements
Current Swagger information for the Product Category API is lacking in some fields. Their descriptions must be updated so the clients can easily work with the API.

The descriptions proposed need to be added to IMPORT/EXPORT entities
Check in livebuilds:

EXPORT: https://livebuilds.openbravo.com/context/retail_pos2_modules_pgsql/api#/ProductCategory/Export_ProductCategory [^]

IMPORT:
https://livebuilds.openbravo.com/context/retail_pos2_modules_pgsql/api#/ProductCategory/Import_ProductCategory [^]
Update the descriptions:

IMPORT:
  Name: Search Key
  Description: The search key of the product category is typically utilized to locate records across various systems

  Name: Name
  Description: Name of the Product Category

  Name: Description
  Description: Description of the Product Category

  Name: active
  Description: The field is employed to activate or deactivate a record. A record that is inactive is not accessible for use within the Point of Sale (POS) application

  Name: default
  Description: The default checkbox indicates whether this record will be employed as a default value

  Name: plannedMargin
  Description: The Planned Margin Percentage represents the projected margin percentage associated with a particular project or project line

  Name: mainProductCategory
  Description: The main category of a product category is the one that is considered relevant for a given product when exported as part of a transaction. It should always be a category in the natural tree of the specific product category, and it will be exported alongside the product's own category as part of the product information


EXPORT:
  Name: organization
  Description: The organization to which the Product Category belongs. An organization is a segment of your client or legal entity, such as a store or department

  Name: id
  Description: Openbravo's internal Universally Unique Identifier (UUID)
  
  Name: Search Key
  Description: The search key of the product category is typically utilized to locate records across various systems

  Name: Name
  Description: Name of the Product Category

  Name: Description
  Description: Description of the Product Category

  Name: active
  Description: The field is employed to activate or deactivate a record. A record that is inactive is not accessible for use within the Point of Sale (POS) application

  Name: default
  Description: The default checkbox indicates whether this record will be employed as a default value

  Name: plannedMargin
  Description: The Planned Margin Percentage represents the projected margin percentage associated with a particular project or project line

  Name: parentCategory
  Description: The search key of the parent product category
FASH
pdf Business API - masterdata - ProductCategory.pdf (40,677) 2025-02-10 17:11
https://issues.openbravo.com/file_download.php?file_id=20892&type=bug
Issue History
2025-02-10 17:11XABIER_AGUADONew Issue
2025-02-10 17:11XABIER_AGUADOAssigned To => Retail
2025-02-10 17:11XABIER_AGUADOFile Added: Business API - masterdata - ProductCategory.pdf
2025-02-10 17:11XABIER_AGUADOTriggers an Emergency Pack => No
2025-02-10 17:11XABIER_AGUADOTypedefect => design defect
2025-02-10 17:11XABIER_AGUADOTag Attached: FASH
2025-02-11 13:42XABIER_AGUADOProposed Solution updated
2025-02-13 06:09guillermogilAssigned ToRetail => jorgewederago
2025-02-18 06:14guillermogilStatusnew => acknowledged
2025-02-21 11:26kchoperenaDescription Updatedbug_revision_view_page.php?rev_id=29272#r29272
2025-02-21 11:26kchoperenaProposed Solution updated
2025-02-21 11:27kchoperenaDescription Updatedbug_revision_view_page.php?rev_id=29273#r29273
2025-02-21 11:27kchoperenaSteps to Reproduce Updatedbug_revision_view_page.php?rev_id=29275#r29275
2025-02-21 11:28kchoperenaProposed Solution updated
2025-02-21 11:28kchoperenaProposed Solution updated

There are no notes attached to this issue.