Core 1.2 release

api/registry/README.md

@@ -41,7 +41,7 @@ openapi: 3.0.0
 info:
   title: Beckn Protocol Core
   description: Beckn Core API specification
-  version: "1.0.0"
+  version: "1.2.0"
 
 security:
   - SubscriberAuth: []

api/transaction/build/transaction.yaml

@@ -738,10 +738,6 @@ components:
           $ref: '#/components/schemas/Descriptor'
         price:
           $ref: '#/components/schemas/Price'
-        quantity:
-          description: The Selling quantity of the Item
-          allOf:
-            - $ref: '#/components/schemas/ItemQuantity'
     Address:
       description: Describes a postal address.
       type: string
@@ -824,6 +820,7 @@ components:
           format: date-time
         cancelled_by:
           type: string
+          description: 'Represents the entity which initiated a cancellation'
           enum:
             - CONSUMER
             - PROVIDER
@@ -886,6 +883,7 @@ components:
           type: string
           format: date-time
         ttl:
+          description: Represents the time for which the catalog will be valid.
           $ref: '#/components/schemas/Duration'
     Category:
       description: A label under which a collection of items can be grouped.
@@ -929,8 +927,10 @@ components:
       type: object
       properties:
         phone:
+          description: Phone number of an entity.
           type: string
         email:
+          description: Email address of an entity.
           type: string
         jcard:
           type: object
@@ -1004,9 +1004,11 @@ components:
       type: object
       properties:
         id:
+          description: A unique identifier for the credential
           type: string
         type:
           type: string
+          description: 'Type of the credential, i.e. token, SAML, ssh keys etc.'
           default: VerifiableCredential
         url:
           description: URL of the credential
@@ -1069,8 +1071,6 @@ components:
         url:
           type: string
           format: uri
-        label:
-          type: string
         mime_type:
           description: 'Describes the contents of the uri field. If the value is text/html, it is recommended for the BAP to render the contents inside a webview. This generally does not render a good user experience on the BAP, hence the payment page developers are recommended to develop their payment pages in a mobile-friendly manner.'
           type: string
@@ -1122,7 +1122,7 @@ components:
       type: object
       properties:
         url:
-          description: 'The URL from where the form can be fetched. The content fetched from the url must be processed as per the mime_type specified in this object. Once fetched, the rendering platform can choosed to render the form as-is as an embeddable element; or process it further to blend with the theme of the application. In case the interface is non-visual, the the render can process the form data and reproduce it as per the standard specified in the form.'
+          description: 'The URL from where the form can be fetched. The content fetched from the url must be processed as per the mime type specified in this object. Once fetched, the rendering platform can choosed to render the form as-is as an embeddable element; or process it further to blend with the theme of the application. In case the interface is non-visual, the the render can process the form data and reproduce it as per the standard specified in the form.'
           type: string
           format: uri
         data:
@@ -1139,8 +1139,10 @@ components:
             - application/html
         resubmit:
           type: boolean
+          description: 'Set to true if the resubmission of a form is required. It could be due to a validation error, or session timeout etc. Otherwise, it is set to false.'
         submission_id:
           type: string
+          description: A unique identifier associated with a submission of a form.
           format: uuid
         auth:
           type: object
@@ -1149,6 +1151,7 @@ components:
               $ref: '#/components/schemas/Descriptor'
             value:
               type: string
+              description: 'The token that will be used for the authentication. It could be JWT (JSON Web Token), OAuth etc.'
     Fulfillment:
       description: Describes how a an order will be rendered/fulfilled to the end-customer
       type: object
@@ -1171,7 +1174,7 @@ components:
           allOf:
             - $ref: '#/components/schemas/FulfillmentState'
         documents:
-          description: The Documents associated to the fullfilment
+          description: 'The Documents associated with the fullfilment object. For example in the case of online courses, it could represent a certificate of completion of a course.'
           type: array
           items:
             $ref: '#/components/schemas/Document'
@@ -1524,7 +1527,7 @@ components:
       description: This object contains a url to a media file.
       type: object
       properties:
-        mimetype:
+        mime_type:
           description: 'indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF''s RFC 6838'
           type: string
         url:
@@ -1818,20 +1821,31 @@ components:
       properties:
         currency:
           type: string
+          description: 'Medium of exchange i.e. INR, USD etc.'
         value:
           type: string
+          description: 'Monetary cost of an item, a decimal represented as string'
         estimated_value:
           type: string
+          description: 'Monetary cost of an item, a decimal represented as string'
         computed_value:
           type: string
+          description: 'Monetary cost of an item, a decimal represented as string'
         listed_value:
           type: string
+          description: 'Monetary cost of an item, a decimal represented as string'
         offered_value:
           type: string
+          description: 'Monetary cost of an item, a decimal represented as string'
         minimum_value:
           type: string
+          description: 'Monetary cost of an item, a decimal represented as string'
         maximum_value:
           type: string
