Openbravo Issue Tracking System - Retail Modules
View Issue Details
0056550Retail ModulesRetail APIpublic2024-09-25 15:352024-10-25 09:54
kchoperena 
Rajesh_18 
normalminoralways
closedfixed 
5
 
RR25Q1 
No
0056550: Missing description in the fields of the ExternalOrderLoader documentation in the swagger
The External Order Loader is an integration that a lot of clients are using or they will as it is quite common to have an integration with an E-commerce system

Have the API properly documented is key to avoid spend time explaining the same details to each client

We should at least include the Description: Explaining what's the purpose of the field and in case the field can receive different values, explaining each of them (i.e.: Product Import > productType)

Relevant fields to improve:
HEADER
- messageId
- posTerminal
- channel
- step
- completeTicket
- grossAmount
- netAmount
- businessPartner
- externalBusinessPartnerReference
- deliveryReceiptOption
- deliveryReceiptDestination

LINES
- grossAmount
- grossListPrice
- baseGrossUnitPrice
- netAmount
- taxAmount
- deliveryMode

  TAX
  - netAmount
  - taxAmount
  - grossAMount
  - amount
  - net
  PROMOTIONS
  - discountRule
  - amount
  - baseUnitPrice
  - discountType
  - displayedTotalAmount
  - obdiscQtyoffer
  - quantity
  - unitDiscount

PAYMENTS
- kind
- rate
- isocode

TAXES
- netAmount
- taxAmount
- grossAMount
- amount
- net

APPROVALS
- approvalType
- userContact
Open the Swagger documentation in livebuilds for the External Order Loader:

https://livebuilds.openbravo.com/context/retail_modules_pgsql_pi/api?urls.primaryName=orderloader [^]
No tags attached.
png Screenshot from 2024-09-24 12-40-17.png (164,407) 2024-09-25 15:35
https://issues.openbravo.com/file_download.php?file_id=20187&type=bug
png
Issue History
2024-09-25 15:35kchoperenaNew Issue
2024-09-25 15:35kchoperenaAssigned To => Triage Platform Conn
2024-09-25 15:35kchoperenaFile Added: Screenshot from 2024-09-24 12-40-17.png
2024-09-25 15:35kchoperenaTriggers an Emergency Pack => No
2024-09-30 15:58adrianromeroAssigned ToTriage Platform Conn => Retail
2024-10-02 19:08kchoperenaDescription Updatedbug_revision_view_page.php?rev_id=28532#r28532
2024-10-03 07:02guillermogilStatusnew => acknowledged
2024-10-05 07:06Rajesh_18Assigned ToRetail => Rajesh_18
2024-10-05 07:06Rajesh_18Statusacknowledged => scheduled
2024-10-09 13:27hgbotNote Added: 0170190
2024-10-25 09:54hgbotResolutionopen => fixed
2024-10-25 09:54hgbotStatusscheduled => closed
2024-10-25 09:54hgbotNote Added: 0170942
2024-10-25 09:54hgbotFixed in Version => RR25Q1
2024-10-25 09:54hgbotNote Added: 0170943

Notes
(0170190)
hgbot   
2024-10-09 13:27   
Merge Request created: https://gitlab.com/openbravo/product/pmods/org.openbravo.retail.posterminal/-/merge_requests/1705 [^]
(0170942)
hgbot   
2024-10-25 09:54   
Merge request merged: https://gitlab.com/openbravo/product/pmods/org.openbravo.retail.posterminal/-/merge_requests/1705 [^]
(0170943)
hgbot   
2024-10-25 09:54   
Directly closing issue as related merge request is already approved.

Repository: https://gitlab.com/openbravo/product/pmods/org.openbravo.retail.posterminal [^]
Changeset: 1f493149f8ae7d3f050cde8f74500f1ffaac0a8c
Author: Rajesh Senthilkumar <rajesh@qualiantech.com>
Date: 25-10-2024 07:54:06
URL: https://gitlab.com/openbravo/product/pmods/org.openbravo.retail.posterminal/-/commit/1f493149f8ae7d3f050cde8f74500f1ffaac0a8c [^]

Fixed ISSUE-56550: Added description to properties present in external orderloader

---
M api/org.openbravo.retail.posterminal-orderloader.yml
---