+          description: 'Monetary cost of an item, a decimal represented as string'
+        unit:
+          type: string
+          description: 'A custom unit of payment, i.e. carbon credit, bitcoin, etc.'
     Provider:
       description: Describes the catalog of a business.
       type: object

docs/BECKN-000-Terminology.md

@@ -0,0 +1,98 @@
+# BECKN-000: Terminology
+
+## License:
+This document is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).
+
+![Creative Commons License](https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png)
+
+## Category:
+Terminology
+
+## Published on:
+Sept 9th, 2025
+
+## Last Updated on:
+Sept 16th, 2025
+
+## History: 
+Click on this [link](https://github.com/beckn/protocol-specifications/commits/core-1.2-release/docs/BECKN-000-Terminology.md) to view the history of changes to this document
+
+## Issues:
+To view issues related to this document, click on this [link](https://github.com/beckn/protocol-specifications/issues?q=is%3Aissue+label%3ABECKN-000)
+
+## Discussions:
+To view discussions related to this document, click on this [link](https://github.com/beckn/protocol-specifications/discussions?discussions_q=label%3ABECKN-000)
+
+## Authors:
+1. [Ravi Prakash](https://github.com/ravi-prakash-v)
+
+## Reviewers:
+1. [Sujith Nair](https://github.com/sjthnrk)
+2. [Pramod Varma](https://github.com/pramodkvarma)
+3. [Venkatraman Mahadevan](https://github.com/venkatramanm)
+
+# Abstract
+
+This document provides a comprehensive glossary of terms and definitions used across the Beckn Protocol specifications. It serves as a reference for network participants, implementers, and stakeholders to ensure consistent understanding of key concepts and terminology.
+
+# Scope
+
+This document defines the standard terminology used across all Beckn Protocol specifications and related documents. It is intended for:
+
+1. Network participants implementing Beckn Protocol
+2. Developers building on Beckn-enabled networks
+3. Policy makers and governance bodies
+4. Technical writers and documentation maintainers
+
+## Prerequisites
+
+Readers of this document should have:
+
+1. Basic understanding of distributed systems and API protocols
+2. Familiarity with commerce and transaction terminology
+3. Knowledge of the Beckn Protocol architecture
+
+# Introduction
+
+The Beckn Protocol ecosystem involves multiple stakeholders, technical concepts, and domain-specific terminology. This document establishes a common vocabulary to ensure clear communication and consistent implementation across all Beckn-enabled networks.
+
+# Terminology
+
+1. **Network :** In the context of beckn protocol, a network refers to an open commerce network formed by the instantiation of beckn protocol specification with a standard network policy
+2. **Network Participant:** Any platform that has implemented beckn protocol specification and is part of an open commerce network
+3. **Schema:** These are JSON Schema objects with properties as defined in the core specification
+4. **Action:** These are specific events that occur during the lifecycle of a typical commerce transaction
+5. **Network Policy**: These are specific rules that apply to the implementers of a network while developing the protocol API middleware
+6. **BAP (Beckn Application Platform)**: A platform that enables buyers to discover and transact with sellers on a Beckn-enabled network
+7. **BPP (Beckn Provider Platform)**: A platform that enables sellers to list their services and fulfill orders on a Beckn-enabled network
+8. **BG (Beckn Gateway)**: A network infrastructure component used for provider discovery; it routes discovery requests from BAPs to relevant BPPs and enforces basic routing and validation policies
+9. **Registry**: A centralized directory service that maintains information about network participants, their capabilities, and network policies
+
+# Examples
+
+## Common Usage Examples
+
+- **Network**: "The mobility network in Bangalore uses Beckn Protocol with specific policies for ride-sharing and public transport"
+- **Network Participant**: "Uber and Ola are both network participants in the mobility network"
+- **Schema**: "The Order schema defines the structure for transaction data"
+- **Action**: "The search action initiates the discovery of available services"
+- **Network Policy**: "The network policy requires all transactions to include location data"
+- **BAP**: "The Swiggy app acts as a BAP, allowing users to discover and order food from restaurants"
+- **BPP**: "Restaurant partners use a BPP platform to list their menus and manage orders"
+- **BG**: "The beckn gateway is used for provider discovery and routes search requests from BAPs to relevant BPPs in the food delivery network"
+- **Registry**: "The registry maintains a directory of all food delivery BPPs and their service capabilities"
+
+# Recommendations
+
+- Use terminology consistently across all documentation and implementations
+- Refer to this document when introducing new terms or concepts
+- Update this document when new terminology is introduced in the protocol
+- Cross-reference related terms to maintain clarity
+
+# Acknowledgements
+
+The authors would like to thank the following people for their support and contributions to this document.
+
+* Pramod Varma (Beckn Foundation)
+* Sujith Nair (Beckn Foundation)
+* Venkataramanan Mahadevan (Humbhionline